GraphicsMagick: Something wrong with documentation generation. ...
GraphicsMagick Commits <[email protected]>
| Newsgroups | gmane.comp.video.graphicsmagick.cvs |
|---|---|
| Message-ID | <mailman.46941.1640914073.1346.graphicsmagick-commit@lists.sourceforge.net> |
changeset 9dd4673e32d9 in /hg/GraphicsMagick
details: http://hg.GraphicsMagick.org/hg/GraphicsMagick?cmd=changeset;node=9dd4673e32d9
summary: Something wrong with documentation generation. Restore partially ok.
diffstat:
utilities/gm.1 | 11670 ++++++++++++++++----------------
www/GraphicsMagick.html | 14 +-
www/animate.html | 14 +-
www/batch.html | 4 +-
www/benchmark.html | 4 +-
www/compare.html | 4 +-
www/composite.html | 4 +-
www/conjure.html | 4 +-
www/convert.html | 6 +-
www/display.html | 48 +-
www/gm.html | 16164 +++++++++++++++++++++++-----------------------
www/identify.html | 4 +-
www/import.html | 4 +-
www/mogrify.html | 6 +-
www/montage.html | 8 +-
www/time.html | 4 +-
www/version.html | 4 +-
17 files changed, 13983 insertions(+), 13983 deletions(-)
diffs (truncated from 30667 to 500 lines):
diff -r 216c7dabe522 -r 9dd4673e32d9 utilities/gm.1
--- a/utilities/gm.1 Thu Dec 30 18:56:48 2021 -0600
+++ b/utilities/gm.1 Thu Dec 30 19:27:37 2021 -0600
@@ -1,19 +1,5118 @@
.TH gm 1 "2021/12/30" "GraphicsMagick"
+.TP
+.in 15
+.in 15
+.in 20
+.SH NAME
+\'
+gm - command-line utility to create, edit, compare, convert, or display images
+\'
+.SH SYNOPSIS
+\'
+\fBgm animate\fP \fB[\fP \fIoptions ...\fP \fB]\fP \fIfile\fP \fB[ [\fP
+\fIoptions ...\fP \fB]\fP \fIfile ...\fP \fB]\fP
+\'
+\fBgm batch\fP \fB[\fP \fIoptions ...\fP \fB]\fP \fB[\fP \fIscript\fP \fB]\fP
+\'
+\fBgm benchmark\fP \fB[\fP \fIoptions ...\fP \fB]\fP subcommand
+\'
+\fBgm compare\fP \fB[\fP \fIoptions\fP \fB... ]\fP \fIreference-image\fP
+\fB[\fP \fIoptions\fP \fB... ]\fP \fIcompare-image\fP
+\fB[\fP \fIoptions\fP \fB... ]\fP
+\'
+\fBgm composite\fP \fB[\fP \fIoptions ...\fP \fB]\fP \fIchange-image base-image\fP
+\fB[\fP \fImask-image\fP \fB]\fP \fIoutput-image\fP
+\'
+\fBgm conjure\fP \fB[\fP \fIoptions\fP \fB]\fP \fIscript.msl\fP
+\fB[ [\fP \fIoptions\fP \fB]\fP \fIscript.msl\fP \fB]\fP
+\'
+\fBgm convert\fP \fB[ [\fP \fIoptions ...\fP \fB] [\fP \fIinput-file ...\fP
+\fB] [\fP \fIoptions ...\fP \fB] ]\fP \fIoutput-file\fP
+\'
+\fBgm display\fP \fB[\fP \fIoptions ...\fP \fB]\fP \fIfile ...\fP
+\fB[ [\fP\fIoptions ...\fP \fB]\fP\fIfile ...\fP \fB]\fP
+\'
+\fBgm identify\fP \fIfile\fP \fB[\fP \fIfile ...\fP \fB]\fP
+\'
+\fBgm import\fP \fB[\fP \fIoptions ...\fP \fB]\fP \fIfile\fP
+\'
+\fBgm mogrify\fP \fB[\fP \fIoptions ...\fP \fB]\fP \fIfile ...\fP
+\'
+\fBgm montage\fP \fB[\fP \fIoptions ...\fP \fB]\fP \fIfile\fP \fB[ [\fP
+\fIoptions ...\fP \fB]\fP \fIfile ...\fP \fB]\fP \fIoutput-file\fP
+\'
+\fBgm time\fP subcommand
+\'
+\fBgm version\fP
+.SH DESCRIPTION
+\'
+GraphicsMagick's \fBgm\fP provides a suite of utilities for creating,
+comparing, converting, editing, and displaying images. All of the
+utilities are provided as sub-commands of a single \fBgm\fP
+executable. The \fBgm\fP executable returns the exit code 0 to
+indicate success, or 1 to indicate failure:
+\'
+\fBanimate\fP
+displays an animation (e.g. a GIF file) on any workstation display
+running an \fIX\fP server.
+\'
+\fBbatch\fP
+executes an arbitary number of the utility commands
+(e.g. \fBconvert\fP) in the form of a simple linear batch script in
+order to improve execution efficiency, and/or to allow use as a
+subordinate co-process under the control of an arbitrary script or
+program.
+\'
+\fBbenchmark\fP
+executes one of the other utility commands (e.g. \fBconvert\fP) for a
+specified number of iterations, or execution time, and reports
+execution time and other profiling information such as CPU
+utilization. \fBBenchmark\fP provides various operating modes
+including executing the command with a varying number of threads, and
+alternate reporting formats such as comma-separated value (CSV).
+\'
+\fBcompare\fP
+compares two images and reports difference statistics according to
+specified metrics and/or outputs an image with a visual representation
+of the differences. It may also be used to test if images are similar
+within a particular range and specified metric, returning a truth
+value to the executing environment.
+\'
+\fBcomposite\fP
+composites images (blends or merges images together) to create new images.
+\'
+\fBconjure\fP
+interprets and executes scripts in
+the Magick Scripting Language (MSL).
+\'
+\fBconvert\fP
+converts an input file using one image format to an output file with
+the same or differing image format while applying an arbitrary number
+of image transformations.
+\'
+\fBdisplay\fP
+is a machine architecture independent image processing and display
+facility. It can display an image on any workstation display running
+an \fIX\fP server.
+\'
+\fBidentify\fP
+describes the format and characteristics of one or more image
+files. It will also report if an image is incomplete or corrupt.
+\'
+\fBimport\fP
+reads an image from any visible window on an \fIX\fP server and
+outputs it as an image file. You can capture a single window, the
+entire screen, or any rectangular portion of the screen.
+\'
+\fBmogrify\fP
+transforms an image or a sequence of images. These transforms include
+\fBimage scaling\fP, \fBimage rotation\fP, \fBcolor reduction\fP,
+and others. The transmogrified image \fBoverwrites\fP the original
+image.
+\'
+\fBmontage\fP
+creates a composite by combining several separate images. The images
+are tiled on the composite image with the name of the image optionally
+appearing just below the individual tile.
+\'
+\fBtime\fP
+executes a subcommand and reports the user, system, and total
+execution time consumed.
+\'
+\fBversion\fP
+reports the GraphicsMagick release version, maximum sample-depth,
+copyright notice, supported features, and the options used while
+building the software.
+\'
+The \fBGraphicsMagick\fP utilities recognize the following image formats:
+\'
+\'
+\fBName\fP \fBMode\fP \fBDescription\fP
+ o 3FR r-- Hasselblad Photo RAW
+ o 8BIM rw- Photoshop resource format
+ o 8BIMTEXT rw- Photoshop resource text format
+ o 8BIMWTEXT rw- Photoshop resource wide text format
+ o APP1 rw- Raw application information
+ o APP1JPEG rw- Raw JPEG binary data
+ o ART r-- PF1: 1st Publisher
+ o ARW r-- Sony Alpha DSLR RAW
+ o AVS rw+ AVS X image
+ o BIE rw- Joint Bi-level Image experts Group
+ interchange format
+ o BMP rw+ Microsoft Windows bitmap image
+ o BMP2 -w- Microsoft Windows bitmap image v2
+ o BMP3 -w- Microsoft Windows bitmap image v3
+ o CACHE --- Magick Persistent Cache image format
+ o CALS rw- Continuous Acquisition and Life-cycle
+ Support Type 1 image
+ o CAPTION r-- Caption (requires separate size info)
+ o CIN rw- Kodak Cineon Format
+ o CMYK rw- Raw cyan, magenta, yellow, and black
+ samples (8 or 16 bits, depending on
+ the image depth)
+ o CMYKA rw- Raw cyan, magenta, yellow, black, and
+ matte samples (8 or 16 bits, depending
+ on the image depth)
+ o CR2 r-- Canon Photo RAW
+ o CRW r-- Canon Photo RAW
+ o CUR r-- Microsoft Cursor Icon
+ o CUT r-- DR Halo
+ o DCM r-- Digital Imaging and Communications in
+ Medicine image
+ o DCR r-- Kodak Photo RAW
+ o DCX rw+ ZSoft IBM PC multi-page Paintbrush
+ o DNG r-- Adobe Digital Negative
+ o DPS r-- Display PostScript Interpreter
+ o DPX rw- Digital Moving Picture Exchange
+ o EPDF rw- Encapsulated Portable Document Format
+ o EPI rw- Adobe Encapsulated PostScript
+ Interchange format
+ o EPS rw- Adobe Encapsulated PostScript
+ o EPS2 -w- Adobe Level II Encapsulated PostScript
+ o EPS3 -w- Adobe Level III Encapsulated PostScript
+ o EPSF rw- Adobe Encapsulated PostScript
+ o EPSI rw- Adobe Encapsulated PostScript
+ Interchange format
+ o EPT rw- Adobe Encapsulated PostScript with MS-DOS
+ TIFF preview
+ o EPT2 rw- Adobe Level II Encapsulated PostScript
+ with MS-DOS TIFF preview
+ o EPT3 rw- Adobe Level III Encapsulated PostScript
+ with MS-DOS TIFF preview
+ o EXIF rw- Exif digital camera binary data
+ o FAX rw+ Group 3 FAX (Not TIFF Group3 FAX!)
+ o FITS rw- Flexible Image Transport System
+ o FRACTAL r-- Plasma fractal image
+ o FPX rw- FlashPix Format
+ o GIF rw+ CompuServe graphics interchange format
+ o GIF87 rw- CompuServe graphics interchange format
+ (version 87a)
+ o GRADIENT r-- Gradual passing from one shade to
+ another
+ o GRAY rw+ Raw gray samples (8/16/32 bits,
+ depending on the image depth)
+ o HISTOGRAM -w- Histogram of the image
+ o HRZ r-- HRZ: Slow scan TV
+ o HTML -w- Hypertext Markup Language and a
+ client-side image map
+ o ICB rw+ Truevision Targa image
+ o ICC rw- ICC Color Profile
+ o ICM rw- ICC Color Profile
+ o ICO r-- Microsoft icon
+ o ICON r-- Microsoft icon
+ o IDENTITY r-- Hald CLUT identity image
+ o IMAGE r-- GraphicsMagick Embedded Image
+ o INFO -w+ Image descriptive information and
+ statistics
+ o IPTC rw- IPTC Newsphoto
+ o IPTCTEXT rw- IPTC Newsphoto text format
+ o IPTCWTEXT rw- IPTC Newsphoto wide text format
+ o JBG rw+ Joint Bi-level Image experts Group
+ interchange format
+ o JBIG rw+ Joint Bi-level Image experts Group
+ interchange format
+ o JNG rw- JPEG Network Graphics
+ o JP2 rw- JPEG-2000 JP2 File Format Syntax
+ o JPC rw- JPEG-2000 Code Stream Syntax
+ o JPEG rw- Joint Photographic Experts Group
+ JFIF format
+ o JPG rw- Joint Photographic Experts Group
+ JFIF format
+ o K25 r-- Kodak Photo RAW
+ o KDC r-- Kodak Photo RAW
+ o LABEL r-- Text image format
+ o M2V rw+ MPEG-2 Video Stream
+ o MAP rw- Colormap intensities and indices
+ o MAT r-- MATLAB image format
+ o MATTE -w+ MATTE format
+ o MIFF rw+ Magick Image File Format
+ o MNG rw+ Multiple-image Network Graphics
+ o MONO rw- Bi-level bitmap in least-significant-
+ -byte-first order
+ o MPC rw+ Magick Persistent Cache image format
+ o MPEG rw+ MPEG-1 Video Stream
+ o MPG rw+ MPEG-1 Video Stream
+ o MRW r-- Minolta Photo Raw
+ o MSL r-- Magick Scripting Language
+ o MTV rw+ MTV Raytracing image format
+ o MVG rw- Magick Vector Graphics
+ o NEF r-- Nikon Electronic Format
+ o NULL r-- Constant image of uniform color
+ o OTB rw- On-the-air bitmap
+ o P7 rw+ Xv thumbnail format
+ o PAL rw- 16bit/pixel interleaved YUV
+ o PALM rw- Palm Pixmap
+ o PBM rw+ Portable bitmap format (black and white)
+ o PCD rw- Photo CD
+ o PCDS rw- Photo CD
+ o PCL -w- Page Control Language
+ o PCT rw- Apple Macintosh QuickDraw/PICT
+ o PCX rw- ZSoft IBM PC Paintbrush
+ o PDB rw+ Palm Database ImageViewer Format
+ o PDF rw+ Portable Document Format
+ o PEF r-- Pentax Electronic File
+ o PFA r-- TrueType font
+ o PFB r-- TrueType font
+ o PGM rw+ Portable graymap format (gray scale)
+ o PGX r-- JPEG-2000 VM Format
+ o PICON rw- Personal Icon
+ o PICT rw- Apple Macintosh QuickDraw/PICT
+ o PIX r-- Alias/Wavefront RLE image format
+ o PLASMA r-- Plasma fractal image
+ o PNG rw- Portable Network Graphics
+ o PNG24 rw- Portable Network Graphics, 24 bit RGB
+ opaque only
+ o PNG32 rw- Portable Network Graphics, 32 bit RGBA
+ semitransparency OK
+ o PNG8 rw- Portable Network Graphics, 8-bit
+ indexed, binary transparency only
+ o PNM rw+ Portable anymap
+ o PPM rw+ Portable pixmap format (color)
+ o PREVIEW -w- Show a preview an image enhancement,
+ effect, or f/x
+ o PS rw+ Adobe PostScript
+ o PS2 -w+ Adobe Level II PostScript
+ o PS3 -w+ Adobe Level III PostScript
+ o PSD rw- Adobe Photoshop bitmap
+ o PTIF rw- Pyramid encoded TIFF
+ o PWP r-- Seattle Film Works
+ o RAF r-- Fuji Photo RAW
+ o RAS rw+ SUN Rasterfile
+ o RGB rw+ Raw red, green, and blue samples
+ o RGBA rw+ Raw red, green, blue, and matte samples
+ o RLA r-- Alias/Wavefront image
+ o RLE r-- Utah Run length encoded image
+ o SCT r-- Scitex HandShake
+ o SFW r-- Seattle Film Works
+ o SGI rw+ Irix RGB image
+ o SHTML -w- Hypertext Markup Language and a
+ client-side image map
+ o STEGANO r-- Steganographic image
+ o SUN rw+ SUN Rasterfile
+ o SVG rw+ Scalable Vector Gaphics
+ o TEXT rw+ Raw text
+ o TGA rw+ Truevision Targa image
+ o TIFF rw+ Tagged Image File Format
+ o TILE r-- Tile image with a texture
+ o TIM r-- PSX TIM
+ o TOPOL r-- TOPOL X Image
+ o TTF r-- TrueType font
+ o TXT rw+ Raw text
+ o UIL -w- X-Motif UIL table
+ o UYVY rw- 16bit/pixel interleaved YUV
+ o VDA rw+ Truevision Targa image
+ o VICAR rw- VICAR rasterfile format
+ o VID rw+ Visual Image Directory
+ o VIFF rw+ Khoros Visualization image
+ o VST rw+ Truevision Targa image
+ o WBMP rw- Wireless Bitmap (level 0) image
+ o WMF r-- Windows Metafile
+ o WPG r-- Word Perfect Graphics
+ o X rw- X Image
+ o X3F r-- Foveon X3 (Sigma/Polaroid) RAW
+ o XBM rw- X Windows system bitmap (black
+ and white)
+ o XC r-- Constant image uniform color
+ o XCF r-- GIMP image
+ o XMP rw- Adobe XML metadata
+ o XPM rw- X Windows system pixmap (color)
+ o XV rw+ Khoros Visualization image
+ o XWD rw- X Windows system window dump (color)
+ o YUV rw- CCIR 601 4:1:1 or 4:2:2 (8-bit only)
+
+ Modes:
+ r Read
+ w Write
+ + Multi-image
+\'
+\'
+\fISupport for some of these formats require additional programs or libraries.
+See README
+in the source package for where to find optional additional software\fP.
+\'
+Note, a format delineated with + means that if more than one
+image is specified, frames are combined into a single multi-image
+file. Use \fB+adjoin\fP if you want a single image produced for each
+frame.
+\'
+Your installation might not support all of the formats in the list.
+To get an accurate listing of the formats supported by your particular
+configuration, run "gm convert -list format".
+\'
+Raw images are expected to have one byte per pixel unless \fBgm\fP is
+compiled in 16-bit quantum mode or in 32-bit quantum mode. Here, the
+raw data is expected to be stored two or four bytes per pixel,
+respectively, in most-significant-byte-first order. For example, you
+can tell if \fBgm\fP was compiled in 16-bit mode by typing "gm
+version" without any options, and looking for "Q:16" in the first line
+of output.
+.SH FILES AND FORMATS
+\'
+By default, the image format is determined by its magic number, i.e., the
+first few bytes of the file. To specify
+a particular image format, precede the filename with an image format name
+and a colon (\fIi.e.\fP\fBps:image\fP) or specify the image type as the
+filename suffix (\fIi.e.\fP\fBimage.ps\fP).
+The magic number takes precedence over the filename suffix
+and the prefix takes precedence over the magic number and the suffix
+in input files.
+When a file is read, its magic number is stored in the "image->magick"
+string.
+In output files, the prefix takes precedence over the filename suffix,
+and the filename suffix takes precedence over the
+"image->magick" string.
+\'
+To read the "built-in" formats (GRANITE, H, LOGO,
+NETSCAPE, PLASMA, and ROSE) use a prefix (including the colon) without a
+filename or suffix. To read the XC format, follow the colon with a color
+specification. To read the CAPTION format, follow the colon with a text
+string or with a filename prefixed with the at symbol (\fB@\fP).
+\'
+\'
+When you specify \fBX\fP as your image type, the filename has special
+meaning. It specifies an X window by \fBid, name\fP, or
+\fBroot\fP. If
+no filename is specified, the window is selected by clicking the mouse
+in the desired window.
+\'
+Specify \fIinput_file\fP as \fB-\fP for standard input,
+\fIoutput_file\fP as \fB-\fP for standard output.
+If \fIinput_file\fP has the extension \fB.Z\fP or \fB.gz\fP, the
+file is uncompressed with \fBuncompress\fP or \fBgunzip\fP
+respectively.
+If \fIoutput_file\fP has the extension \fB.Z\fP or \fB.gz\fP,
+the file is compressed using with \fIcompress\fP or \fIgzip\fP respectively.
+\'
+Use an optional index enclosed in brackets after an input file name to
+specify a desired subimage of a multi-resolution image format like
+Photo CD (e.g. "img0001.pcd[4]") or a range for MPEG images
+(e.g. "video.mpg[50-75]"). A subimage specification can be
+disjoint (e.g. "image.tiff[2,7,4]"). For raw images, specify
+a subimage with a geometry (e.g. -size 640x512
+"image.rgb[320x256+50+50]"). Surround the image name with
+quotation marks to prevent your shell from interpreting the square
+brackets. Single images are written with the filename you
+specify. However, multi-part images (e.g., a multi-page PostScript
+document with \fB+adjoin\fP specified) may be written with the scene
+number included as part of the filename. In order to include the scene
+number in the filename, it is necessary to include a printf-style
+%d format specification in the file name and use the +adjoin
+option. For example,
+\'
+ image%02d.miff
+\'
+\'
+writes files \fIimage00.miff, image01.miff,\fP etc. Only a single
+specification is allowed within an output filename. If more than one
+specification is present, it will be ignored. It is best to embed the
+scene number in the base part of the file name, not in the extension,
+because the extension will not be a recognizeable image type.
+\'
+When running a commandline utility, you can
+prepend an at sign @ to a filename to read a list of image
+filenames from that file. This is convenient in the event you have too
+many image filenames to fit on the command line.
+.SH OPTIONS
+\'
+Options are processed in command line order. Any option you specify on
+the command line remains in effect for the set of images that follows,
+until the set is terminated by the appearance of any option or \fB-noop\fP.
+Some options only affect the decoding of images and others only the encoding.
+The latter can appear after the final group of input images.
+\'
+This is a combined list of the command-line options used by the
+GraphicsMagick utilities (\fIanimate\fP, \fIcompare\fP,
+\fIcomposite\fP, \fIconvert\fP, \fIdisplay\fP, \fIidentify\fP,
+\fIimport\fP, \fImogrify\fP and \fImontage\fP).
+\'
+\'
+In this document, angle brackets ("<>") enclose variables and curly
+brackets ("{}") enclose optional parameters. For example,
+"\fB-fuzz <distance>{%}\fP" means you can use the
+option "-fuzz 10"
+or "-fuzz 2%".
+\'
+.TP
+.B "-adjoin"
+\fRjoin images into a single multi-image file
+\'
+By default, all images of an image sequence are stored in the same
+file. However, some formats (e.g. JPEG) do not support storing more
+than one image per file and only the first frame in an image sequence
+will be saved unless the result is saved to separate files. Use
+\fB+adjoin\fP to force saving multiple frames to multiple numbered
+files. If \fB+adjoin\fP is used, then the output filename must
+include a printf style formatting specification for the numeric part
+of the filename. For example,
+\'
+ image%02d.miff
+\'
+.TP
+.B "-affine \fI<matrix>"\fP
+\fRdrawing transform matrix
+\'
+This option provides a transform matrix {sx,rx,ry,sy,tx,ty} for
+use by subsequent \fB-draw\fP or \fB-transform\fP options.
+.TP
+.B "-antialias"
+\fRremove pixel aliasing
+\'
+By default antialiasing algorithms are used when drawing objects (e.g. lines)
+or rendering vector formats (e.g. WMF and Postscript). Use +antialias to
+disable use of antialiasing algorithms. Reasons to disable antialiasing
+include avoiding increasing colors in the image, or improving rendering speed.
+.TP
+.B "-append"
+\fRappend a set of images
+\'
+This option creates a single image where the images in the original set
+are stacked top-to-bottom. If they are not of the same width,
+any narrow images will be expanded to fit using the background color.
+Use \fB+append\fP to stack images left-to-right. The set of images
+is terminated by the appearance of any option.
+If the \fB-append\fP
+option appears after all of the input images, all images are appended.
+.TP
+.B " \fI-asc-cdl <spec>"\fP
+\fRapply ASC CDL color transform
+\'
+Applies ("bakes in") the ASC CDL, which is a format for the exchange
+of basic primary color grading information between equipment and
+software from different manufacturers. The format defines the math for
+three functions: slope, offset and power. Each function uses a number
+for the red, green, and blue color channels for a total of nine
+numbers comprising a single color decision. The tenth number
+(optional) is for chromiance (saturation) as specified by ASC CDL
+1.2.
+\'
+The argument string is comma delimited and is in the following form
+(but without invervening spaces or line breaks)
+\'
+ redslope,redoffset,redpower:
+ greenslope,greenoffset,greenpower:
+ blueslope,blueoffset,bluepower:
+ saturation
+\'
+\'