diff --git a/tldr/anytopnm b/tldr/anytopnm index 04790376..ab5b2281 100644 --- a/tldr/anytopnm +++ b/tldr/anytopnm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`anytopnm -version` +`anytopnm {{[-v|-version]}}` diff --git a/tldr/asciitopgm b/tldr/asciitopgm index 668ff257..86e75a79 100644 --- a/tldr/asciitopgm +++ b/tldr/asciitopgm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`asciitopgm -version` +`asciitopgm {{[-v|-version]}}` diff --git a/tldr/bioradtopgm b/tldr/bioradtopgm index 29e87834..d0ca8bd5 100644 --- a/tldr/bioradtopgm +++ b/tldr/bioradtopgm @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`bioradtopgm -version` +`bioradtopgm {{[-v|-version]}}` diff --git a/tldr/bmptopnm b/tldr/bmptopnm index 8b43cf2b..d20b4ba2 100644 --- a/tldr/bmptopnm +++ b/tldr/bmptopnm @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/brushtopbm b/tldr/brushtopbm index d533a0db..b4510e6b 100644 --- a/tldr/brushtopbm +++ b/tldr/brushtopbm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`brushtopbm -version` +`brushtopbm {{[-v|-version]}}` diff --git a/tldr/fitstopnm b/tldr/fitstopnm index 62a873f4..6db7661b 100644 --- a/tldr/fitstopnm +++ b/tldr/fitstopnm @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/gemtopnm b/tldr/gemtopnm index 6f6a138a..f041a78c 100644 --- a/tldr/gemtopnm +++ b/tldr/gemtopnm @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/giftopnm b/tldr/giftopnm index 10466128..3f7eca9e 100644 --- a/tldr/giftopnm +++ b/tldr/giftopnm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`giftopnm -version` +`giftopnm {{[-v|-version]}}` diff --git a/tldr/hipstopgm b/tldr/hipstopgm index 8cf8f475..0fca0c62 100644 --- a/tldr/hipstopgm +++ b/tldr/hipstopgm @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Suppress all informational messages: -`hipstopgm -quiet` +`hipstopgm {{[-q|-quiet]}}` - Display version: -`hipstopgm -version` +`hipstopgm {{[-v|-version]}}` diff --git a/tldr/ilbmtoppm b/tldr/ilbmtoppm index 98846ad4..103865c4 100644 --- a/tldr/ilbmtoppm +++ b/tldr/ilbmtoppm @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/imgtoppm b/tldr/imgtoppm index 03772483..e4f4c6a1 100644 --- a/tldr/imgtoppm +++ b/tldr/imgtoppm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`imgtoppm -version` +`imgtoppm {{[-v|-version]}}` diff --git a/tldr/jpegtopnm b/tldr/jpegtopnm index ecb430b5..3dd44000 100644 --- a/tldr/jpegtopnm +++ b/tldr/jpegtopnm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`jpegtopnm -version` +`jpegtopnm {{[-v|-version]}}` diff --git a/tldr/leaftoppm b/tldr/leaftoppm index 002a1e62..d39361f5 100644 --- a/tldr/leaftoppm +++ b/tldr/leaftoppm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`leaftoppm -version` +`leaftoppm {{[-v|-version]}}` diff --git a/tldr/macptopbm b/tldr/macptopbm index 43e93c1e..a95a7d00 100644 --- a/tldr/macptopbm +++ b/tldr/macptopbm @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/neotoppm b/tldr/neotoppm index f20a5718..f1e3dc3d 100644 --- a/tldr/neotoppm +++ b/tldr/neotoppm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`neotoppm -version` +`neotoppm {{[-v|-version]}}` diff --git a/tldr/palmtopnm b/tldr/palmtopnm index 3d621fec..52b3161c 100644 --- a/tldr/palmtopnm +++ b/tldr/palmtopnm @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pambrighten b/tldr/pambrighten index 3fe3e885..4b846765 100644 --- a/tldr/pambrighten +++ b/tldr/pambrighten @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamcomp b/tldr/pamcomp index 5d999a7b..9a75890e 100644 --- a/tldr/pamcomp +++ b/tldr/pamcomp @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamcrater b/tldr/pamcrater index f502fb8e..cfc81ac8 100644 --- a/tldr/pamcrater +++ b/tldr/pamcrater @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamcut b/tldr/pamcut index 895fb444..6eae884f 100644 --- a/tldr/pamcut +++ b/tldr/pamcut @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamdeinterlace b/tldr/pamdeinterlace index 18daf41d..acdb232e 100644 --- a/tldr/pamdeinterlace +++ b/tldr/pamdeinterlace @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamdice b/tldr/pamdice index 2d51210f..5b583559 100644 --- a/tldr/pamdice +++ b/tldr/pamdice @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamditherbw b/tldr/pamditherbw index ec0bb7e4..429181f0 100644 --- a/tldr/pamditherbw +++ b/tldr/pamditherbw @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamenlarge b/tldr/pamenlarge index 7769b23b..fd4389f2 100644 --- a/tldr/pamenlarge +++ b/tldr/pamenlarge @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamexec b/tldr/pamexec index e822e560..1c0f8633 100644 --- a/tldr/pamexec +++ b/tldr/pamexec @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamfile b/tldr/pamfile index a3cd5ac8..62296d24 100644 --- a/tldr/pamfile +++ b/tldr/pamfile @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamfix b/tldr/pamfix index 2b129229..302119eb 100644 --- a/tldr/pamfix +++ b/tldr/pamfix @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamflip b/tldr/pamflip index 4ae36f63..3492e820 100644 --- a/tldr/pamflip +++ b/tldr/pamflip @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pammixinterlace b/tldr/pammixinterlace index 840d4c1c..47460ac4 100644 --- a/tldr/pammixinterlace +++ b/tldr/pammixinterlace @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamscale b/tldr/pamscale index c3f84083..6491231e 100644 --- a/tldr/pamscale +++ b/tldr/pamscale @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamshadedrelief b/tldr/pamshadedrelief index f1df9651..62276fed 100644 --- a/tldr/pamshadedrelief +++ b/tldr/pamshadedrelief @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamslice b/tldr/pamslice index d86800e9..b48f4cb1 100644 --- a/tldr/pamslice +++ b/tldr/pamslice @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamstack b/tldr/pamstack index f4dc3ae2..0637367f 100644 --- a/tldr/pamstack +++ b/tldr/pamstack @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamstretch b/tldr/pamstretch index dacef3fa..a3c9af02 100644 --- a/tldr/pamstretch +++ b/tldr/pamstretch @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamtogif b/tldr/pamtogif index 771b7686..210937c7 100644 --- a/tldr/pamtogif +++ b/tldr/pamtogif @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamtopam b/tldr/pamtopam index b8bcf1a5..cfcab0fe 100644 --- a/tldr/pamtopam +++ b/tldr/pamtopam @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`pamtopam -version` +`pamtopam {{[-v|-version]}}` diff --git a/tldr/pamtopng b/tldr/pamtopng index 82d38b49..5042dbf6 100644 --- a/tldr/pamtopng +++ b/tldr/pamtopng @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamtopnm b/tldr/pamtopnm index 0068961d..b197aeb7 100644 --- a/tldr/pamtopnm +++ b/tldr/pamtopnm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`pamtopnm -version` +`pamtopnm {{[-v|-version]}}` diff --git a/tldr/pamtotga b/tldr/pamtotga index a7320637..f26e4b04 100644 --- a/tldr/pamtotga +++ b/tldr/pamtotga @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`pamtotga -version` +`pamtotga {{[-v|-version]}}` diff --git a/tldr/pamtotiff b/tldr/pamtotiff index 60d86033..cafabd86 100644 --- a/tldr/pamtotiff +++ b/tldr/pamtotiff @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamtouil b/tldr/pamtouil index dd5c30cb..025a8174 100644 --- a/tldr/pamtouil +++ b/tldr/pamtouil @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamtowinicon b/tldr/pamtowinicon index 52db6474..c25566a8 100644 --- a/tldr/pamtowinicon +++ b/tldr/pamtowinicon @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pamundice b/tldr/pamundice index 33c28dba..5b01f61f 100644 --- a/tldr/pamundice +++ b/tldr/pamundice @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmclean b/tldr/pbmclean index db8bc512..b4444687 100644 --- a/tldr/pbmclean +++ b/tldr/pbmclean @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmlife b/tldr/pbmlife index e833606a..a8acfb1f 100644 --- a/tldr/pbmlife +++ b/tldr/pbmlife @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`pbmlife -version` +`pbmlife {{[-v|-version]}}` diff --git a/tldr/pbmmask b/tldr/pbmmask index 88bbb14a..5d8043bb 100644 --- a/tldr/pbmmask +++ b/tldr/pbmmask @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmreduce b/tldr/pbmreduce index d9da134e..1b87306b 100644 --- a/tldr/pbmreduce +++ b/tldr/pbmreduce @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmtext b/tldr/pbmtext index afbb2b53..a8162788 100644 --- a/tldr/pbmtext +++ b/tldr/pbmtext @@ -20,9 +20,9 @@ World!}}" | pbmtext > {{path/to/output.pbm}}` - 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 -World!}}" | pbmtext -space {{3}} -lspace {{10}} > {{path/to/output.pbm}}` +World!}}" | pbmtext {{[-s|-space]}} {{3}} {{[-ls|-lspace]}} {{10}} > {{path/to/output.pbm}}` diff --git a/tldr/pbmtextps b/tldr/pbmtextps index 3b035eae..79ae9eca 100644 --- a/tldr/pbmtextps +++ b/tldr/pbmtextps @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmtoascii b/tldr/pbmtoascii index 3a175364..88466647 100644 --- a/tldr/pbmtoascii +++ b/tldr/pbmtoascii @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`pbmtoascii -version` +`pbmtoascii {{[-v|-version]}}` diff --git a/tldr/pbmtoepsi b/tldr/pbmtoepsi index 1ff9684b..f6e4cf2c 100644 --- a/tldr/pbmtoepsi +++ b/tldr/pbmtoepsi @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmtoepson b/tldr/pbmtoepson index b28f39de..527f3091 100644 --- a/tldr/pbmtoepson +++ b/tldr/pbmtoepson @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmtoescp2 b/tldr/pbmtoescp2 index bd2cf6ad..6f0dc482 100644 --- a/tldr/pbmtoescp2 +++ b/tldr/pbmtoescp2 @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmtogem b/tldr/pbmtogem index 8bb7d786..1f9b3991 100644 --- a/tldr/pbmtogem +++ b/tldr/pbmtogem @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Suppress all informational messages: -`pbmtogem -quiet` +`pbmtogem {{[-q|-quiet]}}` - Display version: -`pbmtogem -version` +`pbmtogem {{[-v|-version]}}` diff --git a/tldr/pbmtolj b/tldr/pbmtolj index d32d5b2f..d7556c24 100644 --- a/tldr/pbmtolj +++ b/tldr/pbmtolj @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmtomacp b/tldr/pbmtomacp index 94b48150..fd06300a 100644 --- a/tldr/pbmtomacp +++ b/tldr/pbmtomacp @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pbmtonokia b/tldr/pbmtonokia index 0b830a1b..34fa8e9b 100644 --- a/tldr/pbmtonokia +++ b/tldr/pbmtonokia @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pcxtoppm b/tldr/pcxtoppm index 87bf573b..22c19ec3 100644 --- a/tldr/pcxtoppm +++ b/tldr/pcxtoppm @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pgmhist b/tldr/pgmhist index dd4d6889..3e413594 100644 --- a/tldr/pgmhist +++ b/tldr/pgmhist @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pgmkernel b/tldr/pgmkernel index 4ae7af0f..4b681fb8 100644 --- a/tldr/pgmkernel +++ b/tldr/pgmkernel @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pgmtoppm b/tldr/pgmtoppm index b5d47d95..256a00ba 100644 --- a/tldr/pgmtoppm +++ b/tldr/pgmtoppm @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/picttoppm b/tldr/picttoppm index c3cf1558..fb5e0398 100644 --- a/tldr/picttoppm +++ b/tldr/picttoppm @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pngtopam b/tldr/pngtopam index f32c3855..f268c642 100644 --- a/tldr/pngtopam +++ b/tldr/pngtopam @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmalias b/tldr/pnmalias index 3562d1e5..90b1a816 100644 --- a/tldr/pnmalias +++ b/tldr/pnmalias @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmcolormap b/tldr/pnmcolormap index a00839e9..f18468eb 100644 --- a/tldr/pnmcolormap +++ b/tldr/pnmcolormap @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmcrop b/tldr/pnmcrop index c67e0cab..b986ec11 100644 --- a/tldr/pnmcrop +++ b/tldr/pnmcrop @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - 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: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmgamma b/tldr/pnmgamma index 28685cd5..bc4b6c01 100644 --- a/tldr/pnmgamma +++ b/tldr/pnmgamma @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmhisteq b/tldr/pnmhisteq index 71d00eec..79d33343 100644 --- a/tldr/pnmhisteq +++ b/tldr/pnmhisteq @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmhistmap b/tldr/pnmhistmap index 97ebec4a..c8aa8f41 100644 --- a/tldr/pnmhistmap +++ b/tldr/pnmhistmap @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmindex b/tldr/pnmindex index 661ff07b..80df3467 100644 --- a/tldr/pnmindex +++ b/tldr/pnmindex @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmmargin b/tldr/pnmmargin index b6388fbb..0ef596d2 100644 --- a/tldr/pnmmargin +++ b/tldr/pnmmargin @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmmercator b/tldr/pnmmercator index 2f779f88..bf9adfdf 100644 --- a/tldr/pnmmercator +++ b/tldr/pnmmercator @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmmontage b/tldr/pnmmontage index bf97444e..fc2a9e8f 100644 --- a/tldr/pnmmontage +++ b/tldr/pnmmontage @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmnorm b/tldr/pnmnorm index 71c36667..e6faf811 100644 --- a/tldr/pnmnorm +++ b/tldr/pnmnorm @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmpad b/tldr/pnmpad index 80853daa..0dff10e9 100644 --- a/tldr/pnmpad +++ b/tldr/pnmpad @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmquantall b/tldr/pnmquantall index a00fe6f4..616f8f50 100644 --- a/tldr/pnmquantall +++ b/tldr/pnmquantall @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmremap b/tldr/pnmremap index 5accdfab..db0994d3 100644 --- a/tldr/pnmremap +++ b/tldr/pnmremap @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmrotate b/tldr/pnmrotate index 1612969d..4edb58d6 100644 --- a/tldr/pnmrotate +++ b/tldr/pnmrotate @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmscalefixed b/tldr/pnmscalefixed index b73a7c6f..85d09b00 100644 --- a/tldr/pnmscalefixed +++ b/tldr/pnmscalefixed @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmshear b/tldr/pnmshear index c4db4b09..0ecedb91 100644 --- a/tldr/pnmshear +++ b/tldr/pnmshear @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmsmooth b/tldr/pnmsmooth index 0d2cfcd8..43b60adb 100644 --- a/tldr/pnmsmooth +++ b/tldr/pnmsmooth @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtoddif b/tldr/pnmtoddif index 47b862aa..86a08b66 100644 --- a/tldr/pnmtoddif +++ b/tldr/pnmtoddif @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtofiasco b/tldr/pnmtofiasco index e58f879d..912f8856 100644 --- a/tldr/pnmtofiasco +++ b/tldr/pnmtofiasco @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtopalm b/tldr/pnmtopalm index 212e01f9..4421f970 100644 --- a/tldr/pnmtopalm +++ b/tldr/pnmtopalm @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - 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: @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtopclxl b/tldr/pnmtopclxl index c184093f..93e29108 100644 --- a/tldr/pnmtopclxl +++ b/tldr/pnmtopclxl @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtopng b/tldr/pnmtopng index 7aa248ec..24f4a232 100644 --- a/tldr/pnmtopng +++ b/tldr/pnmtopng @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`pnmtopng -version` +`pnmtopng {{[-vers|-version]}}` diff --git a/tldr/pnmtops b/tldr/pnmtops index 65362134..79aadfcb 100644 --- a/tldr/pnmtops +++ b/tldr/pnmtops @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtorle b/tldr/pnmtorle index 95a6b0ec..c3fe82b2 100644 --- a/tldr/pnmtorle +++ b/tldr/pnmtorle @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtosgi b/tldr/pnmtosgi index 93226125..e1f1dceb 100644 --- a/tldr/pnmtosgi +++ b/tldr/pnmtosgi @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/pnmtoxwd b/tldr/pnmtoxwd index 52a8199e..5fc122b4 100644 --- a/tldr/pnmtoxwd +++ b/tldr/pnmtoxwd @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmchange b/tldr/ppmchange index 21e11380..23f50a62 100644 --- a/tldr/ppmchange +++ b/tldr/ppmchange @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmcie b/tldr/ppmcie index ac48100b..00f9607e 100644 --- a/tldr/ppmcie +++ b/tldr/ppmcie @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmcolormask b/tldr/ppmcolormask index f4e6a910..06e98cc3 100644 --- a/tldr/ppmcolormask +++ b/tldr/ppmcolormask @@ -10,4 +10,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmdither b/tldr/ppmdither index 4f0e649b..23a50007 100644 --- a/tldr/ppmdither +++ b/tldr/ppmdither @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmflash b/tldr/ppmflash index b58a323e..446015b4 100644 --- a/tldr/ppmflash +++ b/tldr/ppmflash @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`ppmflash -version` +`ppmflash {{[-v|-version]}}` diff --git a/tldr/ppmforge b/tldr/ppmforge index aeb7def8..81d52118 100644 --- a/tldr/ppmforge +++ b/tldr/ppmforge @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmglobe b/tldr/ppmglobe index 3c1bdbd5..41d62810 100644 --- a/tldr/ppmglobe +++ b/tldr/ppmglobe @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmhist b/tldr/ppmhist index 60b7c68b..dc21b199 100644 --- a/tldr/ppmhist +++ b/tldr/ppmhist @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmlabel b/tldr/ppmlabel index bfe40511..ab5f9c28 100644 --- a/tldr/ppmlabel +++ b/tldr/ppmlabel @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmntsc b/tldr/ppmntsc index 8ff121b4..1e596aa2 100644 --- a/tldr/ppmntsc +++ b/tldr/ppmntsc @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmpat b/tldr/ppmpat index a7efec8e..4dc7dcb9 100644 --- a/tldr/ppmpat +++ b/tldr/ppmpat @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmrainbow b/tldr/ppmrainbow index e7fb1f4f..0e8cdedb 100644 --- a/tldr/ppmrainbow +++ b/tldr/ppmrainbow @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmspread b/tldr/ppmspread index cab75cca..0b59a66d 100644 --- a/tldr/ppmspread +++ b/tldr/ppmspread @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtoacad b/tldr/ppmtoacad index 1c68f3b3..35285d59 100644 --- a/tldr/ppmtoacad +++ b/tldr/ppmtoacad @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtoarbtxt b/tldr/ppmtoarbtxt index eba0a036..fd451a50 100644 --- a/tldr/ppmtoarbtxt +++ b/tldr/ppmtoarbtxt @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`ppmtoarbtxt -version` +`ppmtoarbtxt {{[-v|-version]}}` diff --git a/tldr/ppmtobmp b/tldr/ppmtobmp index 32fcc76d..446e6278 100644 --- a/tldr/ppmtobmp +++ b/tldr/ppmtobmp @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtoicr b/tldr/ppmtoicr index dd18834b..c54f052f 100644 --- a/tldr/ppmtoicr +++ b/tldr/ppmtoicr @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtoilbm b/tldr/ppmtoilbm index db80cdb0..f6940c04 100644 --- a/tldr/ppmtoilbm +++ b/tldr/ppmtoilbm @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtolj b/tldr/ppmtolj index 1e506ac7..51bf0291 100644 --- a/tldr/ppmtolj +++ b/tldr/ppmtolj @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtomitsu b/tldr/ppmtomitsu index e76c2579..51b82056 100644 --- a/tldr/ppmtomitsu +++ b/tldr/ppmtomitsu @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtompeg b/tldr/ppmtompeg index e69f8127..50739a01 100644 --- a/tldr/ppmtompeg +++ b/tldr/ppmtompeg @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtopgm b/tldr/ppmtopgm index 5c7b7024..2849b8f4 100644 --- a/tldr/ppmtopgm +++ b/tldr/ppmtopgm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`ppmtopgm -version` +`ppmtopgm {{[-v|-version]}}` diff --git a/tldr/ppmtopj b/tldr/ppmtopj index d85418ab..e9a9c692 100644 --- a/tldr/ppmtopj +++ b/tldr/ppmtopj @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtopjxl b/tldr/ppmtopjxl index 24170677..0fe5a5a9 100644 --- a/tldr/ppmtopjxl +++ b/tldr/ppmtopjxl @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtoppm b/tldr/ppmtoppm index 657f7edc..f435f788 100644 --- a/tldr/ppmtoppm +++ b/tldr/ppmtoppm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`ppmtoppm -version` +`ppmtoppm {{[-v|-version]}}` diff --git a/tldr/ppmtosixel b/tldr/ppmtosixel index 8562a998..3f7e064c 100644 --- a/tldr/ppmtosixel +++ b/tldr/ppmtosixel @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtoxpm b/tldr/ppmtoxpm index ec5f2196..4fc532e9 100644 --- a/tldr/ppmtoxpm +++ b/tldr/ppmtoxpm @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ppmtv b/tldr/ppmtv index f499ca32..dd0694c7 100644 --- a/tldr/ppmtv +++ b/tldr/ppmtv @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Suppress all informational messages: -`ppmtv -quiet` +`ppmtv {{[-q|-quiet]}}` - Display version: -`ppmtv -version` +`ppmtv {{[-v|-version]}}` diff --git a/tldr/ppmwheel b/tldr/ppmwheel index 98547259..7ae85568 100644 --- a/tldr/ppmwheel +++ b/tldr/ppmwheel @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/rasttopnm b/tldr/rasttopnm index 872cb781..118ba5c0 100644 --- a/tldr/rasttopnm +++ b/tldr/rasttopnm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/rawtopgm b/tldr/rawtopgm index 7215153e..7f191794 100644 --- a/tldr/rawtopgm +++ b/tldr/rawtopgm @@ -18,20 +18,20 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/rawtoppm b/tldr/rawtoppm index 6cd10ba7..2cc61ea4 100644 --- a/tldr/rawtoppm +++ b/tldr/rawtoppm @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/rletopnm b/tldr/rletopnm index 6e119204..1fefea69 100644 --- a/tldr/rletopnm +++ b/tldr/rletopnm @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/sgitopnm b/tldr/sgitopnm index 0e5700f0..3bdf4fd2 100644 --- a/tldr/sgitopnm +++ b/tldr/sgitopnm @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/sldtoppm b/tldr/sldtoppm index 46057dc5..fae2d701 100644 --- a/tldr/sldtoppm +++ b/tldr/sldtoppm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/svgtopam b/tldr/svgtopam index 3d4302ba..ec75daf9 100644 --- a/tldr/svgtopam +++ b/tldr/svgtopam @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Emit textual output describing the input image: -`svgtopam -trace {{path/to/file.svg}}` +`svgtopam {{[-t|-trace]}} {{path/to/file.svg}}` diff --git a/tldr/tgatoppm b/tldr/tgatoppm index da2baa1a..1cca1b65 100644 --- a/tldr/tgatoppm +++ b/tldr/tgatoppm @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/thinkjettopbm b/tldr/thinkjettopbm index 914af0a9..5695c298 100644 --- a/tldr/thinkjettopbm +++ b/tldr/thinkjettopbm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/tifftopnm b/tldr/tifftopnm index 00387a68..9d9fd790 100644 --- a/tldr/tifftopnm +++ b/tldr/tifftopnm @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/winicontopam b/tldr/winicontopam index 73cb3da8..d5741454 100644 --- a/tldr/winicontopam +++ b/tldr/winicontopam @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/ximtoppm b/tldr/ximtoppm index 3460a388..a041d8f1 100644 --- a/tldr/ximtoppm +++ b/tldr/ximtoppm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/xpmtoppm b/tldr/xpmtoppm index 20cd951c..3fd6a4c6 100644 --- a/tldr/xpmtoppm +++ b/tldr/xpmtoppm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/xwdtopnm b/tldr/xwdtopnm index 753f5264..98ed43c9 100644 --- a/tldr/xwdtopnm +++ b/tldr/xwdtopnm @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/yuy2topam b/tldr/yuy2topam index 896b7f55..0881cf08 100644 --- a/tldr/yuy2topam +++ b/tldr/yuy2topam @@ -10,4 +10,4 @@ source: https://github.com/tldr-pages/tldr.git - 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}}`