Package: mpage Version: 2.5.4-2 Severity: normal Tags: patch I propose the attached patch for the mpage(1) manpage; the diff is relative to etch's version, 2.5.4-2.
I've tried to improve the description of the -b<papersize> option. I've also corrected a large number of typos, grammar errors, groff markup errors, trailing whitespace errors, and strange pieces of English. I hope this helps. Best wishes, J Bygott
--- mpage.1 2005-09-13 20:38:25.000000000 +0100 +++ mpage.1.new 2007-03-29 01:43:56.122338048 +0100 @@ -53,7 +53,7 @@ .SH DESCRIPTION -.I mpage +.B mpage reads plain text files or PostScript documents and prints them on a PostScript printer with the text reduced in size so that several pages appear on one sheet of paper. @@ -62,14 +62,18 @@ .PP The following options are recognized (note that arguments to options may be -separated from the option by spaces, except for +separated from the option by spaces, except for .BR -B , .BR -m , .BR -M , .B -p and .BR -P ): -Also when mpage encounters -- as option it will stop parsing arguments +Also when +.B mpage +encounters +.B -- +as option it will stop parsing arguments and the remaining arguments are interpreted as filenames. .TP @@ -83,7 +87,7 @@ .TP .B -4 Print 4 normal pages per sheet -.IR (default) . +.RI ( default ). .TP .B -8 @@ -94,25 +98,29 @@ Toggle layout of the pages on the sheet so that successively numbered pages run down the sheet, as opposed to left to right. .RI ( default -updown) . +updown). .TP .B -A -This option is deprecated, see \fB-b\fP. -Prepare output for A4 sized paper. -For default see 'mpage -x'. +This option is deprecated, use +.B -bA4 +instead. .TP -.BI -b papertype -Prepare output for selected paper type. +.BI -b papersize +Prepare output for the selected paper type. .I Papersize -can be \fIA3\fP for European A3, -\fIA4\fP for European A4, -\fILetter\fP for US Letter or \fILegal\fP for Legal -sized paper. -For default see 'mpage -x'. -To see the list of currently available types, just give the 'mpage -bl' -or 'mpage -b?' command (Note: mpage exits after finding such option use.) +can be \fBA3\fP for European A3, +\fBA4\fP for European A4, +\fBLetter\fP for US Letter, or \fBLegal\fP for Legal +sized paper. For available types, see option \fB-bl\fP. +For the default, see 'mpage -x'. This default is taken from the +system; see \fBpapersize\fP(5). If it isn't found, mpage exits +with an error. + +.TP +.BR -bl ,\ -b? +List the currently available paper types, then exit. .TP .BR -B [\fI<num>\fR[\fBlrtb\fR]*] @@ -120,19 +128,19 @@ Specify text box margins and line thickness. The default is 0 columns (lines) for both left and right (top and bottom) margins and 0 line thickness. -Specifying -.B -B -solely toggles printing of the box. +Specifying +.B -B +solely toggles printing of the box. .IR l , .IR r , .I t or .I b -set the left, right, top or bottom margin respectively to +set the left, right, top or bottom margin respectively to .I <num> columns (lines). -Not specifying any of the sides, will set the line thickness when -.I <num> +Not specifying any of the sides, will set the line thickness when +.I <num> is given. For example .BI -B 1 @@ -141,7 +149,7 @@ .TP .B -c -Toggle concatenation off pages from different files on single sheets +Toggle concatenation of pages from different files on single sheets .RI ( default off). @@ -165,27 +173,26 @@ .TP .BI -D dateformat -Set the date format as in +Set the date format as in .IR strftime (3) to be used in date/time representations (e.g. in headers). -(Note: to be useful you probably need the \fB-H\fP option.) +(Note: to make this useful you probably need the \fB-H\fP option.) .TP .B -e -Print 2 normal pages per sheet in duplex mode. Every first -and fourth page or on one side and every second and third +Print 2 normal pages per sheet in duplex mode: every first +and fourth page on one side and every second and third on the other side. This is more or less a combination of -the \fR-O\fP and \fR-E\fP option but then in one pass. +the \fR-O\fP and \fR-E\fP options but in one pass. .TP .B -E -Print 2 normal pages per sheet. However, this option will print -every second and third page of every set of four pages. -This option will ignore +Print 2 normal pages per sheet, namely: print only the second and +third page of every set of four pages. See also \fB-O\fP. These +options override .B -a and .BR -l . -See also the \fR-O\fP option. Using these options double sided prints can be created without a duplex printer. @@ -193,11 +200,11 @@ .B -f Toggles folding lines longer than page width .RI ( default -off) . +off). .TP .BI -F fontname -Specify font. +Specify font. .RI ( default Courier). Check your printer for supported fonts. Note: this has almost nothing to do with the fonts used for your X-windows/KDE/Gnome @@ -205,13 +212,13 @@ .TP .BI -h header -This is used only when the +This is used only when the .B -p or .B -H switch is used and is passed as the "\fB-h\fI\ header\fR" option to -.BR pr ( 1 ) -or as the header for +.BR pr (1) +or as the header for .BR -H . .TP @@ -219,26 +226,26 @@ Create header line for each logical page separated from page text by a horizontal line. Unless .B -h -is given, the header consist of last file modification time, +is given, the header consists of last file modification time, filename and page number, all in bold and slightly larger font. This option only applies to non-postscript files. .TP .BI -I indent -Indent text by +Indent text by .I indent characters. .TP -.BI -j first\fR[\fI-last\fR][\fI%interval\fR] +.BI -j first\fR[ - last\fR][ % interval\fR] Print just the selected sheets, specified by a number, starting at 1. -Here +Here .I last defaults to the end of data, \fIinterval\fP to 1. -Several \fB-j\fR options can be given (upto MAXJARGS, default 100) +Several \fB-j\fR options can be given (up to MAXJARGS, default 100) to create a complex selection of pages. -Thus \fB-j\fI1\-10\fR selects the first 10 sheets, while -\fB-j\fI 1%2\fR prints just the odd-numbered sheets and \fB-j\fI 2%2\fR +Thus \fB-j1\-10\fR selects the first 10 sheets, while +\fB-j\ 1%2\fR prints just the odd-numbered sheets and \fB-j\ 2%2\fR prints just the even ones. .sp You can do double-sided printing, in two passes, as follows. @@ -273,59 +280,60 @@ .TP .B -k -When mpage finds a %%TRailer or %%PSTrailer in the postscript input file +When mpage finds a %%Trailer or %%PSTrailer in the postscript input file it normally assumes this is the end of the postscript file and stops reading the input file. But when the PS file includes EPS files, %%Trailers might -be anywhere. Using this option ignores the %%TRailer and %%PSTRailer lines. +be anywhere. Using this option ignores the %%Trailer and %%PSTrailer lines. + .TP .B -l -Toggle printing landscape or portrait mode. -Landscape pages are 55 lines long by 132 characters wide by default. -Portrait pages are 66 lines long by 80 characters wide by default. +Toggle printing landscape or portrait mode .RI ( default -portrait.) +portrait). +Landscape pages are 55 lines long by 132 characters wide by default. +Portrait pages are 66 lines long by 80 characters wide by default. .TP .BI -L lines Adjust the page reduction parameters so that .I lines lines will fit in the space of one page. -This overrides the default values normally supplied. (See +This overrides the default values normally supplied. (See .BR -l .) -If used in conjunction with +If used in conjunction with .B -p then this value is passed to the .BR pr (1) as well. As a side effect this changes the font size as well (as will the \fB-W\fR -option.) So while there is an option to change font family, there is no +option.) So while there is an option to change font family, there is no explicit option to change font size! .TP .BR -m [\fI<num>\fR[\fBlrtb\fR]*] Specify sheet margin. The default margin is 20 points. -Only specifying -.B -m -sets left margin to 40 points. +Only specifying +.B -m +sets left margin to 40 points. .IR l , .IR r , .I t or .I b -set left, right, top or bottom margin respectively to +set left, right, top or bottom margin respectively to .I <num> points. -Not specifying any of the sides will set all sides when -.I <num> +Not specifying any of the sides will set all sides when +.I <num> is given. .I <num> defaults to 40 points. For example .BI -m 10 sets all margins to 10 points. .BI -m l50tb -sets left margin to default 40 and top and bottom margin to 50 points. +sets left margin to default 40 and top and bottom margins to 50 points. .BI -m 50l25bt30r -set bottom and top margin to 25, left margin to 50 and +sets bottom and top margin to 25, left margin to 50 and right margin to 30 points. Margins can have negative numbers. Very large values have funny effects. @@ -333,12 +341,12 @@ .TP .BR -M [\fI<num>\fR[\fBlrtb\fR]*] -Specify logical page margins. For syntax, see +Specify logical page margins. For syntax, see .B -m option. -Defaults are 4 for -.B -M -solely, and 8 for +Defaults are 4 for +.B -M +solely, and 8 for .IR <num> . Margins can be negative. This way large white borders @@ -354,20 +362,18 @@ .TP .B -O -Print 2 normal pages per sheet. -However, this option will print every first and fourth page of every -set of four pages. -This option will ignore +Print 2 normal pages per sheet, namely: print only the first and +fourth page of every set of four pages. See also \fB-E\fP. These +options override .B -a and .BR -l . -See also the \fR-E\fP option. Using these options double sided prints can be created without a duplex printer. .TP .BR -p [\fIprprog\fR] -Pipe input through +Pipe input through .I prprog command (including specified options) before printing (assumes the input is a text file). @@ -376,14 +382,16 @@ .TP .BR -P [\fIprinter\fR] -Specify the printer to which the PostScript output will be sent -(e.g.lpr -P\fIprinter\fP). Using +Specify the printer to which the PostScript output is sent +(e.g. lpr -P\fIprinter\fP). Using .B -P -with no printer specified will send the PostScript to the default printer -queue (e.g. lpr). Using -P- will return output to stdout, useful in -combination with MPAGE environment variable. Without +with no printer specified sends the PostScript to the default printer +queue (e.g. lpr). Using \fB-P-\fP returns output to stdout, useful in +combination with the +.B MPAGE +environment variable. Without .B -P -output will be send to standard output. +output is sent to standard output. .TP .B -r @@ -395,50 +403,58 @@ .B -R Switch to left to right mode, starting first page on left bottom corner. This might be useful for landscape postscript files. -(Note: using +(Note: using .B -l after .B -R undoes .BR -R , -and switches to normal landscape mode. +and switches to normal landscape mode.) .TP .BI -s tabstop Set tabstop width (\fIdefault\fP 8 characters). -Should by >= 2. +Should be >= 2. .TP .B -S Accept non-square page reduction. By default, pages are shrunk equally in X and Y, even if this wastes some space on the sheet. -With \fB\-S\fP, -reduced pages are larger but slightly distorted. (only used when printing +With \fB\-S\fP, +reduced pages are larger but slightly distorted. (Only used when printing postscript files.) .TP .B -t Toggle printing on both sides of the paper. This option has 3 states: nop, yes, no, which mean: -.BR NOP : - dont do anything on PostScript, so printer default will be used; -.BR YES : - force printer to do duplex; -.BR NO : +.RS +.TP +.BR NOP : +don't do anything in PostScript, use the printer default; +.TP +.BR YES : +force printer to do duplex; +.TP +.BR NO : force printer not to do it. -If there is no -t, then the duplex is NOP. If you put some -t on +.HP 0 +If there is no \fB-t\fP, then the duplex is NOP. If you put some -t on the command line, the state toggles as "yes,no,yes,no...". So, if your printer is set to print, by default, in duplex mode, -you will use "-t -t" on command line to force it to print in non-duplex mode. -Use this option only if your printer is capable of printing in duplex mode. +you will use "-t -t" on the command line to force it to print in +non-duplex mode. Use this option only if your printer is capable of +printing in duplex mode. .RI ( default NOP). +.RE .TP .B -T Toggle tumble of every second pages. -This option has 3 states: nop, yes, no (with behaviour similar to -t). +This option has 3 states: nop, yes, no (with behaviour similar to +.BR -t ). So, if your printer is set to print, by default, in duplex mode, with tumble on, you will use "-T -T" on command line to print in nontumble mode. @@ -446,7 +462,7 @@ With this version of mpage, you may use this option even if you do not use -t. .RI ( default -NOP.) +NOP). .TP .B -u @@ -454,15 +470,15 @@ .TP .B -U -This option is deprecated, see \fB-b\fP. -Prepare output for US Letter sized paper. -For default see 'mpage -x'. +This option is deprecated, use +.B -bLetter +instead. .TP .B -v Toggle printing a count of the number of sheets produced for printing .RI ( default -off.) +off). .TP .B -V @@ -470,27 +486,27 @@ .TP .BI -W width -Adjust the page reduction parameters so that a line with +Adjust the page reduction parameters so that a line .I width characters long will fit in the space of one page. -This overrides the default values normally supplied. (See +This overrides the default values normally supplied. (See .BR -l .) If used in conjunction with .B -p -then this value is passed to the s +then this value is passed to the .BR pr (1) program as well. See also the \fB-L\fP\ option on font sizes. .TP .B -x -Force usage display, which also shows current defaults. +Print usage information (including current defaults), then exit. .TP -.B -X [header] +.BR -X [\fIheader\fR] Print header on the left and the page number on the right of each physical page (sheet). -If no header is given, the default is the current filename (note +If no header is given, the default is the current filename (note influence of .BR -c ), the filename of the first file on the page is used. @@ -498,12 +514,12 @@ .TP .BI -z printcommand Specify command to use to send output to. -Default is -.B lpr -(1) for BSD style spooler, -.B lp -(1) for SYSV style spooler. -You can specify command line options, but note +Default is +.BR lpr (1) +for BSD style spooler, +.BR lp (1) +for SYSV style spooler. +You can specify command line options, but note .BR -Z . For example \fB-zlp\fR for system V Unix. @@ -521,10 +537,10 @@ .PP .SH ENVIRONMENT -.I mpage +.B mpage examines the .B PRINTER -(or +(or .B LPDEST for SYSV style spooler) environment variable to override its default printer. @@ -532,18 +548,20 @@ .PP The .B MPAGE_LIB -environment variable can be used to control where the character +environment variable can be used to control where the character encoding files (\fB-C\fR) can be found. .PP -.I mpage +.B mpage also examines the .B MPAGE environment variable for default option settings. Any option or combination of options can be specified in the .B MPAGE environment variable. -For example, if MPAGE is set to the string: +For example, if +.B MPAGE +is set to the string: .IP .B -2oPqms -L60 .PP @@ -553,14 +571,14 @@ .B "qms" (overriding the .B PRINTER\fR/\fBLPDEST -environment variable, if it exists.) +environment variable, if it exists). In the environment variable, white space is used as an option delimiter, and no quoting is recognized. .PP Any command line options will override both the .B PRINTER -and +and .B MPAGE environment variables. @@ -574,7 +592,7 @@ Suffers under the burden of far too many switches. (But .B you -wanted the choices!) +wanted the choices!) .PP NULL characters in a postscript input file will cause mpage to crash! .PP @@ -583,7 +601,7 @@ Mpage is year 2000 compliant, as long as the underlying operating system is!!! .SH VERSION -Version 2.5.4, Released may 2004. +Version 2.5.4, Released May 2004. .br Location: .IP @@ -591,6 +609,6 @@ .br ftp://ftp.mesa.nl/pub/mpage .SH AUTHORS -Marcel Mol <[EMAIL PROTECTED]> (current maintainer). +Marcel Mol <[EMAIL PROTECTED]> (current maintainer). .PP -Mark P. Hahn (Original author) +Mark P. Hahn (Original author)
