]> diplodocus.org Git - nmh/blob - man/whom.man
new.c: Order two return statements to match comment.
[nmh] / man / whom.man
1 .TH WHOM %manext1% 2016-09-23 "%nmhversion%"
2 .
3 .\" %nmhwarning%
4 .
5 .SH NAME
6 whom \- show to whom an nmh message would be sent
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B whom
11 .RB [ \-help ]
12 .RB [ \-version ]
13 .RB [ \-alias
14 .IR aliasfile ]
15 .RB [ \-check " | " \-nocheck ]
16 .RB [ \-draftfolder
17 .IR +folder ]
18 .RB [ \-draftmessage
19 .IR msg ]
20 .RB [ \-nodraftfolder ]
21 .RB [ \-mts
22 .IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
23 .RB [ \-server
24 .IR servername ]
25 .RB [ \-port
26 .IR port-name/number ]
27 .RB [ \-sasl ]
28 .RB [ \-saslmech
29 .IR mechanism ]
30 .RB [ \-snoop ]
31 .RB [ \-user
32 .IR username ]
33 .RB [ \-tls ]
34 .RB [ \-initialtls ]
35 .RB [ \-notls ]
36 .RI [ file ]
37 .RB [ \-draft ]
38 .ad
39 .SH DESCRIPTION
40 .B whom
41 is used to expand the headers of a message into a set of
42 addresses and optionally verify that those addresses are deliverable at
43 that time (if
44 .B \-check
45 is given).
46 .PP
47 The
48 .B \-draftfolder
49 .I +folder
50 and
51 .B \-draftmessage
52 .I msg
53 switches invoke
54 the
55 .B nmh
56 draft folder facility. This is an advanced (and highly
57 useful) feature. Consult
58 .IR mh-draft (5)
59 for more information.
60 .PP
61 The mail transport system default is provided in
62 .I %nmhetcdir%/mts.conf
63 but can be overridden here with the
64 .B \-mts
65 switch.
66 .PP
67 If nmh is using the SMTP MTA, the
68 .B \-server
69 and the
70 .B \-port
71 switches can be used to override the default mail server (defined by the
72 .I %nmhetcdir%/mts.conf
73 .I servers
74 entry). The
75 .B \-snoop
76 switch can be used to view the SMTP transaction. (Beware that the
77 SMTP transaction may contain authentication information either in
78 plaintext or easily decoded base64.)
79 .PP
80 If
81 .B nmh
82 has been compiled with SASL support, the
83 .B \-sasl
84 switch will enable
85 the use of SASL authentication with the SMTP MTA. Depending on the
86 SASL mechanism used, this may require an additional password prompt from the
87 user (but the
88 .I netrc
89 file can be used to store this password, as described in
90 .IR mh-profile (5)).
91 The
92 .B \-saslmech
93 switch can be used to select a particular SASL mechanism,
94 and the
95 .B \-user
96 switch can be used to select a authorization userid to provide to SASL
97 other than the default. The credentials profile entry in
98 .IR mh\-profile (5)
99 describes the ways to supply a username and
100 password.
101 .PP
102 If SASL authentication is successful,
103 nmh
104 will attempt to negotiate a security layer for session encryption.
105 Encrypted data is labelled with `(encrypted)' and `(decrypted)' when
106 viewing the SMTP transaction with the
107 .B \-snoop
108 switch; see
109 .IR post (8)'s
110 description of
111 .B \-snoop
112 for its other features.
113 .PP
114 If
115 .B nmh
116 has been compiled with TLS support, the
117 .BR \-tls ,
118 .BR \-initialtls ,
119 and
120 .B \-notls
121 switches will require and disable the negotiation of TLS support when connecting to the
122 SMTP MTA. Encrypted data is labelled with `(tls-encrypted)' and
123 `(tls-decrypted)' when viewing the SMTP transaction with the
124 .B \-snoop
125 switch; see
126 .IR post (8)'s
127 description of
128 .B \-snoop
129 and the TLS flags for more details.
130 .PP
131 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
132 additional alias files given by the
133 .B \-alias
134 .I aliasfile
135 switch will be
136 read (more than one file, each preceded by
137 .BR \-alias ,
138 can be named). See
139 .IR mh\-alias (5)
140 for more information.
141 .SH FILES
142 .fc ^ ~
143 .nf
144 .ta \w'%nmhetcdir%/ExtraBigFileName 'u
145 ^$HOME/.mh_profile~^The user profile
146 .fi
147 .SH "PROFILE COMPONENTS"
148 .fc ^ ~
149 .nf
150 .ta 2.4i
151 .ta \w'ExtraBigProfileName 'u
152 ^Path:~^To determine the user's nmh directory
153 ^Draft\-Folder:~^To find the default draft-folder
154 ^Aliasfile:~^For a default alias file
155 ^postproc:~^Program to post the message
156 .fi
157 .SH "SEE ALSO"
158 .IR mh\-alias (5),
159 .IR mh\-profile (5),
160 .IR post (8)
161 .SH DEFAULTS
162 .nf
163 .RB ` file "' defaults to <mh-dir>/draft"
164 .RB ` \-nocheck '
165 .RB ` \-alias "' defaults to %nmhetcdir%/MailAliases"
166 .fi
167 .SH CONTEXT
168 None
169 .SH BUGS
170 With the
171 .B \-check
172 option,
173 .B whom
174 makes no guarantees that the
175 addresses listed as being ok are really deliverable, rather, an address
176 being listed as ok means that at the time that
177 .B whom
178 was run
179 the address was thought to be deliverable by the transport service.
180 For local addresses, this is absolute; for network addresses, it means
181 that the host is known; for uucp addresses, it (often) means that the
182 .B UUCP
183 network is available for use.