Date: 8 Oct 1999 18:28:00 -0000 From: nbm@rucus.ru.ac.za To: FreeBSD-gnats-submit@freebsd.org Subject: docs/14212: preparatory markup fixes for mh article Message-ID: <19991008182800.63469.qmail@mithrandr.moria.org>
next in thread | raw e-mail | index | archive | help
>Number: 14212
>Category: docs
>Synopsis: preparatory markup fixes for mh article
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: change-request
>Submitter-Id: current-users
>Arrival-Date: Fri Oct 8 11:30:00 PDT 1999
>Closed-Date:
>Last-Modified:
>Originator: Neil Blakey-Milner
>Release: FreeBSD 4.0-CURRENT i386
>Organization:
Rhodes University Computer Users' Society
>Environment:
FreeBSD mithrandr.moria.org 4.0-CURRENT FreeBSD 4.0-CURRENT #2: Wed Sep 29 17:30:21 SAST 1999 root@mithrandr.moria.org:/usr/src/sys/compile/MITHRANDR i386
>Description:
Make use of &prompt.user entity for consistency.
De-<para> examples, if possible, to ease indenting.
>How-To-Repeat:
>Fix:
cvs diff: Diffing .
Index: article.sgml
===================================================================
RCS file: /home/nbm/ncvs/doc/en_US.ISO_8859-1/articles/mh/article.sgml,v
retrieving revision 1.5
diff -u -r1.5 article.sgml
--- article.sgml 1999/10/04 21:45:05 1.5
+++ article.sgml 1999/10/08 17:03:33
@@ -54,7 +54,7 @@
installed the MH package on your FreeBSD machine. If you installed
from CDROM you should be able to execute the following to load mh:
<informalexample>
-<screen># <userinput>pkg_add /cdrom/packages/mh-6.8.3.tgz</></screen>
+<screen>&prompt.root; <userinput>pkg_add /cdrom/packages/mh-6.8.3.tgz</></screen>
</informalexample>
You will notice that it created a <filename>/usr/local/lib/mh</>
directory for you as well as adding several binaries to the
@@ -107,6 +107,7 @@
the MH defaults and ask you about creating a Mail directory. If you
have mail waiting to be downloaded you will see something that looks
like:
+</para>
<informalexample>
<screen> 29 01/15 Doug White Re: Another Failed to boot problem<<On Mon, 15 J
30 01/16 "Jordan K. Hubbar Re: FBSD 2.1<<> Do you want a library instead of
@@ -114,6 +115,7 @@
32 01/16 "Jordan K. Hubbar Re: video is up<<> Anyway, mrouted won't run, ev
33 01/16 Michael Smith Re: FBSD 2.1<<Nate Williams stands accused of sa</screen>
</informalexample>
+<para>
This is the same thing you will see from a <command>scan</> (see
<xref linkend="scan">). If you just run <command>inc</> with no
arguments it will look on your computer for email that is supposed to
@@ -122,9 +124,11 @@
<para>A lot of people like to use POP for grabbing their email. MH can do
POP to grab your email. You will need to give <command>inc</> a few command
line arguments.
+</para>
<informalexample>
-<screen>tempest% <userinput>inc -host mail.pop.org -user <replaceable>username</> -norpop</></screen>
+<screen>&prompt.user; <userinput>inc -host mail.pop.org -user <replaceable>username</> -norpop</></screen>
</informalexample>
+<para>
That tells <command>inc</> to go to <parameter>mail.pop.org</> to
download your email, and that your username on their system is
<replaceable>username</>. The <option>-norpop</option> option tells
@@ -149,9 +153,11 @@
command. If you just type <userinput>show</> and hit <keycap>return</>
then it displays the current message. You can also give specific
message numbers to show:
+</para>
<informalexample>
-<screen>tempest% <userinput>show 32 45 56</></screen>
+<screen>&prompt.user; <userinput>show 32 45 56</></screen>
</informalexample>
+<para>
This would display message numbers 32, 45 and 56 right after each
other. Unless you change the default behavior <command>show</>
basically just does a <command>more</> on the email message.</para>
@@ -169,12 +175,14 @@
<para><command>scan</> will display a brief listing of the messages
in your current folder. This is an example of what the
<command>scan</> command will give you.
+</para>
<informalexample>
<screen> 30+ 01/16 "Jordan K. Hubbar Re: FBSD 2.1<<> Do you want a library instead of
31 01/16 Bruce Evans Re: location of bad144 table<<>> >It would appea
32 01/16 "Jordan K. Hubbar Re: video is up<<> Anyway, mrouted won't run, ev
33 01/16 Michael Smith Re: FBSD 2.1<<Nate Williams stands accused of sa</screen>
</informalexample>
+<para>
Like just about everything in MH this display is very configurable.
This is the typical default display. It gives you the message number,
the date on the email, the sender, the subject line, and a sentence
@@ -214,19 +222,22 @@
<para>The first thing that you will want to do is <command>inc</>
your new mail. So at a shell prompt just type in <command>inc</> and
hit <keycap>return</>.
+</para>
<informalexample>
-<screen>tempest% <userinput>inc</>
+<screen>&prompt.user; <userinput>inc</>
Incorporating new mail into inbox...
36+ 01/19 "Stephen L. Lange Request...<<Please remove me as contact for pind
37 01/19 Matt Thomas Re: kern/950: Two PCI bridge chips fail (multipl
38 01/19 "Amancio Hasty Jr Re: FreeBSD and VAT<<>>> Bill Fenner said: > In
-tempest%</screen>
+&prompt.user;</screen>
</informalexample>
+<para>
This shows you the new email that has been added to your mailbox. So
the next thing to do is <command>show</> the email and move around.
+</para>
<informalexample>
-<screen>tempest% <userinput>show</>
+<screen>&prompt.user; <userinput>show</>
Received: by sashimi.wwa.com (Smail3.1.29.1 #2)
id m0tdMZ2-001W2UC; Fri, 19 Jan 96 13:33 CST
Date: Fri, 19 Jan 1996 13:33:31 -0600 (CST)
@@ -240,8 +251,8 @@
Please remove me as contact for pindat.com
-tempest% <userinput>rmm</>
-tempest% <userinput>next</>
+&prompt.user; <userinput>rmm</>
+&prompt.user; <userinput>next</>
Received: from localhost (localhost [127.0.0.1]) by whydos.lkg.dec.com (8.6.11/8
.6.9) with SMTP id RAA24416; Fri, 19 Jan 1996 17:56:48 GMT
Message-Id: <199601191756.RAA24416@whydos.lkg.dec.com>
@@ -262,14 +273,15 @@
This is due to a typo in pcireg.h (to
which I am probably the guilty party).</screen>
-</informalexample></para>
+</informalexample>
<para>The <command>rmm</> removed the current message and the
<command>next</> command moved me on to the next message.
Now if I wanted to look at ten most recent messages so I could read
one of them here is what I would do:
+</para>
<informalexample>
-<screen>tempest% <userinput>scan last:10</>
+<screen>&prompt.user; <userinput>scan last:10</>
26 01/16 maddy Re: Testing some stuff<<yeah, well, Trinity has
27 01/17 Automatic digest NET-HAPPENINGS Digest - 16 Jan 1996 to 17 Jan 19
28 01/17 Evans A Criswell Re: Hey dude<<>From matt@tempest.garply.com Tue
@@ -280,8 +292,9 @@
35 01/19 support@foo.garpl [garply.com #1138] parlor<<Hello. This is the Ne
37+ 01/19 Matt Thomas Re: kern/950: Two PCI bridge chips fail (multipl
38 01/19 "Amancio Hasty Jr Re: FreeBSD and VAT<<>>> Bill Fenner said: > In
-tempest%</screen>
+&prompt.user;</screen>
</informalexample>
+<para>
Then if I wanted to read message number 27 I would do a
<userinput>show 27</> and it would be displayed. As you can probably
tell from this sample session MH is pretty easy to use and looking
@@ -343,15 +356,16 @@
<citerefentry><refentrytitle>pick</><manvolnum>1</></> man page for a
more thorough understanding. At its simplest level you can do
something like
+</para>
<informalexample>
-<screen>tempest% <userinput>pick -search pci</>
+<screen>&prompt.user; <userinput>pick -search pci</>
15
42
55
56
57</screen>
</informalexample>
-
+<para>
This will tell <command>pick</> to look through every single line in
every message in your current folder and tell you which message
numbers it found the word <literal>pci</> in. You can then
@@ -359,11 +373,13 @@
<command>rmm</> them. You would have to specify something like
<command>show 15 42 55-57</> to display them though. A slightly more
useful thing to do is this:
+</para>
<informalexample>
-<screen>tempest% <userinput>pick -search pci -seq pick</>
+<screen>&prompt.user; <userinput>pick -search pci -seq pick</>
5 hits
-tempest% <userinput>show pick</></screen>
+&prompt.user; <userinput>show pick</></screen>
</informalexample>
+<para>
This will show you the same messages you just didn't have to work as
hard to do it. The <option>-seq</option> option is really an
abbreviation of <option>-sequence</option> and <command>pick</> is
@@ -377,6 +393,7 @@
consuming than just searching for message from someone, or to
someone. So <command>pick</> allows you to use the following
predefined search criteria:
+</para>
<variablelist>
@@ -424,15 +441,16 @@
</listitem>
</varlistentry>
-</variablelist></para>
+</variablelist>
<para>This allows you to do things like
<informalexample>
-<screen>tempest% <userinput>pick -to freebsd-hackers@FreeBSD.org -seq hackers</></screen>
+<screen>&prompt.user; <userinput>pick -to freebsd-hackers@FreeBSD.org -seq hackers</></screen>
</informalexample>
to get a list of all the email send to the FreeBSD hackers mailing
list. <command>pick</> also allows you to group these criteria in
different ways using the following options:
+</para>
<itemizedlist>
<listitem>
@@ -452,18 +470,22 @@
</listitem>
</itemizedlist>
+<para>
These commands allow you to do things like
+</para>
<informalexample>
-<screen>tempest% <userinput>pick -to freebsd-hackers -and -cc freebsd-hackers</></screen>
+<screen>&prompt.user; <userinput>pick -to freebsd-hackers -and -cc freebsd-hackers</></screen>
</informalexample>
+<para>
That will grab all the email in your inbox that was sent to
freebsd-hackers or cc'd to that list. The brace options allow you to
group search criteria together. This is sometimes very necessary as
in the following example
+</para>
<informalexample>
-<screen>tempest% <userinput>pick -lbrace -to freebsd-hackers -and
+<screen>&prompt.user; <userinput>pick -lbrace -to freebsd-hackers -and
-not -cc freebsd-questions -rbrace -and -subject pci</></screen>
-</informalexample></para>
+</informalexample>
<para>Basically this says <quote>pick (to freebsd-hackers and not cc'd on
freebsd-questions) and the subject is pci</quote>. It should look through your
@@ -506,6 +528,7 @@
folders is the same one you get when you change to a folder with
<command>folder +foldername</>. A <command>folders</> command looks
like this:
+</para>
<informalexample>
<screen> Folder # of messages ( range ); cur msg (other files)
announce has 1 message ( 1- 1).
@@ -521,7 +544,7 @@
TOTAL= 199 messages in 13 folders.
</screen>
-</informalexample></para>
+</informalexample>
<para>The <command>refile</> command is what you use to move messages
between folders. When you do something like <command>refile 23
@@ -573,13 +596,14 @@
-editor /usr/local/bin/pico/</> instead. Once you have run
<emphasis>comp</emphasis> you are in your editor and you see
something that looks like this:
+</para>
<informalexample>
<screen>To:
cc:
Subject:
--------
</screen>
-</informalexample></para>
+</informalexample>
<para>You need to put the person you are sending the mail to after the
<literal>To:</> line. It works the same way for the other headers
@@ -589,6 +613,7 @@
lot of email programs have special requesters that ask you for this
information but there really isn't any point to that. Plus this
really gives you excellent flexibility.
+</para>
<informalexample>
<screen>To:<userinput>freebsd-rave@FreeBSD.org</>
cc:
@@ -596,6 +621,7 @@
--------
<userinput>Wow this is an amazing operating system. Thanks!</></screen>
</informalexample>
+<para>
You can now save this message and exit your editor. You will see the
<prompt>What now?</> prompt and you can type in
<userinput>send</> or <userinput>s</> and hit
@@ -644,6 +670,7 @@
<filename>components</> file and then edits it. You can add any
kind of valid RFC822 header you want. For instance you could have
something like this in your <filename>components</> file:
+</para>
<informalexample>
<screen>To:
Fcc: out
@@ -652,7 +679,7 @@
X-Home-Page: http://www.FreeBSD.org/
-------</screen>
</informalexample>
-
+<para>
MH would then copy this components file and throw you into your
editor. The <filename>components</> file is fairly simple. If you
wanted to have a signature on those messages you would just put your
@@ -660,6 +687,7 @@
<para>The <filename>replcomps</> file is a bit more complex. The default
<filename>replcomps</> looks like this:
+</para>
<informalexample>
<screen>%(lit)%(formataddr %<{reply-to}%?{from}%?{sender}%?{return-path}%>)\
%<(nonnull)%(void(width))%(putaddr To: )\n%>\
@@ -672,7 +700,7 @@
%{message-id}%>\n%>\
--------
</screen>
-</informalexample></para>
+</informalexample>
<para>It's in the same basic format as the <filename>components</> file but
it contains quite a few extra formatting codes. The
@@ -681,13 +709,14 @@
address. The next part is <literal>%<</literal> which means if and
the <literal>{reply-to}</> means the reply-to field in the original
message. So that might be translated this way:
+</para>
<informalexample>
<screen>%<<emphasis remap=bf>if</emphasis> {reply-to} <emphasis remap=bf>the original message has a reply-to</emphasis>
then give that to formataddr, %? <emphasis remap=bf>else</emphasis> {from} <emphasis remap=bf>take the
from address</emphasis>, %? <emphasis remap=bf>else</emphasis> {sender} <emphasis remap=bf>take the sender address</emphasis>, %?
<emphasis remap=bf>else</emphasis> {return-path} <emphasis remap=bf>take the return-path from the original
message</emphasis>, %> <emphasis remap=bf>endif</emphasis>.</screen>
-</informalexample></para>
+</informalexample>
<para>As you can tell MH formatting can get rather involved. You can
probably decipher what most of the other functions and variables
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19991008182800.63469.qmail>