summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorThomas Roessler <roessler@does-not-exist.org>1999-08-15 11:43:03 +0000
committerThomas Roessler <roessler@does-not-exist.org>1999-08-15 11:43:03 +0000
commitd4c913f7f5de8675216d21975a49b61342600e26 (patch)
treebfff33169d7a683640b8b9bcc26827e37eb810c8 /doc
parentd0051659a6b712c4fffa8656fe1cb1fe3927e1aa (diff)
Various changes added over the last week:
- $delete_untag - creation of "application/pgp" messages - an attempt to fix prepare. - Browser format changes
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.in14
-rw-r--r--doc/manual.sgml166
-rw-r--r--doc/muttrc.man49
3 files changed, 220 insertions, 9 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in
index 552ab471..2edc9ad4 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -13,6 +13,7 @@ mandir=@mandir@
sharedir=@sharedir@
srcdir=@srcdir@
docdir=@docdir@
+includedir = @includedir@
top_srcdir=@top_srcdir@
top_builddir=..
VPATH=@srcdir@
@@ -25,6 +26,13 @@ CFLAGS=@CFLAGS@ -DSHAREDIR=\"$(sharedir)\" $(XCPPFLAGS)
LDFLAGS=@LDFLAGS@
subdir = doc
+CPPFLAGS = @CPPFLAGS@
+
+DEFS=-DSHAREDIR=\"$(sharedir)\" -DSYSCONFDIR=\"$(sysconfdir)\" \
+ -DBINDIR=\"$(bindir)\" -DHAVE_CONFIG_H=1
+INCLUDES=-I. -I$(includedir) -I$(top_srcdir)
+
+MAKEDOC_CPP=cpp $(INCLUDES) $(DEFS) $(CPPFLAGS) -D_MAKEDOC -C -include ../config.h
DISTFILES = Makefile.in dotlock.man \
mutt.man \
@@ -127,16 +135,14 @@ at=@
update-doc: ../makedoc stamp-doc-sgml stamp-doc-man
stamp-doc-man: ../makedoc $(top_srcdir)/init.h muttrc.man.head muttrc.man.tail
- cpp -D_MAKEDOC -C -I.. -I $(top_srcdir) -include ../config.h \
- $(top_srcdir)/init.h | ../makedoc -m | \
+ $(MAKEDOC_CPP) $(top_srcdir)/init.h | ../makedoc -m | \
cat $(srcdir)/muttrc.man.head - $(srcdir)/muttrc.man.tail\
> muttrc.man
touch stamp-doc-man
stamp-doc-sgml: ../makedoc $(top_srcdir)/init.h manual.sgml.head manual.sgml.tail
( sed -e "s/$(at)VERSION$(at)/`cat $(top_srcdir)/VERSION`/" manual.sgml.head ;\
- cpp -D_MAKEDOC -C -I.. -I $(top_srcdir) -include ../config.h \
- $(top_srcdir)/init.h | ../makedoc -s ) | \
+ $(MAKEDOC_CPP) $(top_srcdir)/init.h | ../makedoc -s ) | \
cat - $(srcdir)/manual.sgml.tail > manual.sgml
touch stamp-doc-sgml
diff --git a/doc/manual.sgml b/doc/manual.sgml
index 78101512..b435b290 100644
--- a/doc/manual.sgml
+++ b/doc/manual.sgml
@@ -2910,10 +2910,21 @@ deleting will automatically be purged without prompting. If set to
<em>no</em>, messages marked for deletion will be kept in the mailbox.
+<sect2>delete&lowbar;untag<label id="delete_untag">
+<p>
+Type: boolean<newline>
+Default: yes
+
+<p>
+If this option is <em>set</em>, mutt will untag messages when marking them
+for deletion. This applies when you either explicitly delete a message,
+or when you save it to another folder.
+
+
<sect2>dotlock&lowbar;program<label id="dotlock_program">
<p>
Type: path<newline>
-Default: &dquot;BINDIR/mutt&lowbar;dotlock&dquot;
+Default: &dquot;/usr/local/bin/mutt&lowbar;dotlock&dquot;
<p>
Contains the path of the mutt&lowbar;dotlock (8) binary to be used by
@@ -3038,7 +3049,7 @@ during the `set' command.
<sect2>folder&lowbar;format<label id="folder_format">
<p>
Type: string<newline>
-Default: &dquot;&percnt;N &percnt;F &percnt;2l &percnt;-8.8u &percnt;-8.8g &percnt;8s &percnt;d &percnt;f&dquot;
+Default: &dquot;&percnt;2C &percnt;t &percnt;N &percnt;F &percnt;2l &percnt;-8.8u &percnt;-8.8g &percnt;8s &percnt;d &percnt;f&dquot;
<p>
This variable allows you to customize the file browser display to your
@@ -3047,6 +3058,7 @@ its own set of printf()-like sequences:
<p>
<tscreen><verb>
+%C current file number
%d date/time folder was last modified
%f filename
%F file permissions
@@ -3054,6 +3066,7 @@ its own set of printf()-like sequences:
%l number of hard links
%N N if folder has new mail, blank otherwise
%s size in bytes
+%t * if the file is tagged, blank otherwise
%u owner name (or numeric uid, if missing)
%>X right justify the rest of the string and pad
with character "X"
@@ -3256,6 +3269,69 @@ function; <em>group-reply</em> will reply to both the sender and the
list.
+<sect2>imap&lowbar;checkinterval<label id="imap_checkinterval">
+<p>
+Type: number<newline>
+Default: 0
+
+<p>
+This variable configures how often (in seconds) IMAP should look for
+new mail.
+
+
+<sect2>imap&lowbar;list&lowbar;subscribed<label id="imap_list_subscribed">
+<p>
+Type: boolean<newline>
+Default: no
+
+<p>
+This variable configures whether IMAP folder browsing will look for
+only subscribed folders or all folders. This can be toggled in the
+IMAP browser with the <em>toggle-subscribed</em> command.
+
+
+<sect2>imap&lowbar;user<label id="imap_user">
+<p>
+Type: string<newline>
+Default: &dquot;&dquot;
+
+<p>
+Your login name on the IMAP server.
+<p>
+This variable defaults to your user name on the local machine.
+
+
+<sect2>imap&lowbar;pass<label id="imap_pass">
+<p>
+Type: string<newline>
+Default: &dquot;&dquot;
+
+<p>
+Specifies the password for your IMAP account. If unset, Mutt will
+prompt you for your password when you invoke the fetch-mail function.
+<bf>Warning</bf>: you should only use this option when you are on a
+fairly secure machine, because the superuser can read your muttrc even
+if you are the only one who can read the file.
+
+
+<sect2>imap&lowbar;passive<label id="imap_passive">
+<p>
+Type: boolean<newline>
+Default: yes
+
+<p>
+When set, mutt will not open new IMAP connections to check for new
+mail. Mutt will only check for new mail over existing IMAP
+connections. This is useful if you don't want to be prompted to
+user/password pairs on mutt invocation, or if opening the connection
+is slow.
+
+
+<sect2>imap&lowbar;home&lowbar;namespace<label id="imap_home_namespace">
+<p>
+Type: string<newline>
+Default: &dquot;&dquot;
+
<sect2>implicit&lowbar;autoview<label id="implicit_autoview">
<p>
Type: boolean<newline>
@@ -3883,6 +3959,23 @@ If you prefer reverse order of the above values, prefix it with
`reverse-'.
+<sect2>pgp&lowbar;create&lowbar;traditional<label id="pgp_create_traditional">
+<p>
+Type: quadoption<newline>
+Default: no
+
+<p>
+This option controls whether Mutt generates old-style PGP encrypted
+or signed messages under certain circumstances.
+<p>
+Note that PGP/MIME will be used automatically for messages which have
+a character set different from us-ascii, or which consist of more than
+a single MIME part.
+<p>
+Also note that using the old-style PGP message format is <bf>strongly</bf>
+<bf>deprecated</bf>.
+
+
<sect2>pgp&lowbar;decode&lowbar;command<label id="pgp_decode_command">
<p>
Type: string<newline>
@@ -3942,6 +4035,16 @@ Default: &dquot;&dquot;
This command is used to decrypt a PGP/MIME encrypted message.
+<sect2>pgp&lowbar;clearsign&lowbar;command<label id="pgp_clearsign_command">
+<p>
+Type: string<newline>
+Default: &dquot;&dquot;
+
+<p>
+This format is used to create a &dquot;clearsigned&dquot; old-style PGP attachment.
+Note that the use of this format is <bf>strongly</bf> <bf>deprecated</bf>.
+
+
<sect2>pgp&lowbar;sign&lowbar;command<label id="pgp_sign_command">
<p>
Type: string<newline>
@@ -4076,6 +4179,65 @@ The separator to add between messages when piping a list of tagged
messages to an external Unix command.
+<sect2>pop&lowbar;delete<label id="pop_delete">
+<p>
+Type: boolean<newline>
+Default: no
+
+<p>
+If set, Mutt will delete successfully downloaded messages from the POP
+server when using the fetch-mail function. When unset, Mutt will
+download messages but also leave them on the POP server.
+
+
+<sect2>pop&lowbar;host<label id="pop_host">
+<p>
+Type: string<newline>
+Default: &dquot;&dquot;
+
+<p>
+The name or address of your POP3 server.
+
+
+<sect2>pop&lowbar;port<label id="pop_port">
+<p>
+Type: number<newline>
+Default: 110
+
+<p>
+This variable specifies which port your POP server is listening on.
+
+
+<sect2>pop&lowbar;last<label id="pop_last">
+<p>
+Type: boolean<newline>
+Default: no
+
+<p>
+If this variable is set, mutt will try to use the &dquot;LAST&dquot; POP command
+for retrieving only unread messages from the POP server.
+
+
+<sect2>pop&lowbar;user<label id="pop_user">
+<p>
+Type: string<newline>
+Default: &dquot;&dquot;
+
+<p>
+Your login name on the POP3 server.
+<p>
+Defaults to your login name on the local system.
+
+
+<sect2>pop&lowbar;pass<label id="pop_pass">
+<p>
+Type: string<newline>
+Default: &dquot;&dquot;
+
+<p>
+Your password on the POP3 server.
+
+
<sect2>post&lowbar;indent&lowbar;string<label id="post_indent_string">
<p>
Type: string<newline>
diff --git a/doc/muttrc.man b/doc/muttrc.man
index df55eed4..6b8777e4 100644
--- a/doc/muttrc.man
+++ b/doc/muttrc.man
@@ -809,10 +809,22 @@ deleting will automatically be purged without prompting. If set to
.TP
+.B delete_untag
+.nf
+Type: boolean
+Default: yes
+.fi
+.IP
+If this option is \fIset\fP, mutt will untag messages when marking them
+for deletion. This applies when you either explicitly delete a message,
+or when you save it to another folder.
+
+
+.TP
.B dotlock_program
.nf
Type: path
-Default: \(lqBINDIR/mutt_dotlock\(rq
+Default: \(lq/usr/local/bin/mutt_dotlock\(rq
.fi
.IP
Contains the path of the mutt_dotlock (8) binary to be used by
@@ -947,7 +959,7 @@ during the `set' command.
.B folder_format
.nf
Type: string
-Default: \(lq%N %F %2l %-8.8u %-8.8g %8s %d %f\(rq
+Default: \(lq%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f\(rq
.fi
.IP
This variable allows you to customize the file browser display to your
@@ -960,6 +972,7 @@ its own set of printf()-like sequences:
.sp
.ft RR
.nf
+%C current file number
%d date/time folder was last modified
%f filename
%F file permissions
@@ -967,6 +980,7 @@ its own set of printf()-like sequences:
%l number of hard links
%N N if folder has new mail, blank otherwise
%s size in bytes
+%t * if the file is tagged, blank otherwise
%u owner name (or numeric uid, if missing)
%>X right justify the rest of the string and pad
with character \(rqX\(rq
@@ -1387,7 +1401,7 @@ See also: \(lqto_chars\(rq.
.B ispell
.nf
Type: path
-Default: \(lq/usr/bin/ispell\(rq
+Default: \(lqispell\(rq
.fi
.IP
How to invoke ispell (GNU's spell-checking software).
@@ -1961,6 +1975,24 @@ If you prefer reverse order of the above values, prefix it with
.TP
+.B pgp_create_traditional
+.nf
+Type: quadoption
+Default: no
+.fi
+.IP
+This option controls whether Mutt generates old-style PGP encrypted
+or signed messages under certain circumstances.
+.IP
+Note that PGP/MIME will be used automatically for messages which have
+a character set different from us-ascii, or which consist of more than
+a single MIME part.
+.IP
+Also note that using the old-style PGP message format is \fBstrongly\fP
+\fBdeprecated\fP.
+
+
+.TP
.B pgp_decode_command
.nf
Type: string
@@ -2032,6 +2064,17 @@ This command is used to decrypt a PGP/MIME encrypted message.
.TP
+.B pgp_clearsign_command
+.nf
+Type: string
+Default: \(lq\(rq
+.fi
+.IP
+This format is used to create a \(rqclearsigned\(rq old-style PGP attachment.
+Note that the use of this format is \fBstrongly\fP \fBdeprecated\fP.
+
+
+.TP
.B pgp_sign_command
.nf
Type: string