summaryrefslogtreecommitdiff
path: root/apps
diff options
context:
space:
mode:
authorTor Andersson <tor@ghostscript.com>2011-03-09 15:59:08 +0000
committerTor Andersson <tor@ghostscript.com>2011-03-09 15:59:08 +0000
commit0f5f8c4db58b8d9a3972790606d0c7dc5fb2c62a (patch)
tree4eea980a277ef8ec5c1ffcf534e6797ee2bdb9c4 /apps
parent269adfe6d110f4e74e031a59c6d5c477288df351 (diff)
downloadmupdf-0f5f8c4db58b8d9a3972790606d0c7dc5fb2c62a.tar.xz
Move manpages out from debian into apps/man, and install them when running make install.
Diffstat (limited to 'apps')
-rw-r--r--apps/man/mupdf.186
-rw-r--r--apps/man/pdfclean.135
-rw-r--r--apps/man/pdfdraw.168
-rw-r--r--apps/man/pdfshow.142
4 files changed, 231 insertions, 0 deletions
diff --git a/apps/man/mupdf.1 b/apps/man/mupdf.1
new file mode 100644
index 00000000..a4162a6f
--- /dev/null
+++ b/apps/man/mupdf.1
@@ -0,0 +1,86 @@
+.TH MUPDF 1 "March 15, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+mupdf \- MuPDF is a lightweight PDF viewer written in portable C
+.SH SYNOPSIS
+.B mupdf
+.RI [ options ] " PDFfile"
+.SH DESCRIPTION
+This manual page briefly describes the
+.B mupdf
+command.
+.PP
+.SH OPTIONS
+A description of each of the supported options is included below.
+.TP
+.B \-p password
+Uses the given password to open an encrypted PDF file.
+The password is tried both as user and owner password.
+.TP
+.B \-r resolution
+Changes the initial zoom level, specified as the resolution in dpi.
+The default value is 72.
+.SH MOUSE AND KEY BINDINGS
+In addition to the key bindings described below, the mouse can also be
+used. Clicking the left mouse button follows links within the PDF while
+dragging with the left mouse button pans the page. Dragging with the right
+mouse button selects an area and copies the enclosed text to the clipboard
+buffer. Using the scroll-wheel while pressing Control zooms in/out, if
+Shift is pressed on the other hand then the page is panned.
+.TP
+.B L, R
+Rotate page left (clockwise) or right (counter-clockwise).
+.TP
+.B h, j, k, l
+Scroll page left, down, up, or right.
+.TP
+.B \+, \-
+Zoom in or out.
+.TP
+.B w
+Shrinkwrap window to fit the page.
+.TP
+.B r
+Reload file.
+.TP
+.B . pgdn right space
+Go to the next page
+.TP
+.B , pgup left b
+Go to the previous page
+.TP
+.B <, >
+Skip back/forth 10 pages at a time.
+.TP
+.B m
+Mark page for snap back.
+.TP
+.B t
+Pop back to the latest mark.
+.TP
+.B [0-9]m
+Save the current page number in the numbered register.
+.TP
+.B [0-9]t
+Go to the page saved in the numbered register.
+.TP
+.B 123g
+Go to page 123.
+.TP
+.B /
+Search for text.
+.TP
+.B n, N
+Find the next/previous search result.
+.TP
+.B c
+Toggle between color and grayscale rendering.
+.SH SEE ALSO
+.BR pdfclean (1),
+.BR pdfdraw (1),
+.BR pdfshow (1).
+.SH AUTHOR
+MuPDF was written by Tor Andersson <tor@ghostscript.com>.
+MuPDF is Copyright 2006-2010 Artifex Software, Inc.
+.PP
+This manual page was written by Sebastian Rasmussen <sebras@hotmail.com>.
diff --git a/apps/man/pdfclean.1 b/apps/man/pdfclean.1
new file mode 100644
index 00000000..aec6f0f3
--- /dev/null
+++ b/apps/man/pdfclean.1
@@ -0,0 +1,35 @@
+.TH PDFCLEAN 1 "July 19, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+pdfclean \- pretty print, decompress and garbage collect PDF files
+.SH SYNOPSIS
+.B pdfclean
+.RI [ options ]
+.RI input.pdf
+.RI [ output.pdf ]
+.SH DESCRIPTION
+.B pdfclean
+pretty prints and rewrites the contents of a PDF file.
+If no output file is specified, the new file will be written to "out.pdf" in
+the current directory.
+.PP
+.SH OPTIONS
+.TP
+.B \-p password
+Use the specified password if the file is encrypted.
+.TP
+.B \-g
+Garbage collect objects that have no references from other objects.
+Give the option twice to renumber all objects and compact the cross reference table.
+Give it three times to merge and reuse duplicate objects.
+.TP
+.B \-d
+Decompress streams. This will make the output file larger, but provides
+easy access for reading and editing the contents with a text editor.
+.SH SEE ALSO
+.BR mupdf (1),
+.BR pdfdraw (1).
+.BR pdfshow (1).
+.SH AUTHOR
+MuPDF was written by Tor Andersson <tor@ghostscript.com>.
+MuPDF is Copyright 2006-2010 Artifex Software, Inc.
diff --git a/apps/man/pdfdraw.1 b/apps/man/pdfdraw.1
new file mode 100644
index 00000000..67899640
--- /dev/null
+++ b/apps/man/pdfdraw.1
@@ -0,0 +1,68 @@
+.TH PDFDRAW 1 "July 19, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+pdfdraw \- render PDF documents
+.SH SYNOPSIS
+.B pdfdraw
+.RI [ options ]
+.RI [ file.pdf\ [ pages ] ]
+.B ...
+.SH DESCRIPTION
+.B pdfdraw
+will render a PDF document to image files.
+The supported image formats are: pgm, ppm, pam and png.
+Select the pages to be rendered by specifying a comma
+separated list of ranges and individual page numbers (for example: 1,5,10-15).
+In no pages are specified all the pages will be rendered.
+.SH OPTIONS
+.TP
+.B \-o output
+The image format is deduced from the output file name.
+Embed %d in the name to indicate the page number (for example: "page%d.png").
+.TP
+.B \-p password
+Use the specified password if the file is encrypted.
+.TP
+.B \-r resolution
+Render the page at the specified resolution.
+The default resolution is 72 dpi.
+.TP
+.B \-R angle
+Rotate clockwise by given number of degrees.
+.TP
+.B \-a
+Save the alpha channel.
+The default behavior is to render each page with a white background.
+With this option, the page background is transparent.
+Only supported for pam and png output formats.
+.TP
+.B \-g
+Render in grayscale.
+The default is to render a full color RGB image.
+If the output format is pgm or ppm this option is ignored.
+.TP
+.B \-m
+Show timing information.
+Take the time it takes for each page to render and print
+a summary at the end.
+.TP
+.B \-5
+Print an MD5 checksum of the rendered image data for each page.
+.TP
+.B \-t
+Print the text contents of each page in UTF-8 encoding.
+Give the option twice to print detailed information
+about the location of each character in XML format.
+.TP
+.B \-x
+Print the display list used to render each page.
+.TP
+.B \-A
+Disable the use of accelerated functions.
+.SH SEE ALSO
+.BR mupdf (1),
+.BR pdfclean (1).
+.BR pdfshow (1).
+.SH AUTHOR
+MuPDF was written by Tor Andersson <tor@ghostscript.com>.
+MuPDF is Copyright 2006-2010 Artifex Software, Inc.
diff --git a/apps/man/pdfshow.1 b/apps/man/pdfshow.1
new file mode 100644
index 00000000..7574f297
--- /dev/null
+++ b/apps/man/pdfshow.1
@@ -0,0 +1,42 @@
+.TH PDFSHOW 1 "July 19, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+pdfshow \- show objects and streams that make up a PDF document
+.SH SYNOPSIS
+.B pdfshow
+.RI [ options ]
+.RI file.pdf
+.RI [ xref ]
+.RI [ trailer ]
+.RI [ pages ]
+.RI [ grep ]
+.RI [ object-number... ]
+.SH DESCRIPTION
+.B pdfshow
+pretty prints the objects and streams specified on the command line.
+Streams are decoded and non-printable characters are represented
+with a period.
+Specify objects with their number.
+The special names xref, trailer and pages will
+respectively print the cross reference, trailer,
+and the object numbers for all pages.
+The special name grep will print all objects in the file
+in a compact one-line format suitable for piping to grep.
+.PP
+.SH OPTIONS
+.TP
+.B \-b
+Print streams as binary data and omit the object header.
+.TP
+.B \-e
+Print streams in their original encoded form.
+.TP
+.B \-p password
+Use the specified password if the file is encrypted.
+.SH SEE ALSO
+.BR mupdf (1),
+.BR pdfclean (1).
+.BR pdfdraw (1).
+.SH AUTHOR
+MuPDF was written by Tor Andersson <tor@ghostscript.com>.
+MuPDF is copyright 2006-2010 Artifex Software, Inc.