{ "content": [ { "type": "text", "text": "# wrap-and-sort (man)\n\n## NAME\n\nwrap-and-sort - wrap long lines and sort items in Debian packaging files\n\n## SYNOPSIS\n\nwrap-and-sort [options]\n\n## DESCRIPTION\n\nwrap-and-sort wraps the package lists in Debian control files. By default the lists will only\nsplit into multiple lines if the entries are longer than the maximum line length limit of 79\ncharacters. wrap-and-sort sorts the package lists in Debian control files and all .dirs,\n.docs, .examples, .info, .install, .links, .maintscript, and .manpages files. Beside that\nwrap-and-sort removes trailing spaces in these files.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (11 subsections)\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "wrap-and-sort", "section": "", "mode": "man", "summary": "wrap-and-sort - wrap long lines and sort items in Debian packaging files", "synopsis": "wrap-and-sort [options]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-h", "long": "--help", "arg": null, "description": "Show this help message and exit." }, { "flag": "-a", "long": "--wrap-always", "arg": null, "description": "Wrap all package lists in the Debian control file even if they do not exceed the line length limit and could fit in one line." }, { "flag": "-s", "long": "--short-indent", "arg": null, "description": "Only indent wrapped lines by one space (default is in-line with the field name)." }, { "flag": "-b", "long": "--sort-binary-packages", "arg": null, "description": "Sort binary package paragraphs by name." }, { "flag": "-k", "long": "--keep-first", "arg": null, "description": "When sorting binary package paragraphs, leave the first one at the top. Unqualified debhelper(7) configuration files are applied to the first package." }, { "flag": "-n", "long": "--no-cleanup", "arg": null, "description": "Do not remove trailing whitespaces." }, { "flag": "-t", "long": "--trailing-comma", "arg": null, "description": "Add a trailing comma at the end of the sorted fields. This minimizes future differ‐ ences in the VCS commits when additional dependencies are appended or removed." }, { "flag": "-d", "long": null, "arg": null, "description": "Location of the debian directory (default: ./debian)." }, { "flag": "-f", "long": null, "arg": null, "description": "Wrap and sort only the specified file. You can specify this parameter multiple times. All supported files will be processed if no files are specified." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Print all files that are touched. --max-line-length=maxlinelength Set the maximum allowed line length. Package lists in the Debian control file that ex‐ ceed this length limit will be wrapped. The default maximum line length is 79 characters." }, { "flag": "-N", "long": "--dry-run", "arg": null, "description": "Do not modify any file, instead only print the files that would be modified." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 10, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "-a --wrap-always", "lines": 3, "flag": "-a", "long": "--wrap-always" }, { "name": "-s --short-indent", "lines": 2, "flag": "-s", "long": "--short-indent" }, { "name": "-b --sort-binary-packages", "lines": 2, "flag": "-b", "long": "--sort-binary-packages" }, { "name": "-k --keep-first", "lines": 4, "flag": "-k", "long": "--keep-first" }, { "name": "-n --no-cleanup", "lines": 2, "flag": "-n", "long": "--no-cleanup" }, { "name": "-t --trailing-comma", "lines": 3, "flag": "-t", "long": "--trailing-comma" }, { "name": "-d --debian-directory=", "lines": 2, "flag": "-d" }, { "name": "-f --file=", "lines": 3, "flag": "-f" }, { "name": "-v --verbose", "lines": 8, "flag": "-v", "long": "--verbose" }, { "name": "-N --dry-run", "lines": 3, "flag": "-N", "long": "--dry-run" } ] }, { "name": "AUTHORS", "lines": 7, "subsections": [] } ], "sections": { "NAME": { "content": "wrap-and-sort - wrap long lines and sort items in Debian packaging files\n", "subsections": [] }, "SYNOPSIS": { "content": "wrap-and-sort [options]\n\n", "subsections": [] }, "DESCRIPTION": { "content": "wrap-and-sort wraps the package lists in Debian control files. By default the lists will only\nsplit into multiple lines if the entries are longer than the maximum line length limit of 79\ncharacters. wrap-and-sort sorts the package lists in Debian control files and all .dirs,\n.docs, .examples, .info, .install, .links, .maintscript, and .manpages files. Beside that\nwrap-and-sort removes trailing spaces in these files.\n\nThis script should be run in the root of a Debian package tree. It searches for control, con‐\ntrol*.in, copyright, copyright.in, install, and *.install in the debian directory.\n\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-h --help", "content": "Show this help message and exit.\n", "flag": "-h", "long": "--help" }, { "name": "-a --wrap-always", "content": "Wrap all package lists in the Debian control file even if they do not exceed the line\nlength limit and could fit in one line.\n", "flag": "-a", "long": "--wrap-always" }, { "name": "-s --short-indent", "content": "Only indent wrapped lines by one space (default is in-line with the field name).\n", "flag": "-s", "long": "--short-indent" }, { "name": "-b --sort-binary-packages", "content": "Sort binary package paragraphs by name.\n", "flag": "-b", "long": "--sort-binary-packages" }, { "name": "-k --keep-first", "content": "When sorting binary package paragraphs, leave the first one at the top.\n\nUnqualified debhelper(7) configuration files are applied to the first package.\n", "flag": "-k", "long": "--keep-first" }, { "name": "-n --no-cleanup", "content": "Do not remove trailing whitespaces.\n", "flag": "-n", "long": "--no-cleanup" }, { "name": "-t --trailing-comma", "content": "Add a trailing comma at the end of the sorted fields. This minimizes future differ‐\nences in the VCS commits when additional dependencies are appended or removed.\n", "flag": "-t", "long": "--trailing-comma" }, { "name": "-d --debian-directory=", "content": "Location of the debian directory (default: ./debian).\n", "flag": "-d" }, { "name": "-f --file=", "content": "Wrap and sort only the specified file. You can specify this parameter multiple times.\nAll supported files will be processed if no files are specified.\n", "flag": "-f" }, { "name": "-v --verbose", "content": "Print all files that are touched.\n\n--max-line-length=maxlinelength\nSet the maximum allowed line length. Package lists in the Debian control file that ex‐\nceed this length limit will be wrapped.\n\nThe default maximum line length is 79 characters.\n", "flag": "-v", "long": "--verbose" }, { "name": "-N --dry-run", "content": "Do not modify any file, instead only print the files that would be modified.\n\n", "flag": "-N", "long": "--dry-run" } ] }, "AUTHORS": { "content": "wrap-and-sort and this manpage have been written by Benjamin Drung .\n\nBoth are released under the ISC license.\n\n\n\nDEBIAN Debian Utilities WRAP-AND-SORT(1)", "subsections": [] } } } }