home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / unix / riscbsd / 1_1_contri / usd / 08_mh / ap_me < prev    next >
Encoding:
Text File  |  1986-04-15  |  2.1 KB  |  76 lines
  1. .\"    This file is automatically generated.  Do not edit!
  2. .SC AP 8
  3. .NA
  4. ap \- parse addresses 822\-style
  5. .SY
  6. /usr/new/lib/mh/ap
  7. \%[\-form\ formatfile]
  8. \%[\-format\ string]
  9. \%[\-normalize] \%[\-nonormalize]
  10. \%[\-width\ columns]
  11. addrs\ ...
  12. \%[\-help] 
  13. .DE
  14. \fIAp\fR is a program that parses addresses according to the ARPA Internet
  15. standard.
  16. It also understands many non\-standard formats.
  17. It is useful for seeing how \fIMH\fR will interpret an address.
  18.  
  19. The \fIap\fR program treats each argument as one or more addresses,
  20. and prints those addresses out in the official 822\-format.
  21. Hence, it is usually best to enclose each argument in double\-quotes for the
  22. shell.
  23.  
  24. To override the output format used by \fIap\fR,
  25. the `\-format\ string' or `\-format\ file' switches are used.
  26. This permits individual fields of the address to be extracted with ease.
  27. The string is simply a format stringand thefile is simply a format file.
  28. See \fImh\-format\fR\0(5) for the details.
  29.  
  30. In addition to the standard escapes,
  31. \fIscan\fR also recognizes the following additional escape:
  32. .nf
  33. .ta \w'escape  'u
  34. \fIescape\fR    \fIsubstitution\fR
  35. error    a diagnostic if the parse failed
  36. .re
  37. .fi
  38.  
  39. If the `\-normalize' switch is given,
  40. \fIap\fR will try to track down the official hostname of the address.
  41.  
  42. Here is the default format string used by \fIap\fR:
  43.  
  44. .ti +.5i
  45. %<{error}%{error}: %{text}%|%(putstr(proper{text}))%>
  46.  
  47. which says that if an error was detected, print the error, a `:',
  48. and the address in error.
  49. Otherwise, output the 822\-proper format of the address.
  50. .Fi
  51. ^$HOME/\&.mh\(ruprofile~^The user profile
  52. ^/usr/new/lib/mh/mtstailor~^tailor file
  53. .Pr
  54. None
  55. .Sa
  56. dp(8),
  57. .br
  58. \fIStandard for the Format of ARPA Internet Text Messages\fR (aka RFC\-822)
  59. .De
  60. `\-format' defaults as described above
  61. .Ds
  62. `\-normalize'
  63. .Ds
  64. `\-width' defaults to the width of the terminal
  65. .Co
  66. None
  67. .Bu
  68. The argument to the `\-format' switch must be interpreted as a single token
  69. by the shell that invokes \fIap\fR.
  70. Therefore,
  71. one must usually place the argument to this switch inside double\-quotes.
  72.  
  73. On hosts where \fIMH\fR was configured with the BERK option,
  74. address parsing is not enabled.
  75. .En
  76.