Commit 1dc8eb3f 1dc8eb3f3c94efc544af7acae01c6634a7320338 by Sergey Poznyakoff

Update the docs

1 parent a5ca0e0f
...@@ -173,6 +173,17 @@ check-fixmes: ...@@ -173,6 +173,17 @@ check-fixmes:
173 rm -f $@-t; \ 173 rm -f $@-t; \
174 fi 174 fi
175 175
176 check-writeme:
177 @grep -Hn @WRITEME $(info_TEXINFOS) $(mailutils_TEXINFOS) > $@-t; \
178 if [ -s $@-t ]; then \
179 echo "Empty nodes:"; \
180 cat $@-t; \
181 rm $@-t; \
182 false;\
183 else \
184 rm $@-t; \
185 fi
186
176 check-unrevised: 187 check-unrevised:
177 @grep -Hn @UNREVISED $(info_TEXINFOS) $(mailutils_TEXINFOS) > $@-t; \ 188 @grep -Hn @UNREVISED $(info_TEXINFOS) $(mailutils_TEXINFOS) > $@-t; \
178 if [ -s $@-t ]; then \ 189 if [ -s $@-t ]; then \
...@@ -184,7 +195,7 @@ check-unrevised: ...@@ -184,7 +195,7 @@ check-unrevised:
184 rm $@-t; \ 195 rm $@-t; \
185 fi 196 fi
186 197
187 all-check-docs: check-format check-refs check-fixmes check-unrevised 198 all-check-docs: check-format check-writeme check-unrevised check-refs check-fixmes
188 199
189 check-docs: 200 check-docs:
190 $(MAKE) -k all-check-docs 201 $(MAKE) -k all-check-docs
......
...@@ -1931,7 +1931,7 @@ Password to access the database. ...@@ -1931,7 +1931,7 @@ Password to access the database.
1931 1931
1932 @node LDAP Statement 1932 @node LDAP Statement
1933 @subsection LDAP Statement 1933 @subsection LDAP Statement
1934 @UNREVISED 1934 @WRITEME
1935 @kwindex ldap 1935 @kwindex ldap
1936 @subheading Syntax 1936 @subheading Syntax
1937 @smallexample 1937 @smallexample
...@@ -1979,7 +1979,7 @@ tls @{ ...@@ -1979,7 +1979,7 @@ tls @{
1979 1979
1980 @node GSASL Statement 1980 @node GSASL Statement
1981 @subsection GSASL Statement 1981 @subsection GSASL Statement
1982 @UNREVISED 1982 @WRITEME
1983 @kwindex gsasl 1983 @kwindex gsasl
1984 @subheading Syntax 1984 @subheading Syntax
1985 @smallexample 1985 @smallexample
...@@ -1997,9 +1997,6 @@ gsasl @{ ...@@ -1997,9 +1997,6 @@ gsasl @{
1997 @} 1997 @}
1998 @end smallexample 1998 @end smallexample
1999 1999
2000
2001
2002
2003 @c ------------------------------------------------------------------- 2000 @c -------------------------------------------------------------------
2004 2001
2005 @node frm and from 2002 @node frm and from
...@@ -2008,21 +2005,33 @@ gsasl @{ ...@@ -2008,21 +2005,33 @@ gsasl @{
2008 GNU mailutils provides two commands for listing messages in a mailbox. 2005 GNU mailutils provides two commands for listing messages in a mailbox.
2009 These are @command{from} and @command{frm}. 2006 These are @command{from} and @command{frm}.
2010 2007
2008 The behavior of both programs is affected by the following
2009 configuration file statements:
2010
2011 @multitable @columnfractions 0.3 0.6
2012 @headitem Statement @tab Reference
2013 @item debug @tab @xref{Debug Statement}.
2014 @item tls @tab @xref{TLS Statement}.
2015 @item mailbox @xref{Mailbox Statement}.
2016 @item locking @xref{Locking Statement}.
2017 @end multitable
2018
2011 @subheading @command{frm} 2019 @subheading @command{frm}
2012 @pindex frm 2020 @pindex frm
2013 2021
2014 The @command{frm} command outputs a header information of 2022 The @command{frm} utility outputs a header information of
2015 the selected messages in a mailbox. By default, @command{frm} reads the 2023 the selected messages in a mailbox. By default, @command{frm} reads
2016 user's system mailbox and outputs the contents of @code{From} and 2024 user's system mailbox and outputs the contents of @code{From} and
2017 @code{Subject} headers for each message. If a folder is specified in 2025 @code{Subject} headers for each message. If a folder is specified in
2018 the command line, the program reads that folder rather than the default 2026 the command line, the program reads that folder rather than the default
2019 mailbox. 2027 mailbox.
2020 2028
2021 The program uses following option groups: @FIXME-xref{mailbox}.
2022
2023 The following command line options alter the behavior of the program: 2029 The following command line options alter the behavior of the program:
2024 2030
2025 @table @option 2031 @table @option
2032 @item -d
2033 @itemx --debug
2034 Enable debugging output.
2026 @item -f @var{string} 2035 @item -f @var{string}
2027 @itemx --field @var{string} 2036 @itemx --field @var{string}
2028 Display the header named by @var{string} instead of @code{From} 2037 Display the header named by @var{string} instead of @code{From}
...@@ -2064,12 +2073,12 @@ orientation (such as Arabic or Hebrew). ...@@ -2064,12 +2073,12 @@ orientation (such as Arabic or Hebrew).
2064 2073
2065 The @command{from} utility displays sender and subject of each message 2074 The @command{from} utility displays sender and subject of each message
2066 in a mailbox. By default, it reads the user's system mailbox. If the 2075 in a mailbox. By default, it reads the user's system mailbox. If the
2067 program is given a single argument, it is interpreted as a user 2076 program is given a single argument, it is interpreted as a name of the
2068 name whose mailbox is to be read. Obviously, permissions are required 2077 user whose mailbox is to be read. Obviously, permissions are required
2069 to access that user's mailbox, so such invocations may be used only 2078 to access that user's mailbox, so such invocations may be used only
2070 by superuser. 2079 by superuser.
2071 2080
2072 Option @option{-f} (@option{--file}) instructs the program to read 2081 The option @option{-f} (@option{--file}) instructs @command{from} to read
2073 the given mailbox. 2082 the given mailbox.
2074 2083
2075 The full list of options, supported by @command{from} follows: 2084 The full list of options, supported by @command{from} follows:
...@@ -2085,8 +2094,8 @@ Prints additional debugging output. ...@@ -2085,8 +2094,8 @@ Prints additional debugging output.
2085 2094
2086 @item -s @var{string} 2095 @item -s @var{string}
2087 @itemx --sender=@var{string} 2096 @itemx --sender=@var{string}
2088 Prints only mail from addresses containing the supplied string. 2097 Prints only mail whose @samp{From:} headers contain the supplied string.
2089 FIXME: only @code{From:} header is examined. 2098 @FIXME{Probably, this should test envelopes as well.}
2090 2099
2091 @item -f @var{url} 2100 @item -f @var{url}
2092 @itemx --file=@var{url} 2101 @itemx --file=@var{url}
...@@ -2113,6 +2122,11 @@ taken from the argument of @option{--file} command line option. If it ...@@ -2113,6 +2122,11 @@ taken from the argument of @option{--file} command line option. If it
2113 is not specified, the user's system mailbox is assumed. For more 2122 is not specified, the user's system mailbox is assumed. For more
2114 detail, see @ref{Reading Mail}. 2123 detail, see @ref{Reading Mail}.
2115 2124
2125 In contrast to other GNU Mailutils programs, @command{mail} does not
2126 use the Mailutils configuration file. Instead, it uses the traditional
2127 @samp{mailrc}-style configuration. @xref{Mail Configuration Files},
2128 for a detailed description of its format.
2129
2116 @menu 2130 @menu
2117 * Invoking Mail:: Command Line Options. 2131 * Invoking Mail:: Command Line Options.
2118 * Specifying Messages:: How to Specify Message Sets. 2132 * Specifying Messages:: How to Specify Message Sets.
...@@ -3868,7 +3882,16 @@ Number of messages in @var{folder}: @var{number} ...@@ -3868,7 +3882,16 @@ Number of messages in @var{folder}: @var{number}
3868 where @var{folder} represents the folder name, @var{number} represents 3882 where @var{folder} represents the folder name, @var{number} represents
3869 the number of messages. 3883 the number of messages.
3870 3884
3871 The program uses following option groups: @FIXME-xref{mailbox}. 3885 Following configuration file statements affect the behaviour of
3886 @command{messages}:
3887
3888 @multitable @columnfractions 0.3 0.6
3889 @headitem Statement @tab Reference
3890 @item debug @tab @xref{Debug Statement}.
3891 @item tls @tab @xref{TLS Statement}.
3892 @item mailbox @xref{Mailbox Statement}.
3893 @item locking @xref{Locking Statement}.
3894 @end multitable
3872 3895
3873 The program accepts following command line options: 3896 The program accepts following command line options:
3874 3897
...@@ -3916,10 +3939,43 @@ being developed at the time of this writing, will contain improved ...@@ -3916,10 +3939,43 @@ being developed at the time of this writing, will contain improved
3916 @code{Rmail} interface for work with mailutils @command{movemail}. 3939 @code{Rmail} interface for work with mailutils @command{movemail}.
3917 3940
3918 @menu 3941 @menu
3942 * Movemail Configuration::
3919 * Movemail Options:: Description of the Available Options 3943 * Movemail Options:: Description of the Available Options
3920 * Summary:: Short Movemail Invocation Summary 3944 * Summary:: Short Movemail Invocation Summary
3921 @end menu 3945 @end menu
3922 3946
3947 @node Movemail Configuration
3948 @subsection Movemail Configuration
3949
3950 Following configuration file statements affect the behavior of
3951 @command{movemail}:
3952
3953 @deffn {Movemail Config} preserve @var{bool}
3954 If @var{bool} is @samp{true}, do not remove messages from the source mailbox.
3955 @end deffn
3956
3957 @deffn {Movemail Config} reverse @var{bool}
3958 If @var{bool} is @samp{true}, reverse message sorting order.
3959 @end deffn
3960
3961 @deffn {Movemail Config} emacs @var{bool}
3962 If @var{bool} is @samp{true}, output information used by Emacs rmail interface.
3963 @end deffn
3964
3965 @multitable @columnfractions 0.3 0.6
3966 @headitem Statement @tab Reference
3967 @item debug @tab @xref{Debug Statement}.
3968 @item tls @tab @xref{TLS Statement}.
3969 @item mailbox @xref{Mailbox Statement}.
3970 @item locking @xref{Locking Statement}.
3971 @item pam @xref{PAM Statement}.
3972 @item sql @xref{SQL Statement}.
3973 @item virtdomain @xref{Virtdomain Statement}.
3974 @item radius @xref{Radius Statement}.
3975 @item ldap @xref{LDAP Statement}.
3976 @item auth @xref{Auth Statement}.
3977 @end multitable
3978
3923 @node Movemail Options 3979 @node Movemail Options
3924 @subsection Movemail Options 3980 @subsection Movemail Options
3925 3981
...@@ -4056,37 +4112,43 @@ Enable (default) or disable TLS support ...@@ -4056,37 +4112,43 @@ Enable (default) or disable TLS support
4056 @section @command{readmsg} --- Extract Messages from a Folder 4112 @section @command{readmsg} --- Extract Messages from a Folder
4057 @pindex readmsg 4113 @pindex readmsg
4058 4114
4059 The program, readmsg, extracts with the selection argument messages from 4115 The @command{readmsg} utility extracts messages from a mailbox
4060 a mailbox. Selection can be specify by: 4116 according to the criteria specified in the command line. These
4117 criteria are:
4061 4118
4062 @enumerate 4119 @enumerate
4063 @item A lone ``*'' means select all messages in the mailbox. 4120 @item A lone @samp{*} means ``select all messages in the mailbox''.
4064 4121
4065 @item 4122 @item
4066 A list of message numbers may be specified. Values 4123 A list of message numbers may be specified. Values
4067 of ``0'' and ``$'' in the list both mean the last 4124 of @samp{0} and @samp{$} in the list both mean the last
4068 message in the mailbox. For example: 4125 message in the mailbox. For example:
4069 @smallexample 4126 @smallexample
4070 readmsg 1 3 0 4127 readmsg 1 3 0
4071 @end smallexample 4128 @end smallexample
4072 extracts three messages from the folder: the first, the third, and the last. 4129 extracts three messages from the folder: the first, the third, and the last.
4073 4130
4074 @item 4131 @item
4075 Finally, the selection may be some text to match. This will select a mail 4132 Finally, the selection may be some text to match. This will select a mail
4076 message which exactly matches the specified text. For example, 4133 message which exactly matches the specified text. For example,
4077 @smallexample 4134 @smallexample
4078 readmsg staff meeting 4135 readmsg staff meeting
4079 @end smallexample 4136 @end smallexample
4080 extracts the message which contains the words ``staff meeting.'' Note that it 4137 extracts the message which contains the words @samp{staff meeting}.
4081 will not match a message containing ``Staff Meeting'' - the matching is case 4138 Note that it will not match a message containing @samp{Staff Meeting}
4082 sensitive. Normally only the first message which matches the pattern will be 4139 -- the matching is case sensitive. Normally only the first message
4083 printed. 4140 which matches the pattern is printed.
4084 @end enumerate 4141 @end enumerate
4085 4142
4086 @subsubheading Command line options 4143 @menu
4144 * Opt-readmsg:: Invocation of @command{readmsg}.
4145 * Conf-readmsg:: Configuration of @command{readmsg}.
4146 @end menu
4147
4148 @node Opt-readmsg
4149 @subsection Invocation of @command{readmsg}.
4087 4150
4088 @table @option 4151 @table @option
4089
4090 @item -a 4152 @item -a
4091 @itemx --show-all 4153 @itemx --show-all
4092 If a pattern is use for selection show all messages that match pattern 4154 If a pattern is use for selection show all messages that match pattern
...@@ -4112,15 +4174,59 @@ Do not print the message header. ...@@ -4112,15 +4174,59 @@ Do not print the message header.
4112 @itemx --form-feed 4174 @itemx --form-feed
4113 Put form-feed (Control-L) between messages instead of newline. 4175 Put form-feed (Control-L) between messages instead of newline.
4114 4176
4177 @anchor{weedlist option}
4115 @item -w @var{weedlist} 4178 @item -w @var{weedlist}
4116 @itemx --weedlist=@var{weedlist} 4179 @itemx --weedlist=@var{weedlist}
4117 A whitespace or coma separated list of header names to show per message. 4180 A whitespace or coma separated list of header names to show per message.
4118 Default is --weedlist=''From Subject Date To CC Apparently-'' 4181 Default is @option{--weedlist="From Subject Date To CC Apparently-"}.
4119 @end table 4182 @end table
4120 4183
4121 @page 4184 @node Conf-readmsg
4185 @subsection Configuration of @command{readmsg}.
4186
4187 Following configuration statements affect the behavior of
4188 @command{readmsg}:
4189
4190 @deffn {Readmsg Conf} header @var{bool}
4191 If @var{bool} is @samp{true}, display entire headers.
4192 @end deffn
4193
4194 @deffn {Readmsg Conf} weedlist @var{str}
4195 Set the weedlist. The @var{str} argument is
4196 a string, containig a list of header names, separated by whitespace,
4197 commans or colons. This corresponds to the @option{--weedlist} command
4198 line option (@pxref{Opt-readmsg, --weedlist}).
4199 @end deffn
4200
4201 @deffn {Readmsg Conf} no-header @var{bool}
4202 If @var{bool} is @samp{true}, exclude all headers.
4203 @end deffn
4204
4205 @deffn {Readmsg Conf} form-feeds @var{bool}
4206 If @var{bool} is @samp{true}, output formfeed character between
4207 messages.
4208 @end deffn
4209
4210 @deffn {Readmsg Conf} folder @var{url}
4211 Set the @acronym{URL} of the mailbox folder to read.
4212 @end deffn
4213
4214 @deffn {Readmsg Conf} show-all-match @var{bool}
4215 If @var{bool} is @samp{true}, print all messages matching pattern, not
4216 only the first.
4217 @end deffn
4218
4219 @multitable @columnfractions 0.3 0.6
4220 @headitem Statement @tab Reference
4221 @item debug @tab @xref{Debug Statement}.
4222 @item tls @tab @xref{TLS Statement}.
4223 @item mailbox @xref{Mailbox Statement}.
4224 @item locking @xref{Locking Statement}.
4225 @end multitable
4226
4122 @node sieve 4227 @node sieve
4123 @section @command{sieve} 4228 @section @command{sieve}
4229 @UNREVISED
4124 @pindex sieve 4230 @pindex sieve
4125 4231
4126 Sieve is a language for filtering e-mail messages at time of final 4232 Sieve is a language for filtering e-mail messages at time of final
......
...@@ -37,6 +37,14 @@ ...@@ -37,6 +37,14 @@
37 @set RENDITION Proof reading version 37 @set RENDITION Proof reading version
38 @end ifset 38 @end ifset
39 39
40 @macro WRITEME
41 @ifclear PUBLISH
42 @quotation
43 @emph{This node is to be written.}
44 @end quotation
45 @end ifclear
46 @end macro
47
40 @c Output marks for nodes needing revision, but not in PUBLISH rendition. 48 @c Output marks for nodes needing revision, but not in PUBLISH rendition.
41 49
42 @macro UNREVISED 50 @macro UNREVISED
......