sortm: Removed the hidden -subject switch, which provided compat only.
[mmh] / man / comp.man1
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 comp \- compose a message
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B comp
11 .RI [ +folder ]
12 .RI [ msgs ]
13 .RB [ \-form
14 .IR formfile ]
15 .RB [ \-use " | " \-nouse ]
16 .RB [ \-editor
17 .IR editor ]
18 .RB [ \-whatnowproc
19 .IR program ]
20 .RB [ \-Version ]
21 .RB [ \-help ]
22 .ad
23 .SH DESCRIPTION
24 .B Comp
25 is used to create a new message to be mailed.  It copies a
26 message form to the draft being composed and then invokes an editor on
27 the draft (unless the
28 .B \-editor
29 switch with an empty string argument is given,
30 in which case the initial edit is suppressed).
31 .PP
32 The default message form contains the following elements:
33 .PP
34 .RS 5
35 .nf
36 %components%
37 .fi
38 .RE
39 .PP
40 If a file named
41 .RI ` components '
42 exists in the user's mmh directory,
43 it will be used instead of this form.  You may specify an alternate
44 forms file with the switch
45 .B \-form
46 .IR formfile .
47 .PP
48 You may also start
49 .B comp
50 using the contents of an existing message
51 as the form.  If you supply a
52 .I +folder
53 or
54 .I msg
55 argument, that
56 message will be used as the message form.  You may not supply both a
57 .B \-form
58 .I formfile
59 and a
60 .I +folder
61 or
62 .I msg
63 argument.  The line of
64 dashes or a blank line must be left between the header and the body of
65 the message for the message to be identified properly when it is sent
66 (see
67 .BR send (1)).
68 .PP
69 The switch
70 .B \-use
71 directs
72 .B comp
73 to continue editing an already
74 started message.  That is, if a
75 .B comp
76 (or
77 .BR dist ,
78 .BR repl ,
79 or
80 .BR forw )
81 is terminated without sending the draft, the draft can
82 be edited again via
83 .RB ` comp
84 .BR \-use '.
85 If
86 .B \-use
87 is given,
88 .I msg
89 is located within the draft folder.
90 A
91 .I +folder
92 argument is not allowed together with
93 .BR \-use .
94 .PP
95 If the draft already exists,
96 .B comp
97 will ask you as to the disposition
98 of the draft.  A reply of
99 .B quit
100 will abort
101 .BR comp ,
102 leaving the draft intact;
103 .B replace
104 will replace the existing draft with
105 the appropriate form;
106 .B list
107 will display the draft;
108 .B use
109 will use the draft for further composition; and
110 .B refile
111 .I +folder
112 will file the draft in the given folder, and give you a new draft with the
113 appropriate form.  (The
114 .I +folder
115 argument to
116 .B refile
117 is required.)
118 .PP
119 Consult the
120 .BR mh-draft (7)
121 man page for more information.
122 .PP
123 The
124 .B \-editor
125 .I editor
126 switch indicates the editor to use for the
127 initial edit.  Upon exiting from the editor,
128 .B comp
129 will invoke the
130 .B whatnow
131 program.  See
132 .BR whatnow (1)
133 for a discussion of
134 available options.
135
136 .SH FILES
137 .fc ^ ~
138 .nf
139 .ta \w'%etcdir%/ExtraBigFileName  'u
140 ^%etcdir%/components~^The standard message skeleton
141 ^or $HOME/.mmh/components~^Rather than the standard skeleton
142 ^$HOME/.mmh/profile~^The user profile
143 ^+drafts~^The draft folder
144 .fi
145
146 .SH "PROFILE COMPONENTS"
147 .fc ^ ~
148 .nf
149 .ta 2.4i
150 .ta \w'ExtraBigProfileName  'u
151 ^Path:~^To determine the user's mail storage
152 ^Draft\-Folder:~^To set the default draft folder
153 ^Editor:~^To override the default editor
154 ^Msg\-Protect:~^To set mode when creating a new message (draft)
155 ^whatnowproc:~^Program to ask the `What now?' questions
156 .fi
157
158 .SH "SEE ALSO"
159 dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)
160
161 .SH DEFAULTS
162 .nf
163 .RB ` +folder "' defaults to the current folder"
164 .RB ` msg "' defaults to the current message"
165 .RB ` \-nouse '
166 .fi
167
168 .SH CONTEXT
169 None