diff options
author | wl <wl> | 2008-09-29 21:55:07 +0000 |
---|---|---|
committer | wl <wl> | 2008-09-29 21:55:07 +0000 |
commit | 3c3598c7c61bebf516678298620381398016f57c (patch) | |
tree | dddf756bdf3439ea89a0141b3fbc48ec5c74ce73 | |
parent | 39484230581e08de3bde5c7ebbf8618df6824467 (diff) | |
download | groff-3c3598c7c61bebf516678298620381398016f57c.tar.gz |
Formatting.
-rw-r--r-- | contrib/eqn2graph/eqn2graph.man | 21 | ||||
-rw-r--r-- | contrib/pic2graph/pic2graph.man | 64 |
2 files changed, 53 insertions, 32 deletions
diff --git a/contrib/eqn2graph/eqn2graph.man b/contrib/eqn2graph/eqn2graph.man index 426c8a32..9ea5b2ea 100644 --- a/contrib/eqn2graph/eqn2graph.man +++ b/contrib/eqn2graph/eqn2graph.man @@ -1,4 +1,4 @@ -.\" $Id: eqn2graph.man,v 1.5 2008/09/29 00:53:29 esr Exp $ +.\" $Id: eqn2graph.man,v 1.6 2008/09/29 21:55:07 wl Exp $ .\" This documentation is released to the public domain. . . @@ -31,14 +31,17 @@ Reads an EQN equation (one line) as input; produces an image file (by default in Portable Network Graphics format) suitable for the Web as output. .P -Your input EQN code should \fInot\fR have the \&.EQ/.EN preamble that +Your input EQN code should +.I not +have the \&.EQ/.EN preamble that that normally precedes it within .BR groff (@MAN1EXT@) macros; nor do you need to have dollar-sign or other delimiters around the equation. .P The output image will be clipped to the smallest possible bounding box -that contains all the black pixels. Older versions of +that contains all the black pixels. +Older versions of .BR convert (1) will produce a black-on-white graphic; newer ones may produce a black-on-transparent graphic. @@ -54,7 +57,9 @@ and the ImageMagick .BR convert (1) program. These programs must be installed on your system and accessible on your -$PATH for \fBeqn2graph\fR to work. +$PATH for +.B eqn2graph +to work. . . .SH OPTIONS @@ -114,9 +119,13 @@ For this version of .B eqn2graph you will need a version of .BR convert (1) -that supports the \fB-trim\fR option; older versions of +that supports the +.B \-trim +option; older versions of .B eqn2graph -used \fB-crop 0x0\fR, which no longer has trimming behavior. +used +.BR \-crop\~0x0 , +which no longer has trimming behavior. . . .SH "SEE ALSO" diff --git a/contrib/pic2graph/pic2graph.man b/contrib/pic2graph/pic2graph.man index 4d7e83f9..7cfcae20 100644 --- a/contrib/pic2graph/pic2graph.man +++ b/contrib/pic2graph/pic2graph.man @@ -1,4 +1,4 @@ -.\" $Id: pic2graph.man,v 1.6 2008/09/29 00:53:29 esr Exp $ +.\" $Id: pic2graph.man,v 1.7 2008/09/29 21:55:15 wl Exp $ .\" This documentation is released to the public domain. .TH PIC2GRAPH @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" .IX pic2graph @@ -29,30 +29,34 @@ formulae. .P PIC is a rather expressive graphics minilanguage suitable for producing box-and-arrow diagrams of the kind frequently used in -technical papers and textbooks. The language is sufficiently flexible -to be quite useful for state charts, Petri-net diagrams, flow charts, -simple circuit schematics, jumper layouts, and other kinds of -illustration involving repetitive uses of simple geometric forms and -splines. Because PIC descriptions are procedural and object-based, -they are both compact and easy to modify. +technical papers and textbooks. +The language is sufficiently flexible to be quite useful for state +charts, Petri-net diagrams, flow charts, simple circuit schematics, +jumper layouts, and other kinds of illustration involving repetitive +uses of simple geometric forms and splines. +Because PIC descriptions are procedural and object-based, they are +both compact and easy to modify. .P -The PIC language is fully documented in "\fIMaking Pictures With GNU -PIC\fP", a document which is part of the +The PIC language is fully documented in +.IR "Making Pictures With GNU PIC" , +a document which is part of the .BR groff (@MAN1EXT@) distribution. .P -Your input PIC code should \fInot\fR be wrapped with the .PS and .PE macros -that normally guard it within +Your input PIC code should +.I not +be wrapped with the \&.PS and \&.PE macros that normally guard it within .BR groff (@MAN1EXT@) macros. .P The output image will be clipped to the smallest possible bounding box -that contains all the black pixels. Older versions of -.BR convert (1) +that contains all the black pixels. +Older versions of +.BR \%convert (1) will produce a black-on-white graphic; newer ones may produce a black-on-transparent graphic. By specifying command-line options to be passed to -.BR convert (1) +.BR \%convert (1) you can give it a border, force the background transparent, set the image's pixel density, or perform other useful transformations. .P @@ -62,10 +66,12 @@ This program uses .BR groff (@MAN1EXT@), .BR gs (1), and the ImageMagick -.BR convert (1) +.BR \%convert (1) program. These programs must be installed on your system and accessible on your -$PATH for \fBpic2graph\fR to work. +$PATH for +.B pic2graph +to work. . . .SH OPTIONS @@ -77,12 +83,13 @@ and .BR groff (@MAN1EXT@) in the `unsafe' mode enabling the PIC macro .B sh -to execute arbitrary commands. The default is to forbid this. +to execute arbitrary commands. +The default is to forbid this. .TP .BI \-format\ fmt Specify an output format; the default is PNG (Portable Network Graphics). Any format that -.BR convert (1) +.BR \%convert (1) can emit is supported. .TP .BI \-eqn\ delim @@ -92,13 +99,14 @@ directives .RB ( $ and .BR $ , -by default). This option requires an argument, but an empty string is +by default). +This option requires an argument, but an empty string is accepted as a directive to disable .BR @g@eqn (@MAN1EXT@) processing. .PP Command-line switches and arguments not listed above are passed to -.BR convert (1). +.BR \%convert (1). . . .SH FILES @@ -127,20 +135,24 @@ Otherwise, temporary files will be created in . .SH BUGS Due to changes in the behavior of ImageMagick -.BR convert (1) +.BR \%convert (1) that are both forward and backward-incompatible, mismatches between your .B pic2graph and -.BR convert (1) +.BR \%convert (1) versions may produce zero-sized or untrimmed output images. For this version of .B pic2graph you will need a version of -.BR convert (1) -that supports the \fB-trim\fR option; older versions of +.BR \%convert (1) +that supports the +.B \-trim +option; older versions of .B pic2graph -used \fB-crop 0x0\fR, which no longer has trimming behavior. +used +.BR \-crop\~0x0 , +which no longer has trimming behavior. . . .SH "SEE ALSO" @@ -150,7 +162,7 @@ used \fB-crop 0x0\fR, which no longer has trimming behavior. .BR @g@eqn (@MAN1EXT@), .BR groff (@MAN1EXT@), .BR gs (1), -.BR convert (1). +.BR \%convert (1). . . .SH AUTHOR |