From 472f88ccec9c68548aa678d6fab956b2bb9c5297 Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Tue, 1 Apr 2025 06:42:14 +0300 Subject: [PATCH] netbpm tools: add option placeholders (#16048) --- pages/common/anytopnm.md | 2 +- pages/common/asciitopgm.md | 2 +- pages/common/bioradtopgm.md | 2 +- pages/common/bmptopnm.md | 4 ++-- pages/common/brushtopbm.md | 2 +- pages/common/fitstopnm.md | 2 +- pages/common/gemtopnm.md | 2 +- pages/common/giftopnm.md | 2 +- pages/common/hipstopgm.md | 4 ++-- pages/common/ilbmtoppm.md | 6 +++--- pages/common/imgtoppm.md | 2 +- pages/common/jpegtopnm.md | 2 +- pages/common/leaftoppm.md | 2 +- pages/common/macptopbm.md | 6 +++--- pages/common/neotoppm.md | 2 +- pages/common/palmtopnm.md | 8 ++++---- pages/common/pambrighten.md | 4 ++-- pages/common/pamcomp.md | 6 +++--- pages/common/pamcrater.md | 4 ++-- pages/common/pamcut.md | 6 +++--- pages/common/pamdeinterlace.md | 2 +- pages/common/pamdice.md | 4 ++-- pages/common/pamditherbw.md | 4 ++-- pages/common/pamenlarge.md | 4 ++-- pages/common/pamexec.md | 2 +- pages/common/pamfile.md | 4 ++-- pages/common/pamfix.md | 6 +++--- pages/common/pamflip.md | 8 ++++---- pages/common/pammixinterlace.md | 4 ++-- pages/common/pamscale.md | 6 +++--- pages/common/pamshadedrelief.md | 2 +- pages/common/pamslice.md | 8 ++++---- pages/common/pamstack.md | 2 +- pages/common/pamstretch.md | 2 +- pages/common/pamtogif.md | 4 ++-- pages/common/pamtopam.md | 2 +- pages/common/pamtopng.md | 6 +++--- pages/common/pamtopnm.md | 2 +- pages/common/pamtotga.md | 2 +- pages/common/pamtotiff.md | 2 +- pages/common/pamtouil.md | 2 +- pages/common/pamtowinicon.md | 4 ++-- pages/common/pamundice.md | 6 +++--- pages/common/pbmclean.md | 2 +- pages/common/pbmlife.md | 2 +- pages/common/pbmmask.md | 2 +- pages/common/pbmreduce.md | 4 ++-- pages/common/pbmtext.md | 4 ++-- pages/common/pbmtextps.md | 4 ++-- pages/common/pbmtoascii.md | 2 +- pages/common/pbmtoepsi.md | 6 +++--- pages/common/pbmtoepson.md | 4 ++-- pages/common/pbmtoescp2.md | 6 +++--- pages/common/pbmtogem.md | 4 ++-- pages/common/pbmtolj.md | 2 +- pages/common/pbmtomacp.md | 2 +- pages/common/pbmtonokia.md | 12 ++++++------ pages/common/pcxtoppm.md | 4 ++-- pages/common/pgmhist.md | 8 ++++---- pages/common/pgmkernel.md | 2 +- pages/common/pgmtoppm.md | 4 ++-- pages/common/picttoppm.md | 4 ++-- pages/common/pngtopam.md | 4 ++-- pages/common/pnmalias.md | 4 ++-- pages/common/pnmcolormap.md | 4 ++-- pages/common/pnmcrop.md | 6 +++--- pages/common/pnmgamma.md | 4 ++-- pages/common/pnmhisteq.md | 2 +- pages/common/pnmhistmap.md | 4 ++-- pages/common/pnmindex.md | 6 +++--- pages/common/pnmmargin.md | 2 +- pages/common/pnmmercator.md | 2 +- pages/common/pnmmontage.md | 4 ++-- pages/common/pnmnorm.md | 4 ++-- pages/common/pnmpad.md | 8 ++++---- pages/common/pnmquantall.md | 2 +- pages/common/pnmremap.md | 8 ++++---- pages/common/pnmrotate.md | 4 ++-- pages/common/pnmscalefixed.md | 6 +++--- pages/common/pnmshear.md | 4 ++-- pages/common/pnmsmooth.md | 2 +- pages/common/pnmtoddif.md | 2 +- pages/common/pnmtofiasco.md | 2 +- pages/common/pnmtopalm.md | 6 +++--- pages/common/pnmtopclxl.md | 4 ++-- pages/common/pnmtopng.md | 2 +- pages/common/pnmtops.md | 4 ++-- pages/common/pnmtorle.md | 4 ++-- pages/common/pnmtosgi.md | 2 +- pages/common/pnmtoxwd.md | 4 ++-- pages/common/ppmchange.md | 2 +- pages/common/ppmcie.md | 2 +- pages/common/ppmcolormask.md | 2 +- pages/common/ppmdither.md | 4 ++-- pages/common/ppmflash.md | 2 +- pages/common/ppmforge.md | 4 ++-- pages/common/ppmglobe.md | 2 +- pages/common/ppmhist.md | 6 +++--- pages/common/ppmlabel.md | 6 +++--- pages/common/ppmntsc.md | 2 +- pages/common/ppmpat.md | 2 +- pages/common/ppmrainbow.md | 4 ++-- pages/common/ppmspread.md | 2 +- pages/common/ppmtoacad.md | 2 +- pages/common/ppmtoarbtxt.md | 2 +- pages/common/ppmtobmp.md | 2 +- pages/common/ppmtoicr.md | 6 +++--- pages/common/ppmtoilbm.md | 4 ++-- pages/common/ppmtolj.md | 4 ++-- pages/common/ppmtomitsu.md | 4 ++-- pages/common/ppmtompeg.md | 4 ++-- pages/common/ppmtopgm.md | 2 +- pages/common/ppmtopj.md | 4 ++-- pages/common/ppmtopjxl.md | 6 +++--- pages/common/ppmtoppm.md | 2 +- pages/common/ppmtosixel.md | 4 ++-- pages/common/ppmtoxpm.md | 6 +++--- pages/common/ppmtv.md | 4 ++-- pages/common/ppmwheel.md | 4 ++-- pages/common/rasttopnm.md | 2 +- pages/common/rawtopgm.md | 10 +++++----- pages/common/rawtoppm.md | 6 +++--- pages/common/rletopnm.md | 4 ++-- pages/common/sgitopnm.md | 4 ++-- pages/common/sldtoppm.md | 2 +- pages/common/svgtopam.md | 2 +- pages/common/tgatoppm.md | 6 +++--- pages/common/thinkjettopbm.md | 2 +- pages/common/tifftopnm.md | 6 +++--- pages/common/winicontopam.md | 6 +++--- pages/common/ximtoppm.md | 2 +- pages/common/xpmtoppm.md | 2 +- pages/common/xwdtopnm.md | 4 ++-- pages/common/yuy2topam.md | 2 +- 134 files changed, 253 insertions(+), 253 deletions(-) diff --git a/pages/common/anytopnm.md b/pages/common/anytopnm.md index e3f4c805d9..3f7aa25c15 100644 --- a/pages/common/anytopnm.md +++ b/pages/common/anytopnm.md @@ -9,4 +9,4 @@ - Display version: -`anytopnm -version` +`anytopnm {{[-v|-version]}}` diff --git a/pages/common/asciitopgm.md b/pages/common/asciitopgm.md index 245aa2deb7..5433a39b62 100644 --- a/pages/common/asciitopgm.md +++ b/pages/common/asciitopgm.md @@ -9,4 +9,4 @@ - Display version: -`asciitopgm -version` +`asciitopgm {{[-v|-version]}}` diff --git a/pages/common/bioradtopgm.md b/pages/common/bioradtopgm.md index a29dd71fce..ede1caf2d6 100644 --- a/pages/common/bioradtopgm.md +++ b/pages/common/bioradtopgm.md @@ -13,4 +13,4 @@ - Display version: -`bioradtopgm -version` +`bioradtopgm {{[-v|-version]}}` diff --git a/pages/common/bmptopnm.md b/pages/common/bmptopnm.md index 2224cee801..70aaa86f70 100644 --- a/pages/common/bmptopnm.md +++ b/pages/common/bmptopnm.md @@ -9,8 +9,8 @@ - Report contents of the BMP header to `stderr`: -`bmptopnm -verbose {{path/to/file.bmp}}` +`bmptopnm {{[-verb|-verbose]}} {{path/to/file.bmp}}` - Display version: -`bmptopnm -version` +`bmptopnm {{[-v|-version]}}` diff --git a/pages/common/brushtopbm.md b/pages/common/brushtopbm.md index 0896fdac3a..909fab31c9 100644 --- a/pages/common/brushtopbm.md +++ b/pages/common/brushtopbm.md @@ -9,4 +9,4 @@ - Display version: -`brushtopbm -version` +`brushtopbm {{[-v|-version]}}` diff --git a/pages/common/fitstopnm.md b/pages/common/fitstopnm.md index cf919ca807..f9a555854b 100644 --- a/pages/common/fitstopnm.md +++ b/pages/common/fitstopnm.md @@ -10,4 +10,4 @@ - Convert the image on the specified position of the third axis in the FITS file: -`fitstopnm -image {{z_position}} {{path/to/file.fits}} > {{path/to/output.pnm}}` +`fitstopnm {{[-i|-image]}} {{z_position}} {{path/to/file.fits}} > {{path/to/output.pnm}}` diff --git a/pages/common/gemtopnm.md b/pages/common/gemtopnm.md index 9a27313ada..3e5892ff43 100644 --- a/pages/common/gemtopnm.md +++ b/pages/common/gemtopnm.md @@ -9,7 +9,7 @@ - Describe the contents of the specified GEM image: -`gemtopnm -d {{path/to/file.img}}` +`gemtopnm {{[-d|-debug]}} {{path/to/file.img}}` - Display version: diff --git a/pages/common/giftopnm.md b/pages/common/giftopnm.md index 8c7fe60f72..c529d61cc2 100644 --- a/pages/common/giftopnm.md +++ b/pages/common/giftopnm.md @@ -9,4 +9,4 @@ - Display version: -`giftopnm -version` +`giftopnm {{[-v|-version]}}` diff --git a/pages/common/hipstopgm.md b/pages/common/hipstopgm.md index 186f38a98b..c70d17c3c3 100644 --- a/pages/common/hipstopgm.md +++ b/pages/common/hipstopgm.md @@ -10,8 +10,8 @@ - Suppress all informational messages: -`hipstopgm -quiet` +`hipstopgm {{[-q|-quiet]}}` - Display version: -`hipstopgm -version` +`hipstopgm {{[-v|-version]}}` diff --git a/pages/common/ilbmtoppm.md b/pages/common/ilbmtoppm.md index a49ae175de..a39d64854a 100644 --- a/pages/common/ilbmtoppm.md +++ b/pages/common/ilbmtoppm.md @@ -9,12 +9,12 @@ - Use the specified color to "show through" where the image is transparent: -`ilbmtoppm -transparent {{color}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` +`ilbmtoppm {{[-t|-transparent]}} {{color}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` - Ignore the chunk with the specified chunk ID: -`ilbmtoppm -ignore {{chunkID}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` +`ilbmtoppm {{[-ig|-ignore]}} {{chunkID}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` - Store the input's transparency information to the specified PBM file: -`ilbmtoppm -maskfile {{path/to/maskfile.pbm}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` +`ilbmtoppm {{[-m|-maskfile]}} {{path/to/maskfile.pbm}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` diff --git a/pages/common/imgtoppm.md b/pages/common/imgtoppm.md index 18d8bcc0d6..ece4d18a90 100644 --- a/pages/common/imgtoppm.md +++ b/pages/common/imgtoppm.md @@ -9,4 +9,4 @@ - Display version: -`imgtoppm -version` +`imgtoppm {{[-v|-version]}}` diff --git a/pages/common/jpegtopnm.md b/pages/common/jpegtopnm.md index 64a74e3b72..8f7fa30f56 100644 --- a/pages/common/jpegtopnm.md +++ b/pages/common/jpegtopnm.md @@ -9,4 +9,4 @@ - Display version: -`jpegtopnm -version` +`jpegtopnm {{[-v|-version]}}` diff --git a/pages/common/leaftoppm.md b/pages/common/leaftoppm.md index 95b199e6d3..9d0976042d 100644 --- a/pages/common/leaftoppm.md +++ b/pages/common/leaftoppm.md @@ -9,4 +9,4 @@ - Display version: -`leaftoppm -version` +`leaftoppm {{[-v|-version]}}` diff --git a/pages/common/macptopbm.md b/pages/common/macptopbm.md index 197d9c1a28..cd70d7815c 100644 --- a/pages/common/macptopbm.md +++ b/pages/common/macptopbm.md @@ -10,12 +10,12 @@ - Skip over `n` bytes when reading the file: -`macptopbm -extraskip {{n}} > {{path/to/output.pbm}}` +`macptopbm {{[-e|-extraskip]}} {{n}} > {{path/to/output.pbm}}` - Suppress all informational messages: -`macptopbm -quiet > {{path/to/output.pbm}}` +`macptopbm {{[-q|-quiet]}} > {{path/to/output.pbm}}` - Display version: -`macptopbm -version` +`macptopbm {{[-v|-version]}}` diff --git a/pages/common/neotoppm.md b/pages/common/neotoppm.md index e781f90055..4e42ba93d9 100644 --- a/pages/common/neotoppm.md +++ b/pages/common/neotoppm.md @@ -9,4 +9,4 @@ - Display version: -`neotoppm -version` +`neotoppm {{[-v|-version]}}` diff --git a/pages/common/palmtopnm.md b/pages/common/palmtopnm.md index c818426fe8..18ea885b57 100644 --- a/pages/common/palmtopnm.md +++ b/pages/common/palmtopnm.md @@ -9,16 +9,16 @@ - Display information about the input file: -`palmtopnm -verbose {{path/to/file.palm}} > {{path/to/file.pnm}}` +`palmtopnm {{[-verb|-verbose]}} {{path/to/file.palm}} > {{path/to/file.pnm}}` - Convert the n'th rendition of the image contained in the input file: -`palmtopnm -rendition {{n}} {{path/to/file.palm}} > {{path/to/file.pnm}}` +`palmtopnm {{[-r|-rendition]}} {{n}} {{path/to/file.palm}} > {{path/to/file.pnm}}` - Write a histogram of the colors in the input file to `stdout`: -`palmtopnm -showhist {{path/to/file.palm}} > {{path/to/file.pnm}}` +`palmtopnm {{[-s|-showhist]}} {{path/to/file.palm}} > {{path/to/file.pnm}}` - Output the transparent color of the input image if set: -`palmtopnm -transparent {{path/to/file.palm}}` +`palmtopnm {{[-t|-transparent]}} {{path/to/file.palm}}` diff --git a/pages/common/pambrighten.md b/pages/common/pambrighten.md index e7d52965cc..6acb46a9e9 100644 --- a/pages/common/pambrighten.md +++ b/pages/common/pambrighten.md @@ -5,8 +5,8 @@ - Increase the saturation of each pixel by the specified percentage: -`pambrighten -saturation {{value_percent}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pambrighten {{[-s|-saturation]}} {{value_percent}} {{path/to/image.pam}} > {{path/to/output.pam}}` - Increase the value (from the HSV color space) of each pixel by the specified percentage: -`pambrighten -value {{value_percent}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pambrighten {{[-va|-value]}} {{value_percent}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/pages/common/pamcomp.md b/pages/common/pamcomp.md index b01b429f90..41dde0415c 100644 --- a/pages/common/pamcomp.md +++ b/pages/common/pamcomp.md @@ -9,12 +9,12 @@ - Set the horizontal alignment of the overlay: -`pamcomp -align {{left|center|right|beyondleft|beyondright}} -xoff {{x_offset}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` +`pamcomp {{[-ali|-align]}} {{left|center|right|beyondleft|beyondright}} {{[-x|-xoff]}} {{x_offset}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` - Set the vertical alignment of the overlay: -`pamcomp -valign {{top|middle|bottom|above|below}} -yoff {{y_offset}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` +`pamcomp {{[-va|-valign]}} {{top|middle|bottom|above|below}} {{[-y|-yoff]}} {{y_offset}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` - Set the opacity of the overlay: -`pamcomp -opacity {{0.7}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` +`pamcomp {{[-o|-opacity]}} {{0.7}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` diff --git a/pages/common/pamcrater.md b/pages/common/pamcrater.md index cd092ae04f..e7bc87e0a2 100644 --- a/pages/common/pamcrater.md +++ b/pages/common/pamcrater.md @@ -6,8 +6,8 @@ - Create an image of cratered terrain with the specified dimensions: -`pamcrater -height {{height}} -width {{width}} > {{path/to/output.pam}}` +`pamcrater {{[-h|-height]}} {{height}} {{[-w|-width]}} {{width}} > {{path/to/output.pam}}` - Create an image containing the specified number of craters: -`pamcrater -number {{n_craters}} > {{path/to/output.pam}}` +`pamcrater {{[-n|-number]}} {{n_craters}} > {{path/to/output.pam}}` diff --git a/pages/common/pamcut.md b/pages/common/pamcut.md index 34f54960a5..6360abcb86 100644 --- a/pages/common/pamcut.md +++ b/pages/common/pamcut.md @@ -6,12 +6,12 @@ - Discard the specified number of columns/rows on each side of the image: -`pamcut -cropleft {{value}} -cropright {{value}} -croptop {{value}} -cropbottom {{value}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` +`pamcut {{[-cropl|-cropleft]}} {{value}} {{[-cropr|-cropright]}} {{value}} {{[-cropt|-croptop]}} {{value}} {{[-cropb|-cropbottom]}} {{value}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` - Keep only the columns between the specified columns (inclusively): -`pamcut -left {{value}} -right {{value}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` +`pamcut {{[-l|-left]}} {{value}} {{[-ri|-right]}} {{value}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` - Fill missing areas with black pixels if the specified rectangle does not entirely lie within the input image: -`pamcut -top {{value}} -bottom {{value}} -pad {{path/to/image.ppm}} > {{path/to/output.ppm}}` +`pamcut {{[-t|-top]}} {{value}} {{[-b|-bottom]}} {{value}} -pad {{path/to/image.ppm}} > {{path/to/output.ppm}}` diff --git a/pages/common/pamdeinterlace.md b/pages/common/pamdeinterlace.md index 9950b87138..98eb8aaf0d 100644 --- a/pages/common/pamdeinterlace.md +++ b/pages/common/pamdeinterlace.md @@ -10,4 +10,4 @@ - Produce an image consisting of the input's odd-numbered rows: -`pamdeinterlace -takeodd {{path/to/image.ppm}} > {{path/to/output.ppm}}` +`pamdeinterlace {{[-takeo|-takeodd]}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` diff --git a/pages/common/pamdice.md b/pages/common/pamdice.md index 39624031a9..74d1a58166 100644 --- a/pages/common/pamdice.md +++ b/pages/common/pamdice.md @@ -6,8 +6,8 @@ - Slice a Netpbm image such that the resulting tiles have the specified height and width: -`pamdice -outstem {{path/to/filename_stem}} -height {{value}} -width {{value}} {{path/to/input.ppm}}` +`pamdice {{[-o|-outstem]}} {{path/to/filename_stem}} {{[-he|-height]}} {{value}} {{[-w|-width]}} {{value}} {{path/to/input.ppm}}` - Make the produced pieces overlap by the specified amount horizontally and vertically: -`pamdice -outstem {{path/to/filename_stem}} -height {{value}} -width {{value}} -hoverlap {{value}} -voverlap {{value}} {{path/to/input.ppm}}` +`pamdice {{[-o|-outstem]}} {{path/to/filename_stem}} {{[-he|-height]}} {{value}} {{[-w|-width]}} {{value}} {{[-ho|-hoverlap]}} {{value}} {{[-vo|-voverlap]}} {{value}} {{path/to/input.ppm}}` diff --git a/pages/common/pamditherbw.md b/pages/common/pamditherbw.md index a8a2bb3f26..093804a04b 100644 --- a/pages/common/pamditherbw.md +++ b/pages/common/pamditherbw.md @@ -14,8 +14,8 @@ - Use the atkinson quantization method and the specified seed for a pseudo-random number generator: -`ppmditherbw -atkinson -randomseed {{1337}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` +`ppmditherbw {{[-a|-atkinson]}} {{[-r|-randomseed]}} {{1337}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` - Specify the thresholding value for quantization methods that perform some sort of thresholding: -`ppmditherbw -{{fs|atkinson|thresholding}} -value {{0.3}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` +`ppmditherbw -{{fs|atkinson|thresholding}} {{[-va|-value]}} {{0.3}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` diff --git a/pages/common/pamenlarge.md b/pages/common/pamenlarge.md index 04257f736e..1a8380dbab 100644 --- a/pages/common/pamenlarge.md +++ b/pages/common/pamenlarge.md @@ -6,8 +6,8 @@ - Enlarge the specified image by the specified factor: -`pamenlarge -scale {{n}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamenlarge {{[-s|-scale]}} {{n}} {{path/to/image.pam}} > {{path/to/output.pam}}` - Enlarge the specified image by the specified factors horizontally and vertically: -`pamenlarge -xscale {{xn}} -yscale {{yn}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamenlarge {{[-x|-xscale]}} {{xn}} {{[-y|-yscale]}} {{yn}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/pages/common/pamexec.md b/pages/common/pamexec.md index a765a7d6ec..76e032a7c5 100644 --- a/pages/common/pamexec.md +++ b/pages/common/pamexec.md @@ -10,4 +10,4 @@ - Stop processing if a command terminates with a nonzero exit status: -`pamexec {{command}} {{path/to/image.pam}} -check` +`pamexec {{command}} {{path/to/image.pam}} {{[-c|-check]}}` diff --git a/pages/common/pamfile.md b/pages/common/pamfile.md index 03c664b9ed..d8bd83c34b 100644 --- a/pages/common/pamfile.md +++ b/pages/common/pamfile.md @@ -9,8 +9,8 @@ - Describe every image in each input file (as opposed to only the first image in each file) in a machine-readable format: -`pamfile -allimages -machine {{path/to/file}}` +`pamfile {{[-a|-allimages]}} -machine {{path/to/file}}` - Display a count on how many images the input files contain: -`pamfile -count {{path/to/file}}` +`pamfile {{[-cou|-count]}} {{path/to/file}}` diff --git a/pages/common/pamfix.md b/pages/common/pamfix.md index d42cee8a9e..9ac0cf517b 100644 --- a/pages/common/pamfix.md +++ b/pages/common/pamfix.md @@ -6,12 +6,12 @@ - Fix a Netpbm file that is missing its last part: -`pamfix -truncate {{path/to/corrupted.ext}} > {{path/to/output.ext}}` +`pamfix {{[-t|-truncate]}} {{path/to/corrupted.ext}} > {{path/to/output.ext}}` - Fix a Netpbm file where pixel values exceed the image's `maxval` by lowering the offending pixels' values: -`pamfix -clip {{path/to/corrupted.ext}} > {{path/to/output.ext}}` +`pamfix {{[-cl|-clip]}} {{path/to/corrupted.ext}} > {{path/to/output.ext}}` - Fix a Netpbm file where pixel values exceed the image's `maxval` by increasing it: -`pamfix -changemaxval {{path/to/corrupted.pam|pbm|pgm|ppm}} > {{path/to/output.pam|pbm|pgm|ppm}}` +`pamfix {{[-ch|-changemaxval]}} {{path/to/corrupted.pam|pbm|pgm|ppm}} > {{path/to/output.pam|pbm|pgm|ppm}}` diff --git a/pages/common/pamflip.md b/pages/common/pamflip.md index 99c3fcfb4e..27d6e47f9c 100644 --- a/pages/common/pamflip.md +++ b/pages/common/pamflip.md @@ -5,16 +5,16 @@ - Rotate the input image counter-clockwise for a specific degree: -`pamflip -rotate{{90|180|270}} {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamflip {{[-r|-rotate]}}{{90|180|270}} {{path/to/input.pam}} > {{path/to/output.pam}}` - Flip left for right: -`pamflip -leftright {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamflip {{[-lr|-leftright]}} {{path/to/input.pam}} > {{path/to/output.pam}}` - Flip top for bottom: -`pamflip -topbottom {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamflip {{[-tb|-topbottom]}} {{path/to/input.pam}} > {{path/to/output.pam}}` - Flip the input image on the main diagonal: -`pamflip -transpose {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamflip {{[-xy|-transpose]}} {{path/to/input.pam}} > {{path/to/output.pam}}` diff --git a/pages/common/pammixinterlace.md b/pages/common/pammixinterlace.md index 10d38494ee..ce31e78b50 100644 --- a/pages/common/pammixinterlace.md +++ b/pages/common/pammixinterlace.md @@ -10,8 +10,8 @@ - Use the specified filtering mechanism: -`pammixinterlace -filter {{linear|fir|ffmpeg}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` +`pammixinterlace {{[-f|-filter]}} {{linear|fir|ffmpeg}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` - Turn on adaptive filtering mode, i.e., only modify pixels that are obviously part of a comb pattern: -`pammixinterlace -adaptive {{path/to/image.ppm}} > {{path/to/output.ppm}}` +`pammixinterlace {{[-a|-adaptive]}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` diff --git a/pages/common/pamscale.md b/pages/common/pamscale.md index 480eaf0d39..5bb85bc799 100644 --- a/pages/common/pamscale.md +++ b/pages/common/pamscale.md @@ -5,15 +5,15 @@ - Scale an image such that the result has the specified dimensions: -`pamscale -width {{width}} -height {{height}} {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamscale {{[-wid|-width]}} {{width}} {{[-h|-height]}} {{height}} {{path/to/input.pam}} > {{path/to/output.pam}}` - Scale an image such that the result has the specified width, keeping the aspect ratio: -`pamscale -width {{width}} {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamscale {{[-wid|-width]}} {{width}} {{path/to/input.pam}} > {{path/to/output.pam}}` - Scale an image such that its width and height is changed by the specified factors: -`pamscale -xscale {{x_factor}} -yscale {{y_factor}} {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamscale {{[-xsc|-xscale]}} {{x_factor}} {{[-ysc|-yscale]}} {{y_factor}} {{path/to/input.pam}} > {{path/to/output.pam}}` - Scale an image such that it fits into the specified bounding box while preserving its aspect ratio: diff --git a/pages/common/pamshadedrelief.md b/pages/common/pamshadedrelief.md index 13bf84be34..e7778e9e61 100644 --- a/pages/common/pamshadedrelief.md +++ b/pages/common/pamshadedrelief.md @@ -10,4 +10,4 @@ - Gamma adjust the image by the specified factor: -`pamshadedrelief -gamma {{factor}} < {{path/to/input.pam}} > {{path/to/output.pam}}` +`pamshadedrelief {{[-g|-gamma]}} {{factor}} < {{path/to/input.pam}} > {{path/to/output.pam}}` diff --git a/pages/common/pamslice.md b/pages/common/pamslice.md index 61fb975969..9f30bb3db4 100644 --- a/pages/common/pamslice.md +++ b/pages/common/pamslice.md @@ -5,16 +5,16 @@ - Print the values of the pixels in the n'th row in a table: -`pamslice -row {{n}} {{path/to/image.pam}}` +`pamslice {{[-r|-row]}} {{n}} {{path/to/image.pam}}` - Print the values of the pixels in the n'th column in a table: -`pamslice -column {{n}} {{path/to/image.pam}}` +`pamslice {{[-c|-column]}} {{n}} {{path/to/image.pam}}` - Consider the m'th plane of the input image only: -`pamslice -row {{n}} -plane {{m}} {{path/to/image.pam}}` +`pamslice {{[-r|-row]}} {{n}} -plane {{m}} {{path/to/image.pam}}` - Produce output in a format suitable for input to an `xmgr` for visualisation: -`pamslice -row {{n}} -xmgr {{path/to/image.pam}}` +`pamslice {{[-r|-row]}} {{n}} {{[-x|-xmgr]}} {{path/to/image.pam}}` diff --git a/pages/common/pamstack.md b/pages/common/pamstack.md index 744c5914b5..653d7b074a 100644 --- a/pages/common/pamstack.md +++ b/pages/common/pamstack.md @@ -9,4 +9,4 @@ - Specify the tuple type name of the output PAM file (maximum of 255 characters): -`pamstack -tupletype {{tuple_type}} {{path/to/image1.pam path/to/image2.pam ...}} > {{path/to/output.pam}}` +`pamstack {{[-t|-tupletype]}} {{tuple_type}} {{path/to/image1.pam path/to/image2.pam ...}} > {{path/to/output.pam}}` diff --git a/pages/common/pamstretch.md b/pages/common/pamstretch.md index 7d6453338c..416ef110d8 100644 --- a/pages/common/pamstretch.md +++ b/pages/common/pamstretch.md @@ -10,4 +10,4 @@ - Scale up a PAM image by the specified factors in the horizontal and vertical directions: -`pamstretch -xscale {{xn}} -yscale {{yn}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamstretch {{[-x|-xscale]}} {{xn}} {{[-y|-yscale]}} {{yn}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/pages/common/pamtogif.md b/pages/common/pamtogif.md index fec0492947..9666c1c805 100644 --- a/pages/common/pamtogif.md +++ b/pages/common/pamtogif.md @@ -10,8 +10,8 @@ - Mark the specified color as transparent in the output GIF file: -`pamtogif -transparent {{color}} {{path/to/image.pam}} > {{path/to/output.gif}}` +`pamtogif {{[-t|-transparent]}} {{color}} {{path/to/image.pam}} > {{path/to/output.gif}}` - Include the specified text as a comment in the output GIF file: -`pamtogif -comment "{{Hello World!}}" {{path/to/image.pam}} > {{path/to/output.gif}}` +`pamtogif {{[-c|-comment]}} "{{Hello World!}}" {{path/to/image.pam}} > {{path/to/output.gif}}` diff --git a/pages/common/pamtopam.md b/pages/common/pamtopam.md index dd9a1ad009..e77d10ac36 100644 --- a/pages/common/pamtopam.md +++ b/pages/common/pamtopam.md @@ -9,4 +9,4 @@ - Display version: -`pamtopam -version` +`pamtopam {{[-v|-version]}}` diff --git a/pages/common/pamtopng.md b/pages/common/pamtopng.md index 0214f43124..804efa2cdf 100644 --- a/pages/common/pamtopng.md +++ b/pages/common/pamtopng.md @@ -10,12 +10,12 @@ - Mark the specified color as transparent in the output image: -`pamtopng -transparent {{color}} {{path/to/image.pam}} > {{path/to/output.png}}` +`pamtopng {{[-t|-transparent]}} {{color}} {{path/to/image.pam}} > {{path/to/output.png}}` - Include the text in the specified file as tEXt chunks in the output: -`pamtopng -text {{path/to/file.txt}} {{path/to/image.pam}} > {{path/to/output.png}}` +`pamtopng {{[-te|-text]}} {{path/to/file.txt}} {{path/to/image.pam}} > {{path/to/output.png}}` - Cause the output file to be interlaced in Adam7 format: -`pamtopng -interlace {{path/to/image.pam}} > {{path/to/output.png}}` +`pamtopng {{[-in|-interlace]}} {{path/to/image.pam}} > {{path/to/output.png}}` diff --git a/pages/common/pamtopnm.md b/pages/common/pamtopnm.md index ff83d8a6ee..3d09b974a0 100644 --- a/pages/common/pamtopnm.md +++ b/pages/common/pamtopnm.md @@ -9,4 +9,4 @@ - Display version: -`pamtopnm -version` +`pamtopnm {{[-v|-version]}}` diff --git a/pages/common/pamtotga.md b/pages/common/pamtotga.md index 06eac1405f..eed066c4f6 100644 --- a/pages/common/pamtotga.md +++ b/pages/common/pamtotga.md @@ -13,4 +13,4 @@ - Display version: -`pamtotga -version` +`pamtotga {{[-v|-version]}}` diff --git a/pages/common/pamtotiff.md b/pages/common/pamtotiff.md index 32e635880c..496b868475 100644 --- a/pages/common/pamtotiff.md +++ b/pages/common/pamtotiff.md @@ -13,4 +13,4 @@ - Always produce a color TIFF image, even if the input image is greyscale: -`pamtotiff -color {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` +`pamtotiff {{[-c|-color]}} {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` diff --git a/pages/common/pamtouil.md b/pages/common/pamtouil.md index 7659341bed..d0e05ce665 100644 --- a/pages/common/pamtouil.md +++ b/pages/common/pamtouil.md @@ -9,4 +9,4 @@ - Specify a prefix string to be printed in the output UIL file: -`pamtouil -name {{uilname}} {{path/to/input.pnm|pam}} > {{path/to/output.uil}}` +`pamtouil {{[-n|-name]}} {{uilname}} {{path/to/input.pnm|pam}} > {{path/to/output.uil}}` diff --git a/pages/common/pamtowinicon.md b/pages/common/pamtowinicon.md index d516f1a62d..39b8b335e9 100644 --- a/pages/common/pamtowinicon.md +++ b/pages/common/pamtowinicon.md @@ -9,8 +9,8 @@ - Encode images with resolutions smaller than t in the BMP format and all other images in the PNG format: -`pamtowinicon -pngthreshold {{t}} {{path/to/input_file.pam}} > {{path/to/output.ico}}` +`pamtowinicon {{[-pn|-pngthreshold]}} {{t}} {{path/to/input_file.pam}} > {{path/to/output.ico}}` - Make all pixels outside the non-opaque area black: -`pamtowinicon -truetransparent {{path/to/input_file.pam}} > {{path/to/output.ico}}` +`pamtowinicon {{[-t|-truetransparent]}} {{path/to/input_file.pam}} > {{path/to/output.ico}}` diff --git a/pages/common/pamundice.md b/pages/common/pamundice.md index f5fa38a77d..4c2ac16fe9 100644 --- a/pages/common/pamundice.md +++ b/pages/common/pamundice.md @@ -6,12 +6,12 @@ - Combine the images whose names match the `printf`-style filename expression. Assume a grid with a specific size: -`pamundice {{filename_%1d_%1a.ppm}} -across {{grid_width}} -down {{grid_height}} > {{path/to/output.ppm}}` +`pamundice {{filename_%1d_%1a.ppm}} {{[-a|-across]}} {{grid_width}} {{[-d|-down]}} {{grid_height}} > {{path/to/output.ppm}}` - Assume that the tiles overlap horizontally and vertically by the specified amount: -`pamundice {{filename_%1d_%1a.ppm}} -across {{x_value}} -down {{y_value}} -hoverlap {{value}} -voverlap {{value}} > {{path/to/output.ppm}}` +`pamundice {{filename_%1d_%1a.ppm}} {{[-a|-across]}} {{x_value}} {{[-d|-down]}} {{y_value}} {{[-h|-hoverlap]}} {{value}} {{[-vo|-voverlap]}} {{value}} > {{path/to/output.ppm}}` - Specify the images to be combined through a text file containing one filename per line: -`pamundice -listfile {{path/to/file.txt}} -across {{x_value}} -down {{y_value}} > {{path/to/output.ppm}}` +`pamundice {{[-l|-listfile]}} {{path/to/file.txt}} {{[-a|-across]}} {{x_value}} {{[-d|-down]}} {{y_value}} > {{path/to/output.ppm}}` diff --git a/pages/common/pbmclean.md b/pages/common/pbmclean.md index 78c1f42e93..c95ec58939 100644 --- a/pages/common/pbmclean.md +++ b/pages/common/pbmclean.md @@ -13,4 +13,4 @@ - Specify the minimum number of neighbouring pixels of the same color in order for a pixel not to be considered isolated: -`pbmclean -minneighbours {{3}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` +`pbmclean {{[-m|-minneighbours]}} {{3}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` diff --git a/pages/common/pbmlife.md b/pages/common/pbmlife.md index c0ad1847db..a5f1c350b7 100644 --- a/pages/common/pbmlife.md +++ b/pages/common/pbmlife.md @@ -9,4 +9,4 @@ - Display version: -`pbmlife -version` +`pbmlife {{[-v|-version]}}` diff --git a/pages/common/pbmmask.md b/pages/common/pbmmask.md index 4c7953982e..9986603630 100644 --- a/pages/common/pbmmask.md +++ b/pages/common/pbmmask.md @@ -10,4 +10,4 @@ - Expand the generated mask by one pixel: -`pbmmask -expand {{path/to/image.pbm}} > {{path/to/output.pbm}}` +`pbmmask {{[-r|-expand]}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` diff --git a/pages/common/pbmreduce.md b/pages/common/pbmreduce.md index 0374c93ef5..de919e7a18 100644 --- a/pages/common/pbmreduce.md +++ b/pages/common/pbmreduce.md @@ -10,8 +10,8 @@ - Use simple thresholding when reducing: -`pbmreduce -threshold {{n}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` +`pbmreduce {{[-t|-threshold]}} {{n}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` - Use the specified threshold for all quantizations: -`pbmreduce -value {{0.6}} {{n}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` +`pbmreduce {{[-va|-value]}} {{0.6}} {{n}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` diff --git a/pages/common/pbmtext.md b/pages/common/pbmtext.md index 50cd366fc7..42534b1c24 100644 --- a/pages/common/pbmtext.md +++ b/pages/common/pbmtext.md @@ -14,8 +14,8 @@ - Render text using a custom font supplied as a PBM file: -`pbmtext -font {{path/to/font.pbm}} "{{Hello World!}}" > {{path/to/output.pbm}}` +`pbmtext {{[-f|-font]}} {{path/to/font.pbm}} "{{Hello World!}}" > {{path/to/output.pbm}}` - Specify the number of pixels between characters and lines: -`echo "{{Hello\nWorld!}}" | pbmtext -space {{3}} -lspace {{10}} > {{path/to/output.pbm}}` +`echo "{{Hello\nWorld!}}" | pbmtext {{[-s|-space]}} {{3}} {{[-ls|-lspace]}} {{10}} > {{path/to/output.pbm}}` diff --git a/pages/common/pbmtextps.md b/pages/common/pbmtextps.md index c9bf9b74f3..349ae847df 100644 --- a/pages/common/pbmtextps.md +++ b/pages/common/pbmtextps.md @@ -14,8 +14,8 @@ - Specify the desired left and top margins: -`pbmtextps -leftmargin {{70}} -topmargin {{162}} "{{Hello World!}}" > {{path/to/output.pbm}}` +`pbmtextps {{[-l|-leftmargin]}} {{70}} {{[-t|-topmargin]}} {{162}} "{{Hello World!}}" > {{path/to/output.pbm}}` - Do not output the rendered text as a PBM image, but a PostScript program that would create this image: -`pbmtextps -dump-ps "{{Hello World!}}" > {{path/to/output.ps}}` +`pbmtextps {{[-du|-dump-ps]}} "{{Hello World!}}" > {{path/to/output.ps}}` diff --git a/pages/common/pbmtoascii.md b/pages/common/pbmtoascii.md index 4f333a6f48..a650719ff0 100644 --- a/pages/common/pbmtoascii.md +++ b/pages/common/pbmtoascii.md @@ -18,4 +18,4 @@ - Display version: -`pbmtoascii -version` +`pbmtoascii {{[-v|-version]}}` diff --git a/pages/common/pbmtoepsi.md b/pages/common/pbmtoepsi.md index a9ac4b324f..2af2d703c7 100644 --- a/pages/common/pbmtoepsi.md +++ b/pages/common/pbmtoepsi.md @@ -9,12 +9,12 @@ - Produce a quadratic output image with the specified resolution: -`pbmtoepsi -dpi {{144}} {{path/to/image.pbm}} > {{path/to/output.bmp}}` +`pbmtoepsi {{[-d|-dpi]}} {{144}} {{path/to/image.pbm}} > {{path/to/output.bmp}}` - Produce an output image with the specified horizontal and vertical resolution: -`pbmtoepsi -dpi {{72x144}} {{path/to/image.pbm}} > {{path/to/output.bmp}}` +`pbmtoepsi {{[-d|-dpi]}} {{72x144}} {{path/to/image.pbm}} > {{path/to/output.bmp}}` - Only create a boundary box: -`pbmtoepsi -bbonly {{path/to/image.pbm}} > {{path/to/output.bmp}}` +`pbmtoepsi {{[-b|-bbonly]}} {{path/to/image.pbm}} > {{path/to/output.bmp}}` diff --git a/pages/common/pbmtoepson.md b/pages/common/pbmtoepson.md index 2aab7f1df5..936a2ad651 100644 --- a/pages/common/pbmtoepson.md +++ b/pages/common/pbmtoepson.md @@ -10,8 +10,8 @@ - Specify the printer protocol of the output: -`pbmtoepson -protocol {{escp9|escp}} {{path/to/image.pbm}} > {{path/to/output.epson}}` +`pbmtoepson {{[-pr|-protocol]}} {{escp9|escp}} {{path/to/image.pbm}} > {{path/to/output.epson}}` - Specify the horizontal DPI of the output: -`pbmtoepson -dpi {{60|72|80|90|120|144|240}} {{path/to/image.pbm}} > {{path/to/output.epson}}` +`pbmtoepson {{[-d|-dpi]}} {{60|72|80|90|120|144|240}} {{path/to/image.pbm}} > {{path/to/output.epson}}` diff --git a/pages/common/pbmtoescp2.md b/pages/common/pbmtoescp2.md index 752ccabd81..b6a9390317 100644 --- a/pages/common/pbmtoescp2.md +++ b/pages/common/pbmtoescp2.md @@ -10,12 +10,12 @@ - Specify the compression of the output: -`pbmtoescp2 -compression {{0|1}} {{path/to/image.pbm}} > {{path/to/output.escp2}}` +`pbmtoescp2 {{[-c|-compression]}} {{0|1}} {{path/to/image.pbm}} > {{path/to/output.escp2}}` - Specify the horizontal and vertical resolution of the output in dots per inch: -`pbmtoescp2 -resolution {{180|360|720}} {{path/to/image.pbm}} > {{path/to/output.escp2}}` +`pbmtoescp2 {{[-re|-resolution]}} {{180|360|720}} {{path/to/image.pbm}} > {{path/to/output.escp2}}` - Place a formfeed command at the end of the output: -`pbmtoescp2 -formfeed {{path/to/image.pbm}} > {{path/to/output.escp2}}` +`pbmtoescp2 {{[-f|-formfeed]}} {{path/to/image.pbm}} > {{path/to/output.escp2}}` diff --git a/pages/common/pbmtogem.md b/pages/common/pbmtogem.md index f9c7a52c3e..eee3168eea 100644 --- a/pages/common/pbmtogem.md +++ b/pages/common/pbmtogem.md @@ -10,8 +10,8 @@ - Suppress all informational messages: -`pbmtogem -quiet` +`pbmtogem {{[-q|-quiet]}}` - Display version: -`pbmtogem -version` +`pbmtogem {{[-v|-version]}}` diff --git a/pages/common/pbmtolj.md b/pages/common/pbmtolj.md index 763a64911e..87ccb6b3db 100644 --- a/pages/common/pbmtolj.md +++ b/pages/common/pbmtolj.md @@ -13,4 +13,4 @@ - Specify the required resolution: -`pbmtolj -resolution {{75|100|150|300|600}} {{path/to/input.pbm}} > {{path/to/output.lj}}` +`pbmtolj {{[-r|-resolution]}} {{75|100|150|300|600}} {{path/to/input.pbm}} > {{path/to/output.lj}}` diff --git a/pages/common/pbmtomacp.md b/pages/common/pbmtomacp.md index a590a32704..4b8cf43f07 100644 --- a/pages/common/pbmtomacp.md +++ b/pages/common/pbmtomacp.md @@ -10,4 +10,4 @@ - Do not compress the output file: -`pbmtomacp -norle {{path/to/image.pbm}} > {{path/to/output.macp}}` +`pbmtomacp {{[-n|-norle]}} {{path/to/image.pbm}} > {{path/to/output.macp}}` diff --git a/pages/common/pbmtonokia.md b/pages/common/pbmtonokia.md index addac7d1a9..6d640d57a5 100644 --- a/pages/common/pbmtonokia.md +++ b/pages/common/pbmtonokia.md @@ -5,24 +5,24 @@ - Convert a PBM image into a Nokia Operator Logo as hexcode: -`pbmtonokia -fmt NEX_NOL -net {{network_operator_code}} {{path/to/image.pbm}} > {{path/to/output.hex}}` +`pbmtonokia {{[-f|-fmt]}} NEX_NOL -net {{network_operator_code}} {{path/to/image.pbm}} > {{path/to/output.hex}}` - Convert a PBM image into a Nokia Group Graphic as hexcode: -`pbmtonokia -fmt NEX_NGG {{path/to/image.pbm}} > {{path/to/output.hex}}` +`pbmtonokia {{[-f|-fmt]}} NEX_NGG {{path/to/image.pbm}} > {{path/to/output.hex}}` - Convert a PBM image into a Nokia Picture Message with the specified text as hexcode: -`pbmtonokia -fmt NEX_NPM -txt {{text_message}} {{path/to/image.pbm}} > {{path/to/output.hex}}` +`pbmtonokia {{[-f|-fmt]}} NEX_NPM -txt {{text_message}} {{path/to/image.pbm}} > {{path/to/output.hex}}` - Convert a PBM image into a Nokia Operator Logo as a NOL file: -`pbmtonokia -fmt NOL {{path/to/image.pbm}} > {{path/to/output.nol}}` +`pbmtonokia {{[-f|-fmt]}} NOL {{path/to/image.pbm}} > {{path/to/output.nol}}` - Convert a PBM image into a Nokia Group Graphic as an NGG file: -`pbmtonokia -fmt NGG {{path/to/image.pbm}} > {{path/to/output.ngg}}` +`pbmtonokia {{[-f|-fmt]}} NGG {{path/to/image.pbm}} > {{path/to/output.ngg}}` - Convert a PBM image into a Nokia Picture Message as an NPM file: -`pbmtonokia -fmt NPM {{path/to/image.pbm}} > {{path/to/output.npm}}` +`pbmtonokia {{[-f|-fmt]}} NPM {{path/to/image.pbm}} > {{path/to/output.npm}}` diff --git a/pages/common/pcxtoppm.md b/pages/common/pcxtoppm.md index ecfa3f202e..1d62b80961 100644 --- a/pages/common/pcxtoppm.md +++ b/pages/common/pcxtoppm.md @@ -9,8 +9,8 @@ - Use a predefined standard palette even if the PCX file provides one: -`pcxtoppm -stdpalette {{path/to/file.pcx}} > {{path/to/file.ppm}}` +`pcxtoppm {{[-s|-stdpalette]}} {{path/to/file.pcx}} > {{path/to/file.ppm}}` - Print information on the PCX header to `stdout`: -`pcxtoppm -verbose {{path/to/file.pcx}} > {{path/to/file.ppm}}` +`pcxtoppm {{[-verb|-verbose]}} {{path/to/file.pcx}} > {{path/to/file.ppm}}` diff --git a/pages/common/pgmhist.md b/pages/common/pgmhist.md index 03259b17c8..af577426b2 100644 --- a/pages/common/pgmhist.md +++ b/pages/common/pgmhist.md @@ -10,16 +10,16 @@ - Display the median grey value: -`pgmhist -median {{path/to/image.pgm}}` +`pgmhist {{[-me|-median]}} {{path/to/image.pgm}}` - Display four quartile grey value: -`pgmhist -quartile {{path/to/image.pgm}}` +`pgmhist {{[-qua|-quartile]}} {{path/to/image.pgm}}` - Report the existence of invalid grey values: -`pgmhist -forensic {{path/to/image.pgm}}` +`pgmhist {{[-f|-forensic]}} {{path/to/image.pgm}}` - Display machine-readable output: -`pgmhist -machine {{path/to/image.pgm}}` +`pgmhist {{[-ma|-machine]}} {{path/to/image.pgm}}` diff --git a/pages/common/pgmkernel.md b/pages/common/pgmkernel.md index 4d96f35cbe..358e6874c8 100644 --- a/pages/common/pgmkernel.md +++ b/pages/common/pgmkernel.md @@ -14,4 +14,4 @@ - Specify the weight of the center in the generated kernel: -`pgmkernel -weight {{value}} {{width}} {{height}} > {{path/to/output.pgm}}` +`pgmkernel {{[-w|-weight]}} {{value}} {{width}} {{height}} > {{path/to/output.pgm}}` diff --git a/pages/common/pgmtoppm.md b/pages/common/pgmtoppm.md index b07211eb0a..5660fcd773 100644 --- a/pages/common/pgmtoppm.md +++ b/pages/common/pgmtoppm.md @@ -5,8 +5,8 @@ - Map all greyscale values of the input image to all colors between the two specified colors: -`pgmtoppm -black {{red}} --white {{blue}} {{path/to/input.pgm}} > {{path/to/output.ppm}}` +`pgmtoppm {{[-b|-black]}} {{red}} {{[-w|-white]}} {{blue}} {{path/to/input.pgm}} > {{path/to/output.ppm}}` - Map all greyscale values of the input image to colors according to the specified colormap: -`pgmtoppm -map {{path/to/colormap.ppm}} {{path/to/input.pgm}} > {{path/to/output.ppm}}` +`pgmtoppm {{[-m|-map]}} {{path/to/colormap.ppm}} {{path/to/input.pgm}} > {{path/to/output.ppm}}` diff --git a/pages/common/picttoppm.md b/pages/common/picttoppm.md index 084b073d93..0e5ba69f07 100644 --- a/pages/common/picttoppm.md +++ b/pages/common/picttoppm.md @@ -9,8 +9,8 @@ - Force any images in the PICT file to be output at full resolution: -`picttoppm -fullres {{path/to/file.pict}} > {{path/to/file.ppm}}` +`picttoppm {{[-fu|-fullres]}} {{path/to/file.pict}} > {{path/to/file.ppm}}` - Do not assume that the input file contains a PICT header and execute quickdraw operations only: -`picttoppm -noheader -quickdraw {{path/to/file.pict}} > {{path/to/file.ppm}}` +`picttoppm {{[-n|-noheader]}} {{[-quic|-quickdraw]}} {{path/to/file.pict}} > {{path/to/file.ppm}}` diff --git a/pages/common/pngtopam.md b/pages/common/pngtopam.md index 7ff269dd85..06e2d2e5a6 100644 --- a/pages/common/pngtopam.md +++ b/pages/common/pngtopam.md @@ -14,8 +14,8 @@ - Replace transparent pixels by the specified color: -`pngtopam -mix -background {{color}} {{path/to/image.png}} > {{path/to/output.pam}}` +`pngtopam {{[-m|-mix]}} {{[-ba|-background]}} {{color}} {{path/to/image.png}} > {{path/to/output.pam}}` - Write tEXt chunks found in the input image to the specified text file: -`pngtopam -text {{path/to/file.txt}} {{path/to/image.png}} > {{path/to/output.pam}}` +`pngtopam {{[-te|-text]}} {{path/to/file.txt}} {{path/to/image.png}} > {{path/to/output.pam}}` diff --git a/pages/common/pnmalias.md b/pages/common/pnmalias.md index 429e89d33c..eb69f8fd68 100644 --- a/pages/common/pnmalias.md +++ b/pages/common/pnmalias.md @@ -13,8 +13,8 @@ - Apply altialiasing to foreground pixels only: -`pnmalias -fonly {{path/to/input.pnm}} > {{path/to/output.ppm}}` +`pnmalias {{[-fo|-fonly]}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` - Apply antialiasing to all surrounding pixels of background pixels: -`pnmalias -balias {{path/to/input.pnm}} > {{path/to/output.ppm}}` +`pnmalias {{[-ba|-balias]}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` diff --git a/pages/common/pnmcolormap.md b/pages/common/pnmcolormap.md index f0bd7330ce..bd61116e30 100644 --- a/pages/common/pnmcolormap.md +++ b/pages/common/pnmcolormap.md @@ -9,8 +9,8 @@ - Use the splitspread strategy for determining the output colors, possibly producing a better result for images with small details: -`pnmcolormap -splitspread {{n_colors}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` +`pnmcolormap {{[-splits|-splitspread]}} {{n_colors}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` - Sort the resulting colormap, which is useful for comparing colormaps: -`pnmcolormap -sort {{path/to/input.pnm}} > {{path/to/output.ppm}}` +`pnmcolormap {{[-so|-sort]}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` diff --git a/pages/common/pnmcrop.md b/pages/common/pnmcrop.md index c0a70050c4..b27f542980 100644 --- a/pages/common/pnmcrop.md +++ b/pages/common/pnmcrop.md @@ -5,11 +5,11 @@ - Remove white borders on a PNM image: -`pnmcrop -white {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmcrop {{[-w|-white]}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Remove borders of the specified color that are on the top and left side of the image: -`pnmcrop -bg-color {{color}} -top -left {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmcrop -bg-color {{color}} {{[-t|-top]}} {{[-l|-left]}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Determine the color of the borders to be removed by the color of the pixel in the specified corner: @@ -17,4 +17,4 @@ - Leave a border with a width of `n` pixels. Additionally, specify the behaviour if the image is entirely made out of background: -`pnmcrop -margins {{n}} -blank-image {{pass|minimize|maxcrop}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmcrop {{[-m|-margin]}} {{n}} {{[-blan|-blank-image]}} {{pass|minimize|maxcrop}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmgamma.md b/pages/common/pnmgamma.md index fed6681baf..cf3834404c 100644 --- a/pages/common/pnmgamma.md +++ b/pages/common/pnmgamma.md @@ -13,8 +13,8 @@ - Specify the gamma value used for the gamma transfer function: -`pnmgamma -gamma {{value}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmgamma {{[-ga|-gamma]}} {{value}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Specify the gamma value used for the gamma transfer function per color component: -`pnmgamma -rgamma {{value}} -ggamma {{value}} -bgamma {{value}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmgamma {{[-rg|-rgamma]}} {{value}} {{[-gg|-ggamma]}} {{value}} {{[-bg|-bgamma]}} {{value}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmhisteq.md b/pages/common/pnmhisteq.md index 95710ee2f5..e13872eb72 100644 --- a/pages/common/pnmhisteq.md +++ b/pages/common/pnmhisteq.md @@ -9,7 +9,7 @@ - Only modify grey pixels: -`pnmhisteq -grey {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmhisteq {{[-g|-grey]}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Do not include black or white pixels in the histogram equalization: diff --git a/pages/common/pnmhistmap.md b/pages/common/pnmhistmap.md index 5b3dc477b5..9e723548fc 100644 --- a/pages/common/pnmhistmap.md +++ b/pages/common/pnmhistmap.md @@ -9,8 +9,8 @@ - Draw the histogram as dots instead of bars: -`pnmhistmap -dots {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmhistmap {{[-d|-dots]}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Specify the range of intensity values to include: -`pnmhistmap -lval {{minval}} -rval {{maxval}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmhistmap {{[-l|-lval]}} {{minval}} {{[-rv|-rval]}} {{maxval}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmindex.md b/pages/common/pnmindex.md index 4dfbf39f12..4d58e658b8 100644 --- a/pages/common/pnmindex.md +++ b/pages/common/pnmindex.md @@ -10,12 +10,12 @@ - Specify the size of the (quadratic) thumbnails: -`pnmindex -size {{50}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` +`pnmindex {{[-s|-size]}} {{50}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` - Specify the number of thumbnails per row: -`pnmindex -across {{10}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` +`pnmindex {{[-a|-across]}} {{10}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` - Specify the maximum number of colors in the output: -`pnmindex -colors {{512}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` +`pnmindex {{[-c|-colors]}} {{512}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmmargin.md b/pages/common/pnmmargin.md index 2e5e21e303..047a803ced 100644 --- a/pages/common/pnmmargin.md +++ b/pages/common/pnmmargin.md @@ -9,4 +9,4 @@ - Specify the color of the border: -`pnmmargin -color {{color}} {{size}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmmargin {{[-c|-color]}} {{color}} {{size}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmmercator.md b/pages/common/pnmmercator.md index 02f86f5066..0d9fe1087d 100644 --- a/pages/common/pnmmercator.md +++ b/pages/common/pnmmercator.md @@ -10,4 +10,4 @@ - Convert a Mercator projection worldmap to rectangular projection: -`pnmmercator -inverse {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmmercator {{[-i|-inverse]}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmmontage.md b/pages/common/pnmmontage.md index a51f7ea7d0..683464ac2b 100644 --- a/pages/common/pnmmontage.md +++ b/pages/common/pnmmontage.md @@ -13,8 +13,8 @@ - Produce a packing that is not larger than `p` percent of the optimal packing: -`pnmmontage -quality {{p}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` +`pnmmontage {{[-qua|-quality]}} {{p}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` - Write the positions of the input files within the packed image to a machine-readable file: -`pnmmontage -data {{path/to/datafile}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` +`pnmmontage {{[-d|-data]}} {{path/to/datafile}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmnorm.md b/pages/common/pnmnorm.md index 69185f9bc1..8797f01770 100644 --- a/pages/common/pnmnorm.md +++ b/pages/common/pnmnorm.md @@ -10,11 +10,11 @@ - Force the brightest pixels to be white, the darkest pixels to be black and spread out the ones in between quadratically such that pixels with a brightness of `n` become 50 % bright: -`pnmnorm -midvalue {{n}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmnorm {{[-midv|-midvalue]}} {{n}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Keep the pixels' hue, only modify the brightness: -`pnmnorm -keephues {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmnorm {{[-k|-keephues]}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Specify a method to calculate a pixel's brightness: diff --git a/pages/common/pnmpad.md b/pages/common/pnmpad.md index fff6452100..f2b5aad493 100644 --- a/pages/common/pnmpad.md +++ b/pages/common/pnmpad.md @@ -6,16 +6,16 @@ - Add borders of the specified sizes to the image: -`pnmpad -left {{100}} -right {{150}} -top {{123}} -bottom {{456}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmpad {{[-l|-left]}} {{100}} {{[-ri|-right]}} {{150}} {{[-t|-top]}} {{123}} {{[-bo|-bottom]}} {{456}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Pad the image to the specified size: -`pnmpad -width {{1000}} -height {{500}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmpad {{[-wi|-width]}} {{1000}} {{[-he|-height]}} {{500}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Pad the width of the image to the specified size, controlling the ratio between right and left padding: -`pnmpad -width {{1000}} -halign {{0.7}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmpad {{[-wi|-width]}} {{1000}} {{[-ha|-halign]}} {{0.7}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` - Pad the width of the image using the specified color: -`pnmpad -width {{1000}} -color {{red}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` +`pnmpad {{[-wi|-width]}} {{1000}} {{[-c|-color]}} {{red}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmquantall.md b/pages/common/pnmquantall.md index 5ddb949bae..81214e9d28 100644 --- a/pages/common/pnmquantall.md +++ b/pages/common/pnmquantall.md @@ -10,4 +10,4 @@ - Save the quantised images to files named the same as the input files, but with the specified extension appended: -`pnmquantall -ext {{extension}} {{n_colors}} {{path/to/input1.pnm path/to/input2.pnm ...}}` +`pnmquantall {{[-e|-ext]}} {{extension}} {{n_colors}} {{path/to/input1.pnm path/to/input2.pnm ...}}` diff --git a/pages/common/pnmremap.md b/pages/common/pnmremap.md index e50432b7e4..fc04d5eac0 100644 --- a/pages/common/pnmremap.md +++ b/pages/common/pnmremap.md @@ -5,16 +5,16 @@ - Replace the colors in an image with those in the specified color palette: -`pnmremap -mapfile {{path/to/palette_file.ppm}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmremap {{[-ma|-mapfile]}} {{path/to/palette_file.ppm}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Use Floyd-Steinberg dithering for representing colors missing in the color palette: -`pnmremap -mapfile {{path/to/palette_file.ppm}} -floyd {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmremap {{[-ma|-mapfile]}} {{path/to/palette_file.ppm}} {{[-fs|-floyd]}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Use the first color in the palette for representing colors missing in the color palette: -`pnmremap -mapfile {{path/to/palette_file.ppm}} -firstisdefault {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmremap {{[-ma|-mapfile]}} {{path/to/palette_file.ppm}} {{[-fi|-firstisdefault]}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Use the specified color for representing colors missing in the color palette: -`pnmremap -mapfile {{path/to/palette_file.ppm}} -missingcolor {{color}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmremap {{[-ma|-mapfile]}} {{path/to/palette_file.ppm}} {{[-m|-missingcolor]}} {{color}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmrotate.md b/pages/common/pnmrotate.md index 6e19746801..abcecc5e16 100644 --- a/pages/common/pnmrotate.md +++ b/pages/common/pnmrotate.md @@ -9,8 +9,8 @@ - Specify the background color exposed by rotating the input image: -`pnmrotate -background {{color}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmrotate {{[-b|-background]}} {{color}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Disable anti-aliasing, improving performance but decreasing quality: -`pnmrotate -noantialias {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmrotate {{[-n|-noantialias]}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmscalefixed.md b/pages/common/pnmscalefixed.md index 080b75f6b4..7b2db73e25 100644 --- a/pages/common/pnmscalefixed.md +++ b/pages/common/pnmscalefixed.md @@ -6,12 +6,12 @@ - Scale an image such that the result has the specified dimensions: -`pnmscalefixed -width {{width}} -height {{height}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmscalefixed {{[-w|-width]}} {{width}} {{[-h|-height]}} {{height}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Scale an image such that the result has the specified width, keeping the aspect ratio: -`pnmscalefixed -width {{width}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmscalefixed {{[-w|-width]}} {{width}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Scale an image such that its width and height is changed by the specified factors: -`pnmscalefixed -xscale {{x_factor}} -yscale {{y_factor}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmscalefixed {{[-xsc|-xscale]}} {{x_factor}} {{[-ysc|-yscale]}} {{y_factor}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmshear.md b/pages/common/pnmshear.md index 8cd96428a5..eb42bb7531 100644 --- a/pages/common/pnmshear.md +++ b/pages/common/pnmshear.md @@ -9,8 +9,8 @@ - Specify the color of the background in the sheared image: -`pnmshear -background {{blue}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmshear {{[-b|-background]}} {{blue}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` - Do not perform anti-aliasing: -`pnmshear -noantialias {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmshear {{[-n|-noantialias]}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmsmooth.md b/pages/common/pnmsmooth.md index a1b486431d..edb366c50a 100644 --- a/pages/common/pnmsmooth.md +++ b/pages/common/pnmsmooth.md @@ -9,4 +9,4 @@ - Smooth out a PNM image using a convolution matrix of size width times height: -`pnmsmooth -width {{width}} -height {{height}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` +`pnmsmooth {{[-w|-width]}} {{width}} {{[-h|-height]}} {{height}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pages/common/pnmtoddif.md b/pages/common/pnmtoddif.md index d612126a94..7e1085c22b 100644 --- a/pages/common/pnmtoddif.md +++ b/pages/common/pnmtoddif.md @@ -9,4 +9,4 @@ - Explicitly specify the horizontal and vertical resolution of the output image: -`pnmtoddif -resolution {{horizontal_dpi}} {{vertical_dpi}} {{path/to/image.pnm}} > {{path/to/image.ddif}}` +`pnmtoddif {{[-r|-resolution]}} {{horizontal_dpi}} {{vertical_dpi}} {{path/to/image.pnm}} > {{path/to/image.ddif}}` diff --git a/pages/common/pnmtofiasco.md b/pages/common/pnmtofiasco.md index d9582407f6..6a5c72e4ee 100644 --- a/pages/common/pnmtofiasco.md +++ b/pages/common/pnmtofiasco.md @@ -13,7 +13,7 @@ - Specify the compression quality: -`pnmtofiasco {{[-q|--quality]}} {{quality_level}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` +`pnmtofiasco {{[-qua|--quality]}} {{quality_level}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` - Load the options to be used from the specified configuration file: diff --git a/pages/common/pnmtopalm.md b/pages/common/pnmtopalm.md index 018d22e738..e86ca905b7 100644 --- a/pages/common/pnmtopalm.md +++ b/pages/common/pnmtopalm.md @@ -9,7 +9,7 @@ - Specify the color depth of the resulting bitmap: -`pnmtopalm -depth {{1|2|4|8|16}} {{path/to/file.pnm}} > {{path/to/file.palm}}` +`pnmtopalm {{[-dep|-depth]}} {{1|2|4|8|16}} {{path/to/file.pnm}} > {{path/to/file.palm}}` - Choose a compression method for the resulting bitmap: @@ -17,8 +17,8 @@ - Build a custom colormap and include it in the resulting bitmap: -`pnmtopalm -colormap {{path/to/file.pnm}} > {{path/to/file.palm}}` +`pnmtopalm {{[-c|-colormap]}} {{path/to/file.pnm}} > {{path/to/file.palm}}` - Specify the bitmap's density: -`pnmtopalm -density {{72|108|144|216|288}} {{path/to/file.pnm}} > {{path/to/file.palm}}` +`pnmtopalm {{[-den|-density]}} {{72|108|144|216|288}} {{path/to/file.pnm}} > {{path/to/file.palm}}` diff --git a/pages/common/pnmtopclxl.md b/pages/common/pnmtopclxl.md index 1fd9ec4834..8531bab972 100644 --- a/pages/common/pnmtopclxl.md +++ b/pages/common/pnmtopclxl.md @@ -9,8 +9,8 @@ - Specify the resolution of the image as well as the location of the page from the upper left corner of each image: -`pnmtopclxl -dpi {{resolution}} -xoffs {{x_offset}} -yoffs {{y_offset}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` +`pnmtopclxl -dpi {{resolution}} {{[-x|-xoffs]}} {{x_offset}} {{[-y|-yoffs]}} {{y_offset}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` - Generate a duplex printer stream for the specified paper format: -`pnmtopclxl -duplex {{vertical|horizontal}} -format {{letter|legal|a3|a4|a5|...}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` +`pnmtopclxl {{[-du|-duplex]}} {{vertical|horizontal}} {{[-fo|-format]}} {{letter|legal|a3|a4|a5|...}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` diff --git a/pages/common/pnmtopng.md b/pages/common/pnmtopng.md index 1e06c2dc94..10fbc6a542 100644 --- a/pages/common/pnmtopng.md +++ b/pages/common/pnmtopng.md @@ -9,4 +9,4 @@ - Display version: -`pnmtopng -version` +`pnmtopng {{[-vers|-version]}}` diff --git a/pages/common/pnmtops.md b/pages/common/pnmtops.md index 5740f20326..6fe668f371 100644 --- a/pages/common/pnmtops.md +++ b/pages/common/pnmtops.md @@ -9,8 +9,8 @@ - Specify the dimensions of the output image in inches: -`pnmtops -imagewidth {{imagewidth}} -imageheight {{imageheight}} {{path/to/file.pnm}} > {{path/to/file.ps}}` +`pnmtops {{[-imagew|-imagewidth]}} {{imagewidth}} {{[-imageh|-imageheight]}} {{imageheight}} {{path/to/file.pnm}} > {{path/to/file.ps}}` - Specify the dimensions of the page the output image resides on in inches: -`pnmtops -width {{width}} -height {{height}} {{path/to/file.pnm}} > {{path/to/file.ps}}` +`pnmtops {{[-w|-width]}} {{width}} {{[-h|-height]}} {{height}} {{path/to/file.pnm}} > {{path/to/file.ps}}` diff --git a/pages/common/pnmtorle.md b/pages/common/pnmtorle.md index ef2ff4b23e..888f62dbb2 100644 --- a/pages/common/pnmtorle.md +++ b/pages/common/pnmtorle.md @@ -9,8 +9,8 @@ - Print PNM header information to `stdout`: -`pnmtorle -verbose {{path/to/input.pnm}} > {{path/to/output.rle}}` +`pnmtorle {{[-verb|-verbose]}} {{path/to/input.pnm}} > {{path/to/output.rle}}` - Include a transparency channel in the output image in which every black pixel is set to fully transparent and every other pixel is set to fully opaque: -`pnmtorle -alpha {{path/to/input.pnm}} > {{path/to/output.rle}}` +`pnmtorle {{[-a|-alpha]}} {{path/to/input.pnm}} > {{path/to/output.rle}}` diff --git a/pages/common/pnmtosgi.md b/pages/common/pnmtosgi.md index 3e9a684d78..be2d3d1f53 100644 --- a/pages/common/pnmtosgi.md +++ b/pages/common/pnmtosgi.md @@ -13,4 +13,4 @@ - Write the specified string into the SGI image header's `imagename` field: -`pnmtosgi -imagename {{string}} {{path/to/input.pnm}} > {{path/to/output.sgi}}` +`pnmtosgi {{[-i|-imagename]}} {{string}} {{path/to/input.pnm}} > {{path/to/output.sgi}}` diff --git a/pages/common/pnmtoxwd.md b/pages/common/pnmtoxwd.md index d3608126dc..72825d94f9 100644 --- a/pages/common/pnmtoxwd.md +++ b/pages/common/pnmtoxwd.md @@ -9,8 +9,8 @@ - Produce the output in the DirectColor format: -`pnmtoxwd -directcolor {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` +`pnmtoxwd {{[-d|-directcolor]}} {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` - Set the color depth of the output to b bits: -`pnmtoxwd -pseudodepth {{b}} {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` +`pnmtoxwd {{[-ps|-pseudodepth]}} {{b}} {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` diff --git a/pages/common/ppmchange.md b/pages/common/ppmchange.md index 24c395affb..a3fd7b2874 100644 --- a/pages/common/ppmchange.md +++ b/pages/common/ppmchange.md @@ -13,4 +13,4 @@ - Replace all pixels not specified in the arguments by a color: -`ppmchange -remainder {{color}} {{oldcolor1 newcolor1 oldcolor2 newcolor2 ...}} {{path/to/input.ppm}} > {{path/to/output.ppm}}` +`ppmchange {{[-r|-remainder]}} {{color}} {{oldcolor1 newcolor1 oldcolor2 newcolor2 ...}} {{path/to/input.ppm}} > {{path/to/output.ppm}}` diff --git a/pages/common/ppmcie.md b/pages/common/ppmcie.md index ce3940638f..2f1cc098ab 100644 --- a/pages/common/ppmcie.md +++ b/pages/common/ppmcie.md @@ -17,4 +17,4 @@ - Do not dim the area outside the Maxwell triangle: -`ppmcie -full > {{path/to/output.ppm}}` +`ppmcie {{[-f|-full]}} > {{path/to/output.ppm}}` diff --git a/pages/common/ppmcolormask.md b/pages/common/ppmcolormask.md index 604e5e01d9..a793f66ca3 100644 --- a/pages/common/ppmcolormask.md +++ b/pages/common/ppmcolormask.md @@ -5,4 +5,4 @@ - Produce a mask of areas of a certain color in the specified PPM image: -`ppmcolormask -color {{red,blue}} {{path/to/input.ppm}} > {{path/to/output.pbm}}` +`ppmcolormask {{[-c|-color]}} {{red,blue}} {{path/to/input.ppm}} > {{path/to/output.pbm}}` diff --git a/pages/common/ppmdither.md b/pages/common/ppmdither.md index 5efdf40002..3d700a52d3 100644 --- a/pages/common/ppmdither.md +++ b/pages/common/ppmdither.md @@ -9,8 +9,8 @@ - Specify the desired number of shades for each primary color: -`ppmdither -red {{2}} -green {{3}} -blue {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` +`ppmdither {{[-r|-red]}} {{2}} {{[-g|-green]}} {{3}} {{[-b|-blue]}} {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` - Specify the dimensions of the dithering matrix: -`ppmdither -dim {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` +`ppmdither {{[-d|-dim]}} {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` diff --git a/pages/common/ppmflash.md b/pages/common/ppmflash.md index b48ac4c68d..7a278bdb0b 100644 --- a/pages/common/ppmflash.md +++ b/pages/common/ppmflash.md @@ -9,4 +9,4 @@ - Display version: -`ppmflash -version` +`ppmflash {{[-v|-version]}}` diff --git a/pages/common/ppmforge.md b/pages/common/ppmforge.md index b309bdf8c6..3783ebbfec 100644 --- a/pages/common/ppmforge.md +++ b/pages/common/ppmforge.md @@ -13,8 +13,8 @@ - Use a custom mesh size and dimension for fractal generation and specify the dimensions of the output: -`ppmforge -mesh {{512}} -dimension {{2.5}} -xsize {{1000}} -ysize {{1000}} > {{path/to/image.ppm}}` +`ppmforge {{[-m|-mesh]}} {{512}} {{[-d|-dimension]}} {{2.5}} {{[-x|-xsize]}} {{1000}} {{[-y|-ysize]}} {{1000}} > {{path/to/image.ppm}}` - Control the tilt and the angle from which the generated planet is illuminated: -`ppmforge -tilt {{-15}} -hour {{12}} > {{path/to/image.ppm}}` +`ppmforge {{[-t|-tilt]}} {{-15}} {{[-ho|-hour]}} {{12}} > {{path/to/image.ppm}}` diff --git a/pages/common/ppmglobe.md b/pages/common/ppmglobe.md index e6ad7f7606..94c422e81d 100644 --- a/pages/common/ppmglobe.md +++ b/pages/common/ppmglobe.md @@ -10,4 +10,4 @@ - Use the specified color for the areas between the strips: -`ppmglobe -background {{red}} {{number_of_strips}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` +`ppmglobe {{[-b|-background]}} {{red}} {{number_of_strips}} {{path/to/image.ppm}} > {{path/to/output.ppm}}` diff --git a/pages/common/ppmhist.md b/pages/common/ppmhist.md index 4d26a83895..c49e685503 100644 --- a/pages/common/ppmhist.md +++ b/pages/common/ppmhist.md @@ -6,12 +6,12 @@ - Generate the histogram for human reading: -`ppmhist -nomap {{path/to/image.ppm}}` +`ppmhist {{[-nom|-nomap]}} {{path/to/image.ppm}}` - Generate a PPM file of the colormap for the image, with the color histogram as comments: -`ppmhist -map {{path/to/image.ppm}}` +`ppmhist {{[-m|-map]}} {{path/to/image.ppm}}` - Display version: -`ppmhist -version` +`ppmhist {{[-v|-version]}}` diff --git a/pages/common/ppmlabel.md b/pages/common/ppmlabel.md index 48dca3e3b6..2be3439a3e 100644 --- a/pages/common/ppmlabel.md +++ b/pages/common/ppmlabel.md @@ -5,12 +5,12 @@ - Add text to a PPM image at the specified location: -`ppmlabel -x {{pos_x}} -y {{pos_y}} -text {{text}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` +`ppmlabel -x {{pos_x}} -y {{pos_y}} {{[-t|-text]}} {{text}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` - Add multiple texts at different locations: -`ppmlabel -x {{pos_x1}} -y {{pos_y1}} -text {{text1}} -x {{pos_x2}} -y {{pos_y2}} -text {{text2}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` +`ppmlabel -x {{pos_x1}} -y {{pos_y1}} {{[-t|-text]}} {{text1}} -x {{pos_x2}} -y {{pos_y2}} {{[-t|-text]}} {{text2}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` - Specify the line color, the background color, the tilt and the size of the added text: -`ppmlabel -x {{pos_x}} -y {{pos_y}} -color {{line_color}} -background {{background_color}} -angle {{tilt}} -size {{size}} -text {{text}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` +`ppmlabel -x {{pos_x}} -y {{pos_y}} {{[-c|-color]}} {{line_color}} {{[-b|-background]}} {{background_color}} {{[-a|-angle]}} {{tilt}} {{[-s|-size]}} {{size}} {{[-t|-text]}} {{text}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/ppmntsc.md b/pages/common/ppmntsc.md index 872e0dec5c..f835d72a1b 100644 --- a/pages/common/ppmntsc.md +++ b/pages/common/ppmntsc.md @@ -13,7 +13,7 @@ - Print the number of illegal pixels in the input image to `stderr`: -`ppmntsc --verbose {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` +`ppmntsc {{[--verb|--verbose]}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` - Output only legal/illegal/corrected pixels, set other pixels to black: diff --git a/pages/common/ppmpat.md b/pages/common/ppmpat.md index 957d09c907..22bd0881a2 100644 --- a/pages/common/ppmpat.md +++ b/pages/common/ppmpat.md @@ -9,4 +9,4 @@ - Produce a PPM file of a camo pattern using the specified colors: -`ppmpat -camo -color {{color1,color2,...}} {{width}} {{height}} > {{path/to/file.ppm}}` +`ppmpat {{[-ca|-camo]}} {{[-co|-color]}} {{color1,color2,...}} {{width}} {{height}} > {{path/to/file.ppm}}` diff --git a/pages/common/ppmrainbow.md b/pages/common/ppmrainbow.md index a035647635..108c7b63d8 100644 --- a/pages/common/ppmrainbow.md +++ b/pages/common/ppmrainbow.md @@ -9,8 +9,8 @@ - Specify the size of the output in pixels: -`ppmrainbow -width {{width}} -height {{height}} {{color1 color2 ...}} > {{path/to/output_file.ppm}}` +`ppmrainbow {{[-w|-width]}} {{width}} {{[-h|-height]}} {{height}} {{color1 color2 ...}} > {{path/to/output_file.ppm}}` - End the rainbow with the last color specified, do not repeat the first color: -`ppmrainbow -norepeat {{color1 color2 ...}} > {{path/to/output_file.ppm}}` +`ppmrainbow {{[-n|-norepeat]}} {{color1 color2 ...}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/ppmspread.md b/pages/common/ppmspread.md index 637030da38..1179016abf 100644 --- a/pages/common/ppmspread.md +++ b/pages/common/ppmspread.md @@ -9,4 +9,4 @@ - Specify a seed to a the pseudo-random number generator: -`ppmspread {{a}} {{path/to/input_file.ppm}} -randomseed {{seed}} > {{path/to/output_file.ppm}}` +`ppmspread {{a}} {{path/to/input_file.ppm}} {{[-r|-randomseed]}} {{seed}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/ppmtoacad.md b/pages/common/ppmtoacad.md index 6c8930d56e..66ab09c2fe 100644 --- a/pages/common/ppmtoacad.md +++ b/pages/common/ppmtoacad.md @@ -9,7 +9,7 @@ - Convert a PPM image to an AutoCAD binary database import file: -`ppmtoacad -dxb {{path/to/file.ppm}} > {{path/to/file.dxb}}` +`ppmtoacad {{[-d|-dxb]}} {{path/to/file.ppm}} > {{path/to/file.dxb}}` - Restrict the colors in the output to 8 RGB shades: diff --git a/pages/common/ppmtoarbtxt.md b/pages/common/ppmtoarbtxt.md index 91e2f93cd9..7f568e3f17 100644 --- a/pages/common/ppmtoarbtxt.md +++ b/pages/common/ppmtoarbtxt.md @@ -17,4 +17,4 @@ - Display version: -`ppmtoarbtxt -version` +`ppmtoarbtxt {{[-v|-version]}}` diff --git a/pages/common/ppmtobmp.md b/pages/common/ppmtobmp.md index e0e7c2c12e..52f4e5d159 100644 --- a/pages/common/ppmtobmp.md +++ b/pages/common/ppmtobmp.md @@ -13,4 +13,4 @@ - Use a specific number of bits for each pixel: -`ppmtobmp -bbp {{1|4|8|24}} {{path/to/file.ppm}} > {{path/to/file.bmp}}` +`ppmtobmp {{[-b|-bbp]}} {{1|4|8|24}} {{path/to/file.ppm}} > {{path/to/file.bmp}}` diff --git a/pages/common/ppmtoicr.md b/pages/common/ppmtoicr.md index 0bc45199fa..ac347130ad 100644 --- a/pages/common/ppmtoicr.md +++ b/pages/common/ppmtoicr.md @@ -9,12 +9,12 @@ - Display the output in name: -`ppmtoicr -windowname {{name}} {{path/to/file.ppm}} > {{path/to/file.icr}}` +`ppmtoicr {{[-w|-windowname]}} {{name}} {{path/to/file.ppm}} > {{path/to/file.icr}}` - Expand the image by the specified factor: -`ppmtoicr -expand {{factor}} {{path/to/file.ppm}} > {{path/to/file.icr}}` +`ppmtoicr {{[-e|-expand]}} {{factor}} {{path/to/file.ppm}} > {{path/to/file.icr}}` - Display the output on the screen with the specified number: -`ppmtoicr -display {{number}} {{path/to/file.ppm}} > {{path/to/file.icr}}` +`ppmtoicr {{[-d|-display]}} {{number}} {{path/to/file.ppm}} > {{path/to/file.icr}}` diff --git a/pages/common/ppmtoilbm.md b/pages/common/ppmtoilbm.md index 644b635545..fa82d967b7 100644 --- a/pages/common/ppmtoilbm.md +++ b/pages/common/ppmtoilbm.md @@ -9,11 +9,11 @@ - Write a maximum of n planes to the ILBM file and produce a HAM/24bit/direct color file if this number is exceeded: -`ppmtoilbm -maxplanes {{n}} -{{hamif|24if|dcif}} {{path/to/file.ppm}} > {{path/to/file.ilbm}}` +`ppmtoilbm {{[-mp|-maxplanes]}} {{n}} -{{hamif|24if|dcif}} {{path/to/file.ppm}} > {{path/to/file.ilbm}}` - Produce a ILBM file with exactly n planes: -`ppmtoilbm -fixplanes {{n}} {{path/to/file.ppm}} > {{path/to/file.ilbm}}` +`ppmtoilbm {{[-fp|-fixplanes]}} {{n}} {{path/to/file.ppm}} > {{path/to/file.ilbm}}` - Select the compression method to be used: diff --git a/pages/common/ppmtolj.md b/pages/common/ppmtolj.md index c5a67b476a..711268fc36 100644 --- a/pages/common/ppmtolj.md +++ b/pages/common/ppmtolj.md @@ -9,8 +9,8 @@ - Apply a gamma correction using the specified gamma value: -`ppmtolj -gamma {{gamma}} {{path/to/input.ppm}} > {{path/to/output.lj}}` +`ppmtolj {{[-g|-gamma]}} {{gamma}} {{path/to/input.ppm}} > {{path/to/output.lj}}` - Specify the required resolution: -`ppmtolj -resolution {{75|100|150|300|600}} {{path/to/input.ppm}} > {{path/to/output.lj}}` +`ppmtolj {{[-r|-resolution]}} {{75|100|150|300|600}} {{path/to/input.ppm}} > {{path/to/output.lj}}` diff --git a/pages/common/ppmtomitsu.md b/pages/common/ppmtomitsu.md index 871f6ebf52..aa06178c15 100644 --- a/pages/common/ppmtomitsu.md +++ b/pages/common/ppmtomitsu.md @@ -9,8 +9,8 @@ - Enlarge the image by the specified factor, use the specified sharpness and produce `n` copies: -`ppmtomitsu -enlarge {{1|2|3}} -sharpness {{1|2|3|4}} -copy {{n}} {{path/to/file.ppm}} > {{path/to/file.mitsu}}` +`ppmtomitsu {{[-e|-enlarge]}} {{1|2|3}} {{[-s|-sharpness]}} {{1|2|3|4}} {{[-c|-copy]}} {{n}} {{path/to/file.ppm}} > {{path/to/file.mitsu}}` - Use the given medium for the printing process: -`ppmtomitsu -media {{A|A4|AS|A4S}} {{path/to/file.ppm}} > {{path/to/file.mitsu}}` +`ppmtomitsu {{[-m|-media]}} {{A|A4|AS|A4S}} {{path/to/file.ppm}} > {{path/to/file.mitsu}}` diff --git a/pages/common/ppmtompeg.md b/pages/common/ppmtompeg.md index 383c1c3695..8848bba108 100644 --- a/pages/common/ppmtompeg.md +++ b/pages/common/ppmtompeg.md @@ -9,11 +9,11 @@ - Encode the GOP with the specified number only: -`ppmtompeg -gop {{gop_num}} {{path/to/parameter_file}}` +`ppmtompeg {{[-g|-gop]}} {{gop_num}} {{path/to/parameter_file}}` - Specify the first and last frame to encode: -`ppmtompeg -frames {{first_frame}} {{last_frame}} {{path/to/parameter_file}}` +`ppmtompeg {{[-fr|-frames]}} {{first_frame}} {{last_frame}} {{path/to/parameter_file}}` - Combine multiple MPEG frames into a single MPEG-1 stream: diff --git a/pages/common/ppmtopgm.md b/pages/common/ppmtopgm.md index 8c7054dc1d..f27dc55ab1 100644 --- a/pages/common/ppmtopgm.md +++ b/pages/common/ppmtopgm.md @@ -9,4 +9,4 @@ - Display version: -`ppmtopgm -version` +`ppmtopgm {{[-v|-version]}}` diff --git a/pages/common/ppmtopj.md b/pages/common/ppmtopj.md index 9191ceba0b..24b05d563f 100644 --- a/pages/common/ppmtopj.md +++ b/pages/common/ppmtopj.md @@ -9,8 +9,8 @@ - Move the image in the x and y direction: -`ppmtopj -xpos {{dx}} -ypos {{dy}} {{path/to/input.ppm}} > {{path/to/output.pj}}` +`ppmtopj {{[-x|-xpos]}} {{dx}} {{[-y|-ypos]}} {{dy}} {{path/to/input.ppm}} > {{path/to/output.pj}}` - Explicitly specify a gamma value: -`ppmtopj -gamma {{gamma}} {{path/to/input.ppm}} > {{path/to/output.pj}}` +`ppmtopj {{[-g|-gamma]}} {{gamma}} {{path/to/input.ppm}} > {{path/to/output.pj}}` diff --git a/pages/common/ppmtopjxl.md b/pages/common/ppmtopjxl.md index fcad0fcd43..9255190a13 100644 --- a/pages/common/ppmtopjxl.md +++ b/pages/common/ppmtopjxl.md @@ -9,12 +9,12 @@ - Resize the input image: -`ppmtopjxl -xsize {{10cm}} -ysize {{5cm}} {{path/to/image.ppm}} > {{path/to/output.pjxl}}` +`ppmtopjxl {{[-xsi|-xsize]}} {{10cm}} {{[-ysi|-ysize]}} {{5cm}} {{path/to/image.ppm}} > {{path/to/output.pjxl}}` - Shift the input image: -`ppmtopjxl -xshift {{10pt}} -yshift {{5pt}} {{path/to/image.ppm}} > {{path/to/output.pjxl}}` +`ppmtopjxl {{[-xsh|-xshift]}} {{10pt}} {{[-ysh|-yshift]}} {{5pt}} {{path/to/image.ppm}} > {{path/to/output.pjxl}}` - Do not use the normal TIFF 4.0 compression method: -`ppmtopjxl -nopack {{path/to/image.ppm}} > {{path/to/output.pjxl}}` +`ppmtopjxl {{[-n|-nopack]}} {{path/to/image.ppm}} > {{path/to/output.pjxl}}` diff --git a/pages/common/ppmtoppm.md b/pages/common/ppmtoppm.md index b9a2d5d846..5ea35692d2 100644 --- a/pages/common/ppmtoppm.md +++ b/pages/common/ppmtoppm.md @@ -9,4 +9,4 @@ - Display version: -`ppmtoppm -version` +`ppmtoppm {{[-v|-version]}}` diff --git a/pages/common/ppmtosixel.md b/pages/common/ppmtosixel.md index ca0ef0e6f5..ab24828aec 100644 --- a/pages/common/ppmtosixel.md +++ b/pages/common/ppmtosixel.md @@ -9,11 +9,11 @@ - Produce an uncompressed SIXEL file that is much slower to print: -`ppmtosixel -raw {{path/to/file.ppm}} > {{path/to/file.sixel}}` +`ppmtosixel {{[-r|-raw]}} {{path/to/file.ppm}} > {{path/to/file.sixel}}` - Add a left margin of 1.5 inches: -`ppmtosixel -margin {{path/to/file.ppm}} > {{path/to/file.sixel}}` +`ppmtosixel {{[-m|-margin]}} {{path/to/file.ppm}} > {{path/to/file.sixel}}` - Encode control codes in a more portable (although less space-efficient) way: diff --git a/pages/common/ppmtoxpm.md b/pages/common/ppmtoxpm.md index 60f61faa66..40a233a92c 100644 --- a/pages/common/ppmtoxpm.md +++ b/pages/common/ppmtoxpm.md @@ -9,12 +9,12 @@ - Specify the prefix string in the output XPM image: -`ppmtoxpm -name {{prefix_string}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` +`ppmtoxpm {{[-n|-name]}} {{prefix_string}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` - In the output XPM file, specify colors by their hexadecimal code instead of their name: -`ppmtoxpm -hexonly {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` +`ppmtoxpm {{[-h|-hexonly]}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` - Use the specified PGM file as a transparency mask: -`ppmtoxpm -alphamask {{path/to/alpha_file.pgm}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` +`ppmtoxpm {{[-a|-alphamask]}} {{path/to/alpha_file.pgm}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` diff --git a/pages/common/ppmtv.md b/pages/common/ppmtv.md index d6c56291f4..42864f3d07 100644 --- a/pages/common/ppmtv.md +++ b/pages/common/ppmtv.md @@ -10,8 +10,8 @@ - Suppress all informational messages: -`ppmtv -quiet` +`ppmtv {{[-q|-quiet]}}` - Display version: -`ppmtv -version` +`ppmtv {{[-v|-version]}}` diff --git a/pages/common/ppmwheel.md b/pages/common/ppmwheel.md index 1f0fe53190..be7d3453d7 100644 --- a/pages/common/ppmwheel.md +++ b/pages/common/ppmwheel.md @@ -9,8 +9,8 @@ - Generate a color wheel of type `Hue-value`: -`ppmwheel -huevalue {{diameter}} > {{path/to/output.ppm}}` +`ppmwheel {{[-huev|-huevalue]}} {{diameter}} > {{path/to/output.ppm}}` - Generate a color wheel of type `Hue-saturation`: -`ppmwheel -huesaturation {{diameter}} > {{path/to/output.ppm}}` +`ppmwheel {{[-hues|-huesaturation]}} {{diameter}} > {{path/to/output.ppm}}` diff --git a/pages/common/rasttopnm.md b/pages/common/rasttopnm.md index f6b3e574ce..ff796423d4 100644 --- a/pages/common/rasttopnm.md +++ b/pages/common/rasttopnm.md @@ -9,4 +9,4 @@ - Use the color map indices in the raster if they are color values: -`rasttopnm -index {{path/to/input.rast}} > {{path/to/output.pnm}}` +`rasttopnm {{[-i|-index]}} {{path/to/input.rast}} > {{path/to/output.pnm}}` diff --git a/pages/common/rawtopgm.md b/pages/common/rawtopgm.md index cd60b294e1..3205169c23 100644 --- a/pages/common/rawtopgm.md +++ b/pages/common/rawtopgm.md @@ -13,20 +13,20 @@ - Convert a raw greyscale image in which the pixels come bottom-first instead of top-first to a PGM image: -`rawtopgm {{width}} {{height}} -bottomfirst {{path/to/image.raw}} > {{path/to/output.pgm}}` +`rawtopgm {{width}} {{height}} {{[-bt|-bottomfirst]}} {{path/to/image.raw}} > {{path/to/output.pgm}}` - Ignore the first `n` bytes of the specified file: -`rawtopgm {{width}} {{height}} -headerskip {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` +`rawtopgm {{width}} {{height}} {{[-h|-headerskip]}} {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` - Ignore the last m bytes of each row in the specified file: -`rawtopgm {{width}} {{height}} -rowskip {{m}} {{path/to/image.raw}} > {{path/to/output.pgm}}` +`rawtopgm {{width}} {{height}} {{[-r|-rowskip]}} {{m}} {{path/to/image.raw}} > {{path/to/output.pgm}}` - Specify the maxval for the grey values in the input to be equal to `n`: -`rawtopgm {{width}} {{height}} -maxval {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` +`rawtopgm {{width}} {{height}} {{[-m|-maxval]}} {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` - Specify the number of bytes that represent each sample in the input and that the byte-sequence is to be interpreted as little-endian: -`rawtopgm {{width}} {{height}} -bpp {{1|2}} -littleendian {{path/to/image.raw}} > {{path/to/output.pgm}}` +`rawtopgm {{width}} {{height}} -bpp {{1|2}} {{[-l|-littleendian]}} {{path/to/image.raw}} > {{path/to/output.pgm}}` diff --git a/pages/common/rawtoppm.md b/pages/common/rawtoppm.md index 000a3cc7d7..4301996c90 100644 --- a/pages/common/rawtoppm.md +++ b/pages/common/rawtoppm.md @@ -9,15 +9,15 @@ - Convert a raw RGB stream in which the pixels come bottom-first instead of top-first to a PPM image: -`rawtoppm {{width}} {{height}} {{path/to/image.raw}} | pamflip -tb > {{path/to/output.ppm}}` +`rawtoppm {{width}} {{height}} {{path/to/image.raw}} | pamflip {{[-tb|-topbottom]}} > {{path/to/output.ppm}}` - Ignore the first n bytes of the specified file: -`rawtoppm {{width}} {{height}} -headerskip {{n}} {{path/to/image.raw}} > {{path/to/output.ppm}}` +`rawtoppm {{width}} {{height}} {{[-h|-headerskip]}} {{n}} {{path/to/image.raw}} > {{path/to/output.ppm}}` - Ignore the last m bytes of each row in the specified file: -`rawtoppm {{width}} {{height}} -rowskip {{m}} {{path/to/image.raw}} > {{path/to/output.ppm}}` +`rawtoppm {{width}} {{height}} {{[-ro|-rowskip]}} {{m}} {{path/to/image.raw}} > {{path/to/output.ppm}}` - Specify the order of color components for each pixel: diff --git a/pages/common/rletopnm.md b/pages/common/rletopnm.md index d67bb9b13a..24125f432d 100644 --- a/pages/common/rletopnm.md +++ b/pages/common/rletopnm.md @@ -9,8 +9,8 @@ - Create a PGM image containing the RLE file's alpha channel: -`rletopnm -alphaout {{path/to/alpha_file.pgm}} {{path/to/input.rle}} > {{path/to/output.pnm}}` +`rletopnm {{[--a|--alphaout]}} {{path/to/alpha_file.pgm}} {{path/to/input.rle}} > {{path/to/output.pnm}}` - Operate in verbose mode and print the contents of the RLE header to `stdout`: -`rletopnm -verbose {{path/to/input.rle}} > {{path/to/output.pnm}}` +`rletopnm {{[--verb|--verbose]}} {{path/to/input.rle}} > {{path/to/output.pnm}}` diff --git a/pages/common/sgitopnm.md b/pages/common/sgitopnm.md index 5f809e6036..706a4a587d 100644 --- a/pages/common/sgitopnm.md +++ b/pages/common/sgitopnm.md @@ -9,8 +9,8 @@ - Display information about the SGI file: -`sgitopnm -verbose {{path/to/input.sgi}} > {{path/to/output.pnm}}` +`sgitopnm {{[-verb|-verbose]}} {{path/to/input.sgi}} > {{path/to/output.pnm}}` - Extract channel n of the SGI file: -`sgitopnm -channel {{n}} {{path/to/input.sgi}} > {{path/to/output.pnm}}` +`sgitopnm {{[-c|-channel]}} {{n}} {{path/to/input.sgi}} > {{path/to/output.pnm}}` diff --git a/pages/common/sldtoppm.md b/pages/common/sldtoppm.md index 0f8beb22d7..4c479525d2 100644 --- a/pages/common/sldtoppm.md +++ b/pages/common/sldtoppm.md @@ -9,4 +9,4 @@ - Compensate for non-square pixels by scaling the width of the image: -`sldtoppm -adjust {{path/to/input.sld}} > {{path/to/output.ppm}}` +`sldtoppm {{[-a|-adjust]}} {{path/to/input.sld}} > {{path/to/output.ppm}}` diff --git a/pages/common/svgtopam.md b/pages/common/svgtopam.md index c62251d8b7..7ac143f44e 100644 --- a/pages/common/svgtopam.md +++ b/pages/common/svgtopam.md @@ -9,4 +9,4 @@ - Emit textual output describing the input image: -`svgtopam -trace {{path/to/file.svg}}` +`svgtopam {{[-t|-trace]}} {{path/to/file.svg}}` diff --git a/pages/common/tgatoppm.md b/pages/common/tgatoppm.md index 63e0a529c1..caca1d7172 100644 --- a/pages/common/tgatoppm.md +++ b/pages/common/tgatoppm.md @@ -9,12 +9,12 @@ - Dump information from the TGA header to `stdout`: -`tgatoppm --headerdump {{path/to/file.tga}} > {{path/to/output.ppm}}` +`tgatoppm {{[-h|-headerdump]}} {{path/to/file.tga}} > {{path/to/output.ppm}}` - Write the transparency channel values of the input image to the specified file: -`tgatoppm --alphaout {{path/to/transparency_file.pgm}} {{path/to/file.tga}} > {{path/to/output.ppm}}` +`tgatoppm {{[-a|-alphaout]}} {{path/to/transparency_file.pgm}} {{path/to/file.tga}} > {{path/to/output.ppm}}` - Display version: -`tgatoppm -version` +`tgatoppm {{[-v|-version]}}` diff --git a/pages/common/thinkjettopbm.md b/pages/common/thinkjettopbm.md index 656bc2203d..7513a667dc 100644 --- a/pages/common/thinkjettopbm.md +++ b/pages/common/thinkjettopbm.md @@ -9,4 +9,4 @@ - Print debug information to `stderr`: -`thinkjettopbm -d {{path/to/input}} > {{path/to/output.pbm}}` +`thinkjettopbm {{[-d|-debug]}} {{path/to/input}} > {{path/to/output.pbm}}` diff --git a/pages/common/tifftopnm.md b/pages/common/tifftopnm.md index 56c6ae40a3..8810f12b29 100644 --- a/pages/common/tifftopnm.md +++ b/pages/common/tifftopnm.md @@ -9,12 +9,12 @@ - Create a PGM file containing the alpha channel of the input image: -`tifftopnm -alphaout {{path/to/alpha_file.pgm}} {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` +`tifftopnm {{[-a|-alphaout]}} {{path/to/alpha_file.pgm}} {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` - Respect the `fillorder` tag in the input TIFF image: -`tifftopnm -respectfillorder {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` +`tifftopnm {{[-r|-respectfillorder]}} {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` - Print TIFF header information to `stderr`: -`tifftopnm -headerdump {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` +`tifftopnm {{[-h|-headerdump]}} {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` diff --git a/pages/common/winicontopam.md b/pages/common/winicontopam.md index d07f727ed4..4c627550ff 100644 --- a/pages/common/winicontopam.md +++ b/pages/common/winicontopam.md @@ -9,12 +9,12 @@ - Convert all images in the input file to PAM: -`winicontopam -allimages {{path/to/input_file.ico}} > {{path/to/output.pam}}` +`winicontopam {{[-al|-allimages]}} {{path/to/input_file.ico}} > {{path/to/output.pam}}` - Convert the n'th image in the input file to PAM: -`winicontopam -image {{n}} {{path/to/input_file.ico}} > {{path/to/output.pam}}` +`winicontopam {{[-i|-image]}} {{n}} {{path/to/input_file.ico}} > {{path/to/output.pam}}` - If the image(s) to be extracted contain graded transparency data and an AND mask, write the AND mask into the fifth channel of the output PAM file: -`winicontopam -andmasks {{path/to/input_file.ico}} > {{path/to/output.pam}}` +`winicontopam {{[-an|-andmasks]}} {{path/to/input_file.ico}} > {{path/to/output.pam}}` diff --git a/pages/common/ximtoppm.md b/pages/common/ximtoppm.md index bdbf5a203b..b6c61575db 100644 --- a/pages/common/ximtoppm.md +++ b/pages/common/ximtoppm.md @@ -9,4 +9,4 @@ - Store the transparency mask of the input image in the specified file: -`ximtoppm --alphaout {{path/to/alpha_file.pbm}} {{path/to/input_file.xim}} > {{path/to/output_file.ppm}}` +`ximtoppm {{[-a|-alphaout]}} {{path/to/alpha_file.pbm}} {{path/to/input_file.xim}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/xpmtoppm.md b/pages/common/xpmtoppm.md index c00f8e9a2d..2b9382d5b3 100644 --- a/pages/common/xpmtoppm.md +++ b/pages/common/xpmtoppm.md @@ -9,4 +9,4 @@ - Store the transparency mask of the input image in the specified file: -`xpmtoppm --alphaout {{path/to/alpha_file.pbm}} {{path/to/input_file.xpm}} > {{path/to/output_file.ppm}}` +`xpmtoppm {{[-a|--alphaout]}} {{path/to/alpha_file.pbm}} {{path/to/input_file.xpm}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/xwdtopnm.md b/pages/common/xwdtopnm.md index a6d81f2965..0c220545fe 100644 --- a/pages/common/xwdtopnm.md +++ b/pages/common/xwdtopnm.md @@ -9,8 +9,8 @@ - Display information about the conversion process: -`xwdtopnm -verbose {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` +`xwdtopnm {{[-verb|-verbose]}} {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` - Display the contents of the X11 header of the input file: -`xwdtopnm -headerdump {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` +`xwdtopnm {{[-h|-headerdump]}} {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` diff --git a/pages/common/yuy2topam.md b/pages/common/yuy2topam.md index ebc993ecd6..19022ccaad 100644 --- a/pages/common/yuy2topam.md +++ b/pages/common/yuy2topam.md @@ -5,4 +5,4 @@ - Convert YUY2 bytes to PAM: -`yuy2topam -width {{value}} -height {{value}} {{path/to/file.yuy2}} > {{path/to/file.pam}}` +`yuy2topam {{[-w|-width]}} {{value}} {{[-h|-height]}} {{value}} {{path/to/file.yuy2}} > {{path/to/file.pam}}`