summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/pamexec.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man1/pamexec.1')
-rw-r--r--upstream/debian-unstable/man1/pamexec.1130
1 files changed, 130 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man1/pamexec.1 b/upstream/debian-unstable/man1/pamexec.1
new file mode 100644
index 00000000..7fe54f55
--- /dev/null
+++ b/upstream/debian-unstable/man1/pamexec.1
@@ -0,0 +1,130 @@
+\
+.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
+.\" Do not hand-hack it! If you have bug fixes or improvements, please find
+.\" the corresponding HTML page on the Netpbm website, generate a patch
+.\" against that, and send it to the Netpbm maintainer.
+.TH "Pamexec User Manual" 1 "21 December 2021" "netpbm documentation"
+
+.SH NAME
+pamexec - Execute a shell command on each image in a Netpbm image stream
+
+.UN synopsis
+.SH SYNOPSIS
+
+\fBpamexec\fP
+
+["\fIcommand\fP"]
+
+[\fInetpbmfile\fP]
+
+[\fB-check\fP]
+.PP
+Minimum unique abbreviation of option is acceptable. You may use double
+hyphens instead of single hyphen to denote options. You may use white
+space in place of the equals sign to separate an option name from its value.
+
+
+.UN description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBpamexec\fP reads a Netpbm image stream as input. For each image, it
+runs a specified shell command and supplies the image to it as Standard
+Input (with a pipe).
+.PP
+\fInetpbmfile\fP is the file name of the input file, or
+\fB-\fP to indicate Standard Input. The default is Standard Input.
+.PP
+Many Netpbm programs understand multimage Netpbm streams themselves, so you
+don't need to use \fBpamexec\fP to run the program on the images in the
+stream. Ideally, all Netpbm programs would have that capability, but
+multi-image streams are a relatively recent invention, so older Netpbm
+programs just process the first image in the stream and then stop. Even many
+recently written Netpbm programs work that way, since the authors aren't aware
+of the multi-image possibility.
+.PP
+Another way to process a multi-image stream is to use \fBpamsplit\fP to
+explode it into multiple files, one image per file. You can then process
+those files.
+.PP
+To run your command on a subset of the images in the stream, use
+\fBpampick\fP to select the desired images from the input stream and pipe
+the result to \fBpamexec\fP.
+
+
+.UN options
+.SH OPTIONS
+.PP
+In addition to the options common to all programs based on libnetpbm
+(most notably \fB-quiet\fP, see
+.UR index.html#commonoptions
+ Common Options
+.UE
+\&), \fBpamexec\fP recognizes the following
+command line option:
+
+
+.TP
+\fB-check\fP
+This causes \fBpamexec\fP to exit without processing any further images
+if the command has a nonzero exit status.
+
+
+
+.UN applications
+.SH APPLICATIONS
+
+To make an animated GIF movie:
+
+.nf
+\f(CW
+ pamexec pamtogif myvideo.ppm | gifsicle --multifile >myvideo.gif
+\fP
+
+.fi
+
+.UN limitations
+.SH LIMITATIONS
+.PP
+\fBpamexec\fP assumes all commands consume all of Standard Input.
+If yours doesn't (perhaps it just exits when it's seen enough),
+ you can buffer through a temporary file like this, which copies the
+ first 3 lines of every image (the PPM header) to Standard Output:
+
+.nf
+\f(CW
+ pamexec "cat >/tmp/x; head --lines=3 x" myvideo.ppm
+\fP
+
+.fi
+
+.UN history
+.SH HISTORY
+.PP
+\fBpamexec\fP was new in Netpbm 10.56 (September 2011).
+.PP
+Michael Pot wrote it, borrowing from \fBpamsplit\fP.
+
+
+.UN seealso
+.SH SEE ALSO
+.BR "pamfile" (1)\c
+\&,
+.BR "pampick" (1)\c
+\&,
+.BR "pamsplit" (1)\c
+\&,
+.BR "pnm" (1)\c
+\&,
+.BR "pam" (1)\c
+\&,
+\fBcat\fP man page
+.SH DOCUMENT SOURCE
+This manual page was generated by the Netpbm tool 'makeman' from HTML
+source. The master documentation is at
+.IP
+.B http://netpbm.sourceforge.net/doc/pamexec.html
+.PP \ No newline at end of file