summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-leap-15-6/man1/pic2graph.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/opensuse-leap-15-6/man1/pic2graph.1')
-rw-r--r--upstream/opensuse-leap-15-6/man1/pic2graph.1204
1 files changed, 204 insertions, 0 deletions
diff --git a/upstream/opensuse-leap-15-6/man1/pic2graph.1 b/upstream/opensuse-leap-15-6/man1/pic2graph.1
new file mode 100644
index 00000000..ce1a21f4
--- /dev/null
+++ b/upstream/opensuse-leap-15-6/man1/pic2graph.1
@@ -0,0 +1,204 @@
+.TH PIC2GRAPH 1 "7 February 2022" "groff 1.22.4"
+.SH NAME
+pic2graph \- convert a PIC diagram into a cropped image
+.
+.
+.\" ====================================================================
+.\" Legal Terms
+.\" ====================================================================
+.\"
+.\" This documentation is released to the public domain.
+.
+.
+.\" ====================================================================
+.SH SYNOPSIS
+.\" ====================================================================
+.
+.SY pic2graph
+.OP \-unsafe
+.OP \-format output-format
+.OP \-eqn delimiters
+.RI [ convert-arguments ]
+.YS
+.
+.SY pic2graph
+.B \-\-help
+.YS
+.
+.SY pic2graph
+.B \-v
+.SY pic2graph
+.B \-\-version
+.YS
+.
+.
+.\" ====================================================================
+.SH DESCRIPTION
+.\" ====================================================================
+.
+.I pic2graph
+reads a
+.IR pic (1)
+program from the standard input and writes an image file,
+by default in Portable Network Graphics (PNG) format,
+to the standard output.
+.
+It furthermore translates
+.IR eqn (1)
+constructs, so it can be used for generating images of mathematical
+formulae.
+.
+.
+.PP
+The input PIC code should
+.I not
+be wrapped with the
+.B \&.PS
+and
+.B \&.PE
+macros that normally guard it within
+.IR groff (1)
+documents.
+.
+.
+.\" FIXME: How old? This text hasn't been touched since 2008 at latest.
+.\" Older versions of
+.\" .I \%convert
+.\" will produce a black-on-white graphic; newer ones may produce a
+.\" black-on-transparent graphic.
+.
+.PP
+Arguments not recognized by
+.I pic2graph
+are passed to the ImageMagick or GraphicsMagick program
+.IR \%convert (1).
+.
+.
+By specifying these, you can give your image a border,
+.\" Transparent backgrounds are the default in 2018.
+.\" force the background transparent,
+set the image's pixel density,
+or perform other useful transformations.
+.
+.
+.PP
+The output image is clipped using
+.IR \%convert 's
+.B \-trim
+option to the smallest possible bounding box that contains all the black
+pixels.
+.
+.
+.\" ====================================================================
+.SH OPTIONS
+.\" ====================================================================
+.
+.TP
+.BI "\-eqn " delimiters
+Use
+.I delimiters
+as the opening and closing
+characters that delimit
+.I eqn
+directives;
+the default is \(lq$$\(rq.
+.
+The option argument
+.I delimiters
+should be a two-character string,
+but an empty string (\(dq\(dq) is accepted as a directive to disable
+.I eqn
+processing.
+.
+.
+.TP
+.BI "\-format " output-format
+Write the image in
+.IR output-format ,
+which must be understood by
+.IR \%convert ;
+the default is PNG.
+.
+.
+.TP
+.B \-\-help
+Display a usage message and exit.
+.
+.
+.TP
+.B \-unsafe
+Run
+.I groff
+in
+.I unsafe
+mode, enabling the PIC command
+.B sh
+to execute arbitrary Unix shell commands.
+.
+The
+.I groff
+default is to forbid this.
+.
+.
+.TP
+.B \-v
+.TQ
+.B \-\-version
+Display version information and exit.
+.
+.
+.\" ====================================================================
+.SH ENVIRONMENT
+.\" ====================================================================
+.
+.TP
+.I \%GROFF_TMPDIR
+.TQ
+.I \%TMPDIR
+.TQ
+.I TMP
+.TQ
+.I TEMP
+These environment variables are searched in the given order to determine
+the directory where temporary files will be created.
+.
+If none are set,
+.I /tmp
+is used.
+.
+.
+.\" ====================================================================
+.SH AUTHORS
+.\" ====================================================================
+.
+.I pic2graph
+was written by
+.MT esr@\:thyrsus.com
+Eric S.\& Raymond
+.ME ,
+based on a recipe by W.\& Richard Stevens.
+.
+.
+.\" ====================================================================
+.SH "SEE ALSO"
+.\" ====================================================================
+.
+W.\& Richard Stevens,
+.UR http://\:www.kohala.com/\:start/\:troff/\:pic2html.html
+.I Turning PIC into HTML
+.UE
+.
+.
+.PP
+.IR eqn2graph (1),
+.IR grap2graph (1),
+.IR pic (1),
+.IR eqn (1),
+.IR groff (1),
+.IR \%convert (1)
+.
+.
+.\" Local Variables:
+.\" mode: nroff
+.\" End:
+.\" vim: set filetype=groff: