From owner-freebsd-doc@FreeBSD.ORG Thu Sep 25 05:10:07 2003 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 2810216A4B3 for ; Thu, 25 Sep 2003 05:10:07 -0700 (PDT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 55C5244037 for ; Thu, 25 Sep 2003 05:10:04 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.12.9/8.12.9) with ESMTP id h8PCA4FY063857 for ; Thu, 25 Sep 2003 05:10:04 -0700 (PDT) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.9/8.12.9/Submit) id h8PCA4eQ063856; Thu, 25 Sep 2003 05:10:04 -0700 (PDT) (envelope-from gnats) Resent-Date: Thu, 25 Sep 2003 05:10:04 -0700 (PDT) Resent-Message-Id: <200309251210.h8PCA4eQ063856@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Josef El-Rayes Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 520B016A4B3 for ; Thu, 25 Sep 2003 05:06:03 -0700 (PDT) Received: from octopussy.utanet.at (octopussy.utanet.at [213.90.36.45]) by mx1.FreeBSD.org (Postfix) with ESMTP id 6D67143FF3 for ; Thu, 25 Sep 2003 05:05:58 -0700 (PDT) (envelope-from shammer@daemon.li) Received: from patricia.utanet.at ([213.90.36.8]) by octopussy.utanet.at with esmtp (Exim 4.12) id 1A2Usf-0005xZ-00 for FreeBSD-gnats-submit@freebsd.org; Thu, 25 Sep 2003 14:05:57 +0200 Received: from dsl-242-85.utaonline.at ([212.152.242.85] helo=gina.at) by patricia.utanet.at with esmtp (Exim 4.12) id 1A2Usb-00062Y-00 for FreeBSD-gnats-submit@freebsd.org; Thu, 25 Sep 2003 14:05:53 +0200 Received: by gina.at (Postfix, from userid 1001) id 838B160F2; Thu, 25 Sep 2003 14:05:42 +0200 (CEST) Message-Id: <20030925120542.838B160F2@gina.at> Date: Thu, 25 Sep 2003 14:05:42 +0200 (CEST) From: Josef El-Rayes To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Subject: docs/57209: [patch] article/mh: add missing docbook tags X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: Josef El-Rayes List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 25 Sep 2003 12:10:07 -0000 >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 @@ - This document contains an introduction to using MH on + This document contains an introduction to using MH on FreeBSD @@ -44,23 +44,23 @@ Introduction - MH started back in 1977 at the RAND Corporation, where the - initial philosophies behind MH were developed. MH is not so much + MH started back in 1977 at the RAND Corporation, where the + initial philosophies behind MH were developed. MH 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 MH developers have done a great job adhering to the KISS 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 MH to the specialization that one finds in insects and nature. Each - tool in MH does one thing, and does it very well. + tool in MH does one thing, and does it very well. Beyond just the various tools that one uses to handle their - email MH has done an excellent job keeping the configuration of + email MH 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 MH 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 to @@ -68,9 +68,9 @@ command. 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 MH package on your FreeBSD machine. If you installed from CDROM you should be able to execute the following - to load mh: + to load MH: &prompt.root; pkg_add /cdrom/packages/mh-6.8.3.tgz @@ -84,14 +84,14 @@ URL="ftp://louie.udel.edu/">louie.udel.edu. This primer is not a full comprehensive explanation of how - MH works. This is just intended to get you started on the road + MH 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 comp.mail.mh newsgroup. Also you can read the FAQ for MH. - The best resource for MH is Jerry Peek's MH & + URL="http://www.faqs.org/faqs/mail/mh-faq/">FAQ for MH. + The best resource for MH is Jerry Peek's MH & nmh: Email for Users & Programmers. @@ -101,7 +101,7 @@ This section covers how to use inc, show, scan, next, prev, rmm, rmf, and - msgchk. One of the best things about MH is the + msgchk. One of the best things about MH 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 inc this does not really make any @@ -124,8 +124,8 @@ If you just type in inc and hit return you will be well on your way to getting - started with MH. The first time you run inc it - will setup your account to use all the MH defaults and ask you + started with MH. The first time you run inc it + will setup your account to use all the MH defaults and ask you about creating a Mail directory under your HOME directory. If you have mail waiting to be downloaded you will see something that looks like: @@ -144,7 +144,7 @@ you. 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 + MH can do POP to grab your email. You will need to give inc a few command line arguments. @@ -155,7 +155,7 @@ mail.pop.org to download your email, and that your username on their system is username. The option tells inc to use - plain POP3 for downloading your email. MH has support for a + plain POP3 for downloading your email. MH 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 inc 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 - Like just about everything in MH this display is very + 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 fragment from the very beginning @@ -235,7 +235,7 @@ rmm 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 MH commands. You will periodically need to go through and physically delete the removed messages. @@ -327,7 +327,7 @@ Then if I wanted to read message number 27 I would do a show 27 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 MH is pretty easy to use and looking through emails and displaying them is fairly intuitive and easy. @@ -338,12 +338,12 @@ 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. MH 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 inc for + 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 inc for the first time and it asked you if it could create a Mail 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. Whenever you create a new folder a new directory is going to - be created underneath your MH Mail directory, and + be created underneath your MH Mail 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 inbox 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 MH 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. Just as you can use message lists like 23 16 - 42 with most MH commands there is a folder option you can - specify with just about every MH command. If you do a + 42 with most MH commands there is a folder option you can + specify with just about every MH command. If you do a scan +freebsd it will scan your freebsd folder, and your current folder will be changed to freebsd. If you do a 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 inbox so doing a folder +inbox should - always get you back to your mail. Of course, in MH's infinite + always get you back to your mail. Of course, in MH's infinite flexibility this can be changed but most places have probably left it as inbox. @@ -383,7 +383,7 @@ criteria pick is one of the more complex commands in - the MH system. So you might want to read the + the MH system. So you might want to read the pick1 man page for a more thorough understanding. At its simplest level you can do something like @@ -416,7 +416,7 @@ really an abbreviation of and pick 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 rmm pick + any MH command. So you could have done an rmm pick 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. @@ -513,7 +513,7 @@ &prompt.user; pick -to freebsd-hackers -or -cc freebsd-hackers - That will grab all the email in your inbox that was sent + 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 @@ -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? MH has the same type of rules for pick. It is fairly complex so you might want to study the manual page. This document is just - to help you get acquainted with MH. + to help you get acquainted with MH. @@ -547,7 +547,7 @@ used to switch between folders, pack them, and list them. At its simplest level you can do a folder +newfolder and you will be switched into - newfolder. From there on out all your MH + newfolder. From there on out all your MH commands like comp, repl, scan, and show will act on that newfolder folder. @@ -597,7 +597,7 @@ which would keep 23 in your current inbox but also list in your netfuture folder. You are probably beginning to realize some of the really powerful - things you can do with MH. + things you can do with MH. @@ -605,12 +605,12 @@ Sending Mail 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 MH 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 MH 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 To: and + Subject: 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 whatnow program is run. When you are at the @@ -629,9 +629,9 @@ The comp program has a few useful command line options. The most important one to know right now is the - option. When MH is installed the + option. When MH is installed the default editor is usually a program called - prompter which comes with MH. It is not a very + prompter which comes with MH. 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 comp -editor /usr/bin/vi or comp -editor @@ -697,7 +697,7 @@ me after the option to have repl automatically add the various addresses to the Cc: 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 MH setups are configured to do this from the start. @@ -708,7 +708,7 @@ The components file is usually in /usr/local/lib/mh. You can copy that file - into your MH Mail directory and edit to contain what you want + into your MH 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 comp command just copies this @@ -726,7 +726,7 @@ ------- - MH would then copy this components file and throw you into + MH would then copy this components file and throw you into your editor. The components 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 @@ It is in the same basic format as the components file but it contains quite a few extra formatting codes. The %(lit) command makes room - for the address. The %(formataddr is a function + for the address. The %(formataddr) is a function that returns a proper email address. The next part is %< which means if and the {reply-to} means the reply-to field in the @@ -765,14 +765,14 @@ message, %> endif. - As you can tell MH formatting can get rather involved. You + As you can tell MH 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 replcomps file you will not need to touch it again. No other email program really gives you the power and - flexibility that MH gives you. + flexibility that MH gives you. --- article.sgml.diff ends here --- >Release-Note: >Audit-Trail: >Unformatted: