{
    "content": [
        {
            "type": "text",
            "text": "# PNMTORLE (man)\n\n## NAME\n\npnmtorle - convert a Netpbm image file into an RLE image file.\n\n## SYNOPSIS\n\npnmtorle [ -h ] [ -v ] [ -a ] [ -o outfile ] [ pnmfile ]\n\n## DESCRIPTION\n\nThis  program  converts  Netpbm image files into Utah RLE(5) image files.  You can include an\nalpha mask.  If the input is a multiple image file, the output consists of  several  concate‐\nnated RLE images.\n\n## TLDR\n\n> Convert a PNM file to an Utah Raster Tools RLE image file.\n\n- Convert a PNM image to an RLE image:\n  `pnmtorle {{path/to/input.pnm}} > {{path/to/output.rle}}`\n- Print PNM header information to `stdout`:\n  `pnmtorle {{-verb|-verbose}} {{path/to/input.pnm}} > {{path/to/output.rle}}`\n- 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:\n  `pnmtorle {{-a|-alpha}} {{path/to/input.pnm}} > {{path/to/output.rle}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (4 subsections)\n- **EXAMPLES**\n- **SEE ALSO**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "PNMTORLE",
        "section": "",
        "mode": "man",
        "summary": "pnmtorle - convert a Netpbm image file into an RLE image file.",
        "synopsis": "pnmtorle [ -h ] [ -v ] [ -a ] [ -o outfile ] [ pnmfile ]",
        "tldr_summary": "Convert a PNM file to an Utah Raster Tools RLE image file.",
        "tldr_examples": [
            {
                "description": "Convert a PNM image to an RLE image",
                "command": "pnmtorle {{path/to/input.pnm}} > {{path/to/output.rle}}"
            },
            {
                "description": "Print PNM header information to `stdout`",
                "command": "pnmtorle {{-verb|-verbose}} {{path/to/input.pnm}} > {{path/to/output.rle}}"
            },
            {
                "description": "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",
                "command": "pnmtorle {{-a|-alpha}} {{path/to/input.pnm}} > {{path/to/output.rle}}"
            }
        ],
        "tldr_source": "official",
        "flags": [
            {
                "flag": "-v",
                "long": null,
                "arg": null,
                "description": "written to \"stderr\". Actually, there is not much header information stored in a Netpbm file, so this information is minimal."
            },
            {
                "flag": "-h",
                "long": null,
                "arg": null,
                "description": "converting the file. It is equivalent to using the -v option except that no file con‐ version takes place."
            },
            {
                "flag": "-a",
                "long": null,
                "arg": null,
                "description": "pha channel is based on the image: Wherever a pixel is black, the corresponding alpha value is transparent. Everywhere else, the alpha value is fully opaque."
            },
            {
                "flag": "-o",
                "long": null,
                "arg": null,
                "description": "If specified, the output will be written to this file. If outfile is \"-\", or if it is not specified, the output will be written to the standard output stream. pnmfile The name of the Netpbm image data file to be converted. If not specified, standard input is assumed."
            }
        ],
        "examples": [
            "pnmtorle -v file.ppm -o file.rle",
            "While running in verbose mode, convert file.ppm to RLE format and store resulting data",
            "in file.rle.",
            "pnmtorle -h file.pgm",
            "Dump the header information of the Netpbm file called file.pgm."
        ],
        "see_also": [
            {
                "name": "rletopnm",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/rletopnm/1/json"
            },
            {
                "name": "urt",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/urt/1/json"
            },
            {
                "name": "RLE",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/RLE/5/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 11,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-v",
                        "lines": 3,
                        "flag": "-v"
                    },
                    {
                        "name": "-h",
                        "lines": 3,
                        "flag": "-h"
                    },
                    {
                        "name": "-a",
                        "lines": 3,
                        "flag": "-a"
                    },
                    {
                        "name": "-o",
                        "lines": 7,
                        "flag": "-o"
                    }
                ]
            },
            {
                "name": "EXAMPLES",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 7,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "pnmtorle - convert a Netpbm image file into an RLE image file.\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "pnmtorle [ -h ] [ -v ] [ -a ] [ -o outfile ] [ pnmfile ]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This  program  converts  Netpbm image files into Utah RLE(5) image files.  You can include an\nalpha mask.  If the input is a multiple image file, the output consists of  several  concate‐\nnated RLE images.\n\nThe  RLE  file  will contain either a three channel color image (24 bits) or a single channel\ngrayscale image (8 bits) depending upon the pnm file depth.  If a converted ppm is  displayed\non  an 8 bit display, the image must be dithered.  In order to produce a better looking image\n(on 8 bit displays), it is recommended that the image be quantizing (to 8 bit  mapped  color)\nprior  to  its  display.  This may be done by piping the output of this program into the Utah\nmcut(1) or rlequant(1) utilities.  An example of this is shown later.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "",
                "subsections": [
                    {
                        "name": "-v",
                        "content": "written  to  \"stderr\".   Actually,  there  is  not much header information stored in a\nNetpbm file, so this information is minimal.\n",
                        "flag": "-v"
                    },
                    {
                        "name": "-h",
                        "content": "converting the file.  It is equivalent to using the -v option except that no file con‐\nversion takes place.\n",
                        "flag": "-h"
                    },
                    {
                        "name": "-a",
                        "content": "pha channel is based on the image:  Wherever a pixel is black, the corresponding alpha\nvalue is transparent.  Everywhere else, the alpha value is fully opaque.\n",
                        "flag": "-a"
                    },
                    {
                        "name": "-o",
                        "content": "If specified, the output will be written to this file.  If outfile is \"-\", or if it is\nnot specified, the output will be written to the standard output stream.\n\npnmfile\nThe  name  of  the Netpbm image data file to be converted.  If not specified, standard\ninput is assumed.\n",
                        "flag": "-o"
                    }
                ]
            },
            "EXAMPLES": {
                "content": "pnmtorle -v file.ppm -o file.rle\nWhile running in verbose mode, convert file.ppm to RLE format and store resulting data\nin file.rle.\n\npnmtorle -h file.pgm\nDump the header information of the Netpbm file called file.pgm.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "rletopnm(1), urt(1), RLE(5).\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Wes Barris\nArmy High Performance Computing Research Center (AHPCRC)\nMinnesota Supercomputer Center, Inc.\n\n\n\n1                                          March 31, 1994                                PNMTORLE(1)",
                "subsections": []
            }
        }
    }
}