Date: Thu, 25 Sep 2003 14:05:42 +0200 (CEST) From: Josef El-Rayes <j.el-rayes@daemon.li> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/57209: [patch] article/mh: add missing docbook tags Message-ID: <20030925120542.838B160F2@gina.at> Resent-Message-ID: <200309251210.h8PCA4eQ063856@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 57209
>Category: docs
>Synopsis: [patch] article/mh: add missing docbook tags
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: update
>Submitter-Id: current-users
>Arrival-Date: Thu Sep 25 05:10:03 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator: Josef El-Rayes
>Release: FreeBSD 5.1-CURRENT i386
>Organization:
>Environment:
System: FreeBSD gina.at 5.1-CURRENT FreeBSD 5.1-CURRENT #1: Sat Sep 13 13:22:16 CEST 2003 root@gina.at:/usr/obj/usr/src/sys/GINA i386
>Description:
docs/en_US.ISO8859-1/articles/mh/article.sgml:
o add missing application tags to "MH"
o add missing ")" to %(formataddr) function
o add missing literal tags to "To:" and "Subject:"
>How-To-Repeat:
>Fix:
--- article.sgml.diff begins here ---
--- article.sgml.orig Thu Sep 25 11:57:25 2003
+++ article.sgml Thu Sep 25 13:58:49 2003
@@ -36,7 +36,7 @@
</legalnotice>
<abstract>
- <para>This document contains an introduction to using MH on
+ <para>This document contains an introduction to using <application>MH</application> on
FreeBSD</para>
</abstract>
</articleinfo>
@@ -44,23 +44,23 @@
<sect1 id="mhintro">
<title>Introduction</title>
- <para>MH started back in 1977 at the RAND Corporation, where the
- initial philosophies behind MH were developed. MH is not so much
+ <para><application>MH</application> started back in 1977 at the RAND Corporation, where the
+ initial philosophies behind <application>MH</application> were developed. <application>MH</application> is not so much
a monolithic email program but a philosophy about how best to
- develop tools for reading email. The MH developers have done a
+ develop tools for reading email. The <application>MH</application> developers have done a
great job adhering to the <acronym>KISS</acronym> principle: Keep It
Simple Stupid. Rather than have one large program for reading,
sending and handling email they have written specialized
- programs for each part of your email life. One might liken MH to
+ programs for each part of your email life. One might liken <application>MH</application> to
the specialization that one finds in insects and nature. Each
- tool in MH does one thing, and does it very well.</para>
+ tool in <application>MH</application> does one thing, and does it very well.</para>
<para>Beyond just the various tools that one uses to handle their
- email MH has done an excellent job keeping the configuration of
+ email <application>MH</application> has done an excellent job keeping the configuration of
each of these tools consistent and uniform. In fact, if you are
not quite sure how something is supposed to work or what the
arguments for some command are supposed to be, then you can
- generally guess and be right. Each MH command is consistent
+ generally guess and be right. Each <application>MH</application> command is consistent
about how it handles reading the configuration files and how it
takes arguments on the command line. One useful thing to
remember is that you can always add a <option>-help</option> to
@@ -68,9 +68,9 @@
command.</para>
<para>The first thing that you need to do is to make sure that you
- have installed the MH package on your FreeBSD machine. If you
+ have installed the <application>MH</application> package on your FreeBSD machine. If you
installed from CDROM you should be able to execute the following
- to load mh:
+ to load <application>MH</application>:
<informalexample>
<screen>&prompt.root; <userinput>pkg_add /cdrom/packages/mh-6.8.3.tgz</userinput></screen>
@@ -84,14 +84,14 @@
URL="ftp://louie.udel.edu/">louie.udel.edu</ulink>.</para>;
<para>This primer is not a full comprehensive explanation of how
- MH works. This is just intended to get you started on the road
+ <application>MH</application> works. This is just intended to get you started on the road
to happier, faster mail reading. You should read the manual pages
for the various commands. You might also want to read the <ulink
URL="news:comp.mail.mh">comp.mail.mh</ulink> newsgroup. Also
you can read the <ulink
- URL="http://www.faqs.org/faqs/mail/mh-faq/">FAQ for MH</ulink>.
- The best resource for MH is <ulink
- URL="http://www.ics.uci.edu/~mh/book/">Jerry Peek's MH &
+ URL="http://www.faqs.org/faqs/mail/mh-faq/">FAQ for <application>MH</application></ulink>.
+ The best resource for <application>MH</application> is <ulink
+ URL="http://www.ics.uci.edu/~mh/book/">Jerry Peek's <application>MH</application> &
nmh: Email for Users & Programmers</ulink>.</para>
</sect1>
@@ -101,7 +101,7 @@
<para>This section covers how to use <command>inc</command>,
<command>show</command>, <command>scan</command>, <command>next</command>,
<command>prev</command>, <command>rmm</command>, <command>rmf</command>, and
- <command>msgchk</command>. One of the best things about MH is the
+ <command>msgchk</command>. One of the best things about <application>MH</application> is the
consistent interface between programs. One thing to keep in
mind when using these commands is how to specify message lists.
In the case of <command>inc</command> this does not really make any
@@ -124,8 +124,8 @@
<para>If you just type in <userinput>inc</userinput> and hit
<keycap>return</keycap> you will be well on your way to getting
- started with MH. The first time you run <command>inc</command> it
- will setup your account to use all the MH defaults and ask you
+ started with <application>MH</application>. The first time you run <command>inc</command> it
+ will setup your account to use all the <application>MH</application> defaults and ask you
about creating a <filename>Mail</filename> directory under your HOME directory. If you have mail waiting to
be downloaded you will see something that looks like:</para>
@@ -144,7 +144,7 @@
you.</para>
<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
+ <application>MH</application> can do POP to grab your email. You will need to give
<command>inc</command> a few command line arguments.</para>
<informalexample>
@@ -155,7 +155,7 @@
<parameter>mail.pop.org</parameter> to download your email, and that
your username on their system is <replaceable>username</replaceable>. The
<option>-norpop</option> option tells <command>inc</command> to use
- plain POP3 for downloading your email. MH has support for a
+ plain POP3 for downloading your email. <application>MH</application> has support for a
few different dialects of POP. More than likely you will never
ever need to use them though. While you can do more complex
things with <command>inc</command> such as audit files and scan format files this
@@ -210,7 +210,7 @@
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
+ <para>Like just about everything in <application>MH</application> 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 fragment from the very beginning
@@ -235,7 +235,7 @@
<para><command>rmm</command> is used to remove a mail message. The
default is typically to not actually remove the message but to
- rename the file to one that is ignored by the MH commands. You
+ rename the file to one that is ignored by the <application>MH</application> commands. You
will periodically need to go through and physically delete the
<quote>removed</quote> messages.</para>
@@ -327,7 +327,7 @@
<para>Then if I wanted to read message number 27 I would do a
<userinput>show 27</userinput> and it would be displayed. As you can
- probably tell from this sample session MH is pretty easy to
+ probably tell from this sample session <application>MH</application> is pretty easy to
use and looking through emails and displaying them is fairly
intuitive and easy.</para>
</sect2>
@@ -338,12 +338,12 @@
<para>Anybody who gets lots of email definitely wants to be able
to prioritize, stamp, brief, de-brief, and number their emails
- in a variety of different ways. MH can do this better than just
+ in a variety of different ways. <application>MH</application> can do this better than just
about anything. One thing that we have not really talked about is
the concept of folders. You have undoubtedly come across the
- folders concept using other email programs. MH has folders too.
- MH can even do sub-folders of a folder. One thing you should
- keep in mind with MH is that when you ran <command>inc</command> for
+ folders concept using other email programs. <application>MH</application> has folders too.
+ <application>MH</application> can even do sub-folders of a folder. One thing you should
+ keep in mind with <application>MH</application> is that when you ran <command>inc</command> for
the first time and it asked you if it could create a
<filename>Mail</filename> directory it began storing everything in that
directory. If you look at that directory you will find a
@@ -352,19 +352,19 @@
thrown anywhere else.</para>
<para>Whenever you create a new folder a new directory is going to
- be created underneath your MH <filename>Mail</filename> directory, and
+ be created underneath your <application>MH</application> <filename>Mail</filename> directory, and
messages in that folder are going to be stored in that
directory. When a new email message comes, it is thrown
into your <filename>inbox</filename> directory with a file name that is
equivalent to the message number. So even if you did not have
- any of the MH tools to read your email you could still use
+ any of the <application>MH</application> tools to read your email you could still use
standard &unix; commands to munge around in those directories and
just more your files. It is this simplicity that really gives you
a lot of power with what you can do with your email.</para>
<para>Just as you can use message lists like <parameter>23 16
- 42</parameter> with most MH commands there is a folder option you can
- specify with just about every MH command. If you do a
+ 42</parameter> with most <application>MH</application> commands there is a folder option you can
+ specify with just about every <application>MH</application> command. If you do a
<command>scan +freebsd</command> it will scan your <filename>freebsd</filename>
folder, and your current folder will be changed to
<filename>freebsd</filename>. If you do a <command>show +freebsd 23 16
@@ -374,7 +374,7 @@
will need to make sure you use it to make commands process
different folders. Remember you default folder for mail is
<filename>inbox</filename> so doing a <command>folder +inbox</command> should
- always get you back to your mail. Of course, in MH's infinite
+ always get you back to your mail. Of course, in <application>MH</application>'s infinite
flexibility this can be changed but most places have probably
left it as <command>inbox</command>.</para>
@@ -383,7 +383,7 @@
criteria</title>
<para><command>pick</command> is one of the more complex commands in
- the MH system. So you might want to read the
+ the <application>MH</application> system. So you might want to read the
<citerefentry><refentrytitle>pick</refentrytitle><manvolnum>1</manvolnum></citerefentry> man
page for a more thorough understanding. At its simplest level
you can do something like</para>
@@ -416,7 +416,7 @@
really an abbreviation of <option>-sequence</option> and
<command>pick</command> is just a sequence which contains the message
numbers that matched. You can use sequences with just about
- any MH command. So you could have done an <command>rmm pick</command>
+ any <application>MH</application> command. So you could have done an <command>rmm pick</command>
and all those messages would be removed instead. You sequence
can be named anything. If you run pick again it will overwrite
the old sequence if you use the same name.</para>
@@ -513,7 +513,7 @@
<screen>&prompt.user; <userinput>pick -to freebsd-hackers -or -cc freebsd-hackers</userinput></screen>
</informalexample>
- <para>That will grab all the email in your inbox that was sent
+ <para>That will grab all the email in your <filename role="directory">inbox</filename> 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>
@@ -531,10 +531,10 @@
the subject line. Ordinarily you might have to worry about
something called operator precedence. Remember in math how you
evaluate from left to right and you do multiplication and
- division first and addition and subtraction second? MH has the
+ division first and addition and subtraction second? <application>MH</application> has the
same type of rules for <command>pick</command>. It is fairly complex
so you might want to study the manual page. This document is just
- to help you get acquainted with MH.</para>
+ to help you get acquainted with <application>MH</application>.</para>
</sect2>
<sect2>
@@ -547,7 +547,7 @@
used to switch between folders, pack them, and list them. At
its simplest level you can do a <command>folder
+<replaceable>newfolder</replaceable></command> and you will be switched into
- <replaceable>newfolder</replaceable>. From there on out all your MH
+ <replaceable>newfolder</replaceable>. From there on out all your <application>MH</application>
commands like <command>comp</command>, <command>repl</command>,
<command>scan</command>, and <command>show</command> will act on that
<command>newfolder</command> folder.</para>
@@ -597,7 +597,7 @@
which would keep 23 in your current <filename>inbox</filename> but
also list in your <filename>netfuture</filename> folder. You are
probably beginning to realize some of the really powerful
- things you can do with MH.</para>
+ things you can do with <application>MH</application>.</para>
</sect2>
</sect1>
@@ -605,12 +605,12 @@
<title>Sending Mail</title>
<para>Email is a two way street for most people so you want to be
- able to send something back. The way MH handles sending mail can
+ able to send something back. The way <application>MH</application> handles sending mail can
be a bit difficult to follow at first, but it allows for
- incredible flexibility. The first thing MH does is to copy a
+ incredible flexibility. The first thing <application>MH</application> does is to copy a
components file into your outgoing email. A components file is
- basically a skeleton email letter with stuff like the To: and
- Subject: headers already in it. You are then sent into your
+ basically a skeleton email letter with stuff like the <literal>To:</literal> and
+ <literal>Subject:</literal> headers already in it. You are then sent into your
editor where you fill in the header information and then type
the body of your message below the dashed lines in the message.
When you leave the editor, the <command>whatnow</command> program is run. When you are at the
@@ -629,9 +629,9 @@
<para>The <command>comp</command> program has a few useful command line
options. The most important one to know right now is the
- <option>-editor</option> option. When MH is installed the
+ <option>-editor</option> option. When <application>MH</application> is installed the
default editor is usually a program called
- <command>prompter</command> which comes with MH. It is not a very
+ <command>prompter</command> which comes with <application>MH</application>. It is not a very
exciting editor and basically just gets the job done. So when
you go to compose a message to someone you might want to use
<command>comp -editor /usr/bin/vi</command> or <command>comp -editor
@@ -697,7 +697,7 @@
<parameter>me</parameter> after the <option>-cc</option> option to have
<command>repl</command> automatically add the various addresses to
the <literal>Cc:</literal> list in the message. You have probably noticed that the
- original message is not included. This is because most MH
+ original message is not included. This is because most <application>MH</application>
setups are configured to do this from the start.</para>
</sect2>
@@ -708,7 +708,7 @@
<para>The <filename>components</filename> file is usually in
<filename>/usr/local/lib/mh</filename>. You can copy that file
- into your MH Mail directory and edit to contain what you want
+ into your <application>MH</application> Mail directory and edit to contain what you want
it to contain. It is a fairly basic file. You have various
email headers at the top, a dashed line and then nothing. The
<command>comp</command> command just copies this
@@ -726,7 +726,7 @@
-------</screen>
</informalexample>
- <para>MH would then copy this components file and throw you into
+ <para><application>MH</application> would then copy this components file and throw you into
your editor. The <filename>components</filename> file is fairly
simple. If you wanted to have a signature on those messages
you would just put your signature in that
@@ -751,7 +751,7 @@
<para>It is in the same basic format as the
<filename>components</filename> file but it contains quite a few extra
formatting codes. The <literal>%(lit)</literal> command makes room
- for the address. The <literal>%(formataddr</literal> is a function
+ for the address. The <literal>%(formataddr)</literal> is a function
that returns a proper email address. The next part is
<literal>%<</literal> which means if and the
<literal>{reply-to}</literal> means the reply-to field in the
@@ -765,14 +765,14 @@
message</emphasis>, %> <emphasis remap=bf>endif</emphasis>.</screen>
</informalexample>
- <para>As you can tell MH formatting can get rather involved. You
+ <para>As you can tell <application>MH</application> formatting can get rather involved. You
can probably decipher what most of the other functions and
variables mean. All of the information on writing these format
strings is in the MH-Format manual page. The really nice thing is
that once you have built your customized
<filename>replcomps</filename> file you will not need to touch it again.
No other email program really gives you the power and
- flexibility that MH gives you.</para>
+ flexibility that <application>MH</application> gives you.</para>
</sect2>
</sect1>
</article>
--- article.sgml.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030925120542.838B160F2>