{ "content": [ { "type": "text", "text": "# PYGETTEXT (man)\n\n## NAME\n\npygettext - Python equivalent of xgettext(1)\n\n## SYNOPSIS\n\npygettext [OPTIONS] INPUTFILE ...\n\n## DESCRIPTION\n\npygettext is deprecated. The current version of xgettext supports many languages, including\nPython.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (17 subsections)\n- **BUGS**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "PYGETTEXT", "section": "", "mode": "man", "summary": "pygettext - Python equivalent of xgettext(1)", "synopsis": "pygettext [OPTIONS] INPUTFILE ...", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-a", "long": "--extract-all", "arg": null, "description": "Extract all strings." }, { "flag": "-d", "long": "--default-domain", "arg": null, "description": "Rename the default output file from messages.pot to name.pot." }, { "flag": "-E", "long": "--escape", "arg": null, "description": "Replace non-ASCII characters with octal escape sequences." }, { "flag": "-D", "long": "--docstrings", "arg": null, "description": "Extract module, class, method, and function docstrings. These do not need to be wrapped in () markers, and in fact cannot be for Python to consider them docstrings. (See also the -X option)." }, { "flag": "-h", "long": "--help", "arg": null, "description": "Print this help message and exit." }, { "flag": "-k", "long": "--keyword", "arg": null, "description": "Keywords to look for in addition to the default set, which are: You can have multiple -k flags on the command line." }, { "flag": "-K", "long": "--no-default-keywords", "arg": null, "description": "Disable the default set of keywords (see above). Any keywords explicitly added with the -k/--keyword option are still recognized." }, { "flag": "", "long": "--no-location", "arg": null, "description": "Do not write filename/lineno location comments." }, { "flag": "-n", "long": "--add-location", "arg": null, "description": "Write filename/lineno location comments indicating where each extracted string is found in the source. These lines appear before each msgid. The style of comments is controlled by the -S/--style option. This is the default." }, { "flag": "-o", "long": "--output", "arg": null, "description": "Rename the default output file from messages.pot to FILENAME. If FILENAME is `-' then the output is sent to standard out." }, { "flag": "-p", "long": "--output-dir", "arg": null, "description": "Output files will be placed in directory DIR." }, { "flag": "-S", "long": "--style", "arg": null, "description": "Specify which style to use for location comments. Two styles are supported: • Solaris # File: filename, line: line-number • GNU #: filename:line The style name is case insensitive. GNU style is the default." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Print the names of the files being processed." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Print the version of pygettext and exit." }, { "flag": "-w", "long": "--width", "arg": null, "description": "Set width of output to columns." }, { "flag": "-x", "long": "--exclude-file", "arg": null, "description": "Specify a file that contains a list of strings that are not be extracted from the in‐ put files. Each string to be excluded must appear on a line by itself in the file." }, { "flag": "-X", "long": "--no-docstrings", "arg": null, "description": "Specify a file that contains a list of files (one per line) that should not have their docstrings extracted. This is only useful in conjunction with the -D option above. If `INPUTFILE' is -, standard input is read." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 11, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-a --extract-all", "lines": 2, "flag": "-a", "long": "--extract-all" }, { "name": "-d --default-domain", "lines": 2, "flag": "-d", "long": "--default-domain" }, { "name": "-E --escape", "lines": 2, "flag": "-E", "long": "--escape" }, { "name": "-D --docstrings", "lines": 4, "flag": "-D", "long": "--docstrings" }, { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "-k --keyword", "lines": 4, "flag": "-k", "long": "--keyword" }, { "name": "-K --no-default-keywords", "lines": 3, "flag": "-K", "long": "--no-default-keywords" }, { "name": "--no-location", "lines": 2, "long": "--no-location" }, { "name": "-n --add-location", "lines": 4, "flag": "-n", "long": "--add-location" }, { "name": "-o --output", "lines": 3, "flag": "-o", "long": "--output" }, { "name": "-p --output-dir", "lines": 2, "flag": "-p", "long": "--output-dir" }, { "name": "-S --style", "lines": 8, "flag": "-S", "long": "--style" }, { "name": "-v --verbose", "lines": 2, "flag": "-v", "long": "--verbose" }, { "name": "-V --version", "lines": 2, "flag": "-V", "long": "--version" }, { "name": "-w --width", "lines": 2, "flag": "-w", "long": "--width" }, { "name": "-x --exclude-file", "lines": 3, "flag": "-x", "long": "--exclude-file" }, { "name": "-X --no-docstrings", "lines": 5, "flag": "-X", "long": "--no-docstrings" } ] }, { "name": "BUGS", "lines": 5, "subsections": [] }, { "name": "AUTHOR", "lines": 8, "subsections": [] } ], "sections": { "NAME": { "content": "pygettext - Python equivalent of xgettext(1)\n", "subsections": [] }, "SYNOPSIS": { "content": "pygettext [OPTIONS] INPUTFILE ...\n", "subsections": [] }, "DESCRIPTION": { "content": "pygettext is deprecated. The current version of xgettext supports many languages, including\nPython.\n\npygettext uses Python's standard tokenize module to scan Python source code, generating .pot\nfiles identical to what GNU xgettext generates for C and C++ code. From there, the standard\nGNU tools can be used.\n\npygettext searches only for () by default, even though GNU xgettext recognizes the following\nkeywords: gettext, dgettext, dcgettext, and gettextnoop. See the -k/--keyword flag below for\nhow to augment this.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-a --extract-all", "content": "Extract all strings.\n", "flag": "-a", "long": "--extract-all" }, { "name": "-d --default-domain", "content": "Rename the default output file from messages.pot to name.pot.\n", "flag": "-d", "long": "--default-domain" }, { "name": "-E --escape", "content": "Replace non-ASCII characters with octal escape sequences.\n", "flag": "-E", "long": "--escape" }, { "name": "-D --docstrings", "content": "Extract module, class, method, and function docstrings. These do not need to be\nwrapped in () markers, and in fact cannot be for Python to consider them docstrings.\n(See also the -X option).\n", "flag": "-D", "long": "--docstrings" }, { "name": "-h --help", "content": "Print this help message and exit.\n", "flag": "-h", "long": "--help" }, { "name": "-k --keyword", "content": "Keywords to look for in addition to the default set, which are:\n\nYou can have multiple -k flags on the command line.\n", "flag": "-k", "long": "--keyword" }, { "name": "-K --no-default-keywords", "content": "Disable the default set of keywords (see above). Any keywords explicitly added with\nthe -k/--keyword option are still recognized.\n", "flag": "-K", "long": "--no-default-keywords" }, { "name": "--no-location", "content": "Do not write filename/lineno location comments.\n", "long": "--no-location" }, { "name": "-n --add-location", "content": "Write filename/lineno location comments indicating where each extracted string is\nfound in the source. These lines appear before each msgid. The style of comments is\ncontrolled by the -S/--style option. This is the default.\n", "flag": "-n", "long": "--add-location" }, { "name": "-o --output", "content": "Rename the default output file from messages.pot to FILENAME. If FILENAME is `-' then\nthe output is sent to standard out.\n", "flag": "-o", "long": "--output" }, { "name": "-p --output-dir", "content": "Output files will be placed in directory DIR.\n", "flag": "-p", "long": "--output-dir" }, { "name": "-S --style", "content": "Specify which style to use for location comments. Two styles are supported:\n\n• Solaris # File: filename, line: line-number\n\n• GNU #: filename:line\n\nThe style name is case insensitive. GNU style is the default.\n", "flag": "-S", "long": "--style" }, { "name": "-v --verbose", "content": "Print the names of the files being processed.\n", "flag": "-v", "long": "--verbose" }, { "name": "-V --version", "content": "Print the version of pygettext and exit.\n", "flag": "-V", "long": "--version" }, { "name": "-w --width", "content": "Set width of output to columns.\n", "flag": "-w", "long": "--width" }, { "name": "-x --exclude-file", "content": "Specify a file that contains a list of strings that are not be extracted from the in‐\nput files. Each string to be excluded must appear on a line by itself in the file.\n", "flag": "-x", "long": "--exclude-file" }, { "name": "-X --no-docstrings", "content": "Specify a file that contains a list of files (one per line) that should not have their\ndocstrings extracted. This is only useful in conjunction with the -D option above.\n\nIf `INPUTFILE' is -, standard input is read.\n", "flag": "-X", "long": "--no-docstrings" } ] }, "BUGS": { "content": "pygettext attempts to be option and feature compatible with GNU xgettext where ever possible.\nHowever some options are still missing or are not fully implemented. Also, xgettext's use of\ncommand line switches with option arguments is broken, and in these cases, pygettext just de‐\nfines additional switches.\n", "subsections": [] }, "AUTHOR": { "content": "pygettext is written by Barry Warsaw .\n\nJoonas Paalasmaa put this manual page together based on \"pygettext\n--help\".\n\n\n\npygettext 1.4 PYGETTEXT(1)", "subsections": [] } } } }