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..f988f627f6 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 {{[-v|-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/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/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/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/palmtopnm.md b/pages/common/palmtopnm.md index c818426fe8..f07fb1fc39 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 {{[-v|-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/pamcomp.md b/pages/common/pamcomp.md index b01b429f90..b86b17f80a 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 {{[-v|-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/pamcut.md b/pages/common/pamcut.md index 34f54960a5..dd72c1f9f2 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}} {{[-p|-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..cf8869060f 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}} {{[-v|-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/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/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/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/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..f836c99c78 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 {{[-p|-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..2f3ba8d67a 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 {{[-v|-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}}`