{
    "mode": "man",
    "parameter": "ptx",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/ptx/1/json",
    "generated": "2026-05-30T06:05:45Z",
    "synopsis": "ptx [OPTION]... [INPUT]...   (without -G)\nptx -G [OPTION]... [INPUT [OUTPUT]]",
    "sections": {
        "NAME": {
            "content": "ptx - produce a permuted index of file contents\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "ptx [OPTION]... [INPUT]...   (without -G)\nptx -G [OPTION]... [INPUT [OUTPUT]]\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Output a permuted index, including context, of the words in the input files.\n\nWith no FILE, or when FILE is -, read standard input.\n\nMandatory arguments to long options are mandatory for short options too.\n",
            "subsections": [
                {
                    "name": "-A --auto-reference",
                    "content": "output automatically generated references\n",
                    "flag": "-A",
                    "long": "--auto-reference"
                },
                {
                    "name": "-G --traditional",
                    "content": "behave more like System V 'ptx'\n",
                    "flag": "-G",
                    "long": "--traditional"
                },
                {
                    "name": "-F --flag-truncation",
                    "content": "use STRING for flagging line truncations.  The default is '/'\n",
                    "flag": "-F",
                    "long": "--flag-truncation"
                },
                {
                    "name": "-M --macro-name",
                    "content": "macro name to use instead of 'xx'\n",
                    "flag": "-M",
                    "long": "--macro-name"
                },
                {
                    "name": "-O --format",
                    "content": "generate output as roff directives\n",
                    "flag": "-O",
                    "long": "--format"
                },
                {
                    "name": "-R --right-side-refs",
                    "content": "put references at right, not counted in -w\n",
                    "flag": "-R",
                    "long": "--right-side-refs"
                },
                {
                    "name": "-S --sentence-regexp",
                    "content": "for end of lines or end of sentences\n",
                    "flag": "-S",
                    "long": "--sentence-regexp"
                },
                {
                    "name": "-T --format",
                    "content": "generate output as TeX directives\n",
                    "flag": "-T",
                    "long": "--format"
                },
                {
                    "name": "-W --word-regexp",
                    "content": "use REGEXP to match each keyword\n",
                    "flag": "-W",
                    "long": "--word-regexp"
                },
                {
                    "name": "-b --break-file",
                    "content": "word break characters in this FILE\n",
                    "flag": "-b",
                    "long": "--break-file"
                },
                {
                    "name": "-f --ignore-case",
                    "content": "fold lower case to upper case for sorting\n",
                    "flag": "-f",
                    "long": "--ignore-case"
                },
                {
                    "name": "-g --gap-size",
                    "content": "gap size in columns between output fields\n",
                    "flag": "-g",
                    "long": "--gap-size"
                },
                {
                    "name": "-i --ignore-file",
                    "content": "read ignore word list from FILE\n",
                    "flag": "-i",
                    "long": "--ignore-file"
                },
                {
                    "name": "-o --only-file",
                    "content": "read only word list from this FILE\n",
                    "flag": "-o",
                    "long": "--only-file"
                },
                {
                    "name": "-r --references",
                    "content": "first field of each line is a reference\n",
                    "flag": "-r",
                    "long": "--references"
                },
                {
                    "name": "-t --typeset-mode",
                    "content": "",
                    "flag": "-t",
                    "long": "--typeset-mode"
                },
                {
                    "name": "-w --width",
                    "content": "output width in columns, reference excluded\n\n--help display this help and exit\n",
                    "flag": "-w",
                    "long": "--width"
                },
                {
                    "name": "--version",
                    "content": "output version information and exit\n",
                    "long": "--version"
                }
            ]
        },
        "AUTHOR": {
            "content": "Written by F. Pinard.\n",
            "subsections": []
        },
        "REPORTING BUGS": {
            "content": "GNU coreutils online help: <https://www.gnu.org/software/coreutils/>\nReport any translation bugs to <https://translationproject.org/team/>\n",
            "subsections": []
        },
        "COPYRIGHT": {
            "content": "Copyright  ©  2020 Free Software Foundation, Inc.  License GPLv3+: GNU GPL version 3 or later\n<https://gnu.org/licenses/gpl.html>.\nThis is free software: you are free to change and redistribute it.  There is NO WARRANTY,  to\nthe extent permitted by law.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Full documentation <https://www.gnu.org/software/coreutils/ptx>\nor available locally via: info '(coreutils) ptx invocation'\n\n\n\nGNU coreutils 8.32                          January 2026                                      PTX(1)",
            "subsections": []
        }
    },
    "summary": "ptx - produce a permuted index of file contents",
    "flags": [
        {
            "flag": "-A",
            "long": "--auto-reference",
            "arg": null,
            "description": "output automatically generated references"
        },
        {
            "flag": "-G",
            "long": "--traditional",
            "arg": null,
            "description": "behave more like System V 'ptx'"
        },
        {
            "flag": "-F",
            "long": "--flag-truncation",
            "arg": null,
            "description": "use STRING for flagging line truncations. The default is '/'"
        },
        {
            "flag": "-M",
            "long": "--macro-name",
            "arg": null,
            "description": "macro name to use instead of 'xx'"
        },
        {
            "flag": "-O",
            "long": "--format",
            "arg": null,
            "description": "generate output as roff directives"
        },
        {
            "flag": "-R",
            "long": "--right-side-refs",
            "arg": null,
            "description": "put references at right, not counted in -w"
        },
        {
            "flag": "-S",
            "long": "--sentence-regexp",
            "arg": null,
            "description": "for end of lines or end of sentences"
        },
        {
            "flag": "-T",
            "long": "--format",
            "arg": null,
            "description": "generate output as TeX directives"
        },
        {
            "flag": "-W",
            "long": "--word-regexp",
            "arg": null,
            "description": "use REGEXP to match each keyword"
        },
        {
            "flag": "-b",
            "long": "--break-file",
            "arg": null,
            "description": "word break characters in this FILE"
        },
        {
            "flag": "-f",
            "long": "--ignore-case",
            "arg": null,
            "description": "fold lower case to upper case for sorting"
        },
        {
            "flag": "-g",
            "long": "--gap-size",
            "arg": null,
            "description": "gap size in columns between output fields"
        },
        {
            "flag": "-i",
            "long": "--ignore-file",
            "arg": null,
            "description": "read ignore word list from FILE"
        },
        {
            "flag": "-o",
            "long": "--only-file",
            "arg": null,
            "description": "read only word list from this FILE"
        },
        {
            "flag": "-r",
            "long": "--references",
            "arg": null,
            "description": "first field of each line is a reference"
        },
        {
            "flag": "-t",
            "long": "--typeset-mode",
            "arg": null,
            "description": ""
        },
        {
            "flag": "-w",
            "long": "--width",
            "arg": null,
            "description": "output width in columns, reference excluded --help display this help and exit"
        },
        {
            "flag": "",
            "long": "--version",
            "arg": null,
            "description": "output version information and exit"
        }
    ],
    "examples": [],
    "see_also": []
}