{ "content": [ { "type": "text", "text": "# ul (man)\n\n## NAME\n\nul - do underlining\n\n## SYNOPSIS\n\nul [options] [file...]\n\n## DESCRIPTION\n\nul reads the named files (or standard input if none are given) and translates occurrences of\nunderscores to the sequence which indicates underlining for the terminal in use, as specified\nby the environment variable TERM. The terminfo database is read to determine the appropriate\nsequences for underlining. If the terminal is incapable of underlining but is capable of a\nstandout mode, then that is used instead. If the terminal can overstrike, or handles\nunderlining automatically, ul degenerates to cat(1). If the terminal cannot underline,\nunderlining is ignored.\n\n## TLDR\n\n> Underline a text.\n\n- Display the contents of the file with underlines where applicable:\n `ul {{file.txt}}`\n- Display the contents of the file with underlines made of dashes `-`:\n `ul {{-i|--indicated}} {{file.txt}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (4 subsections)\n- **ENVIRONMENT**\n- **HISTORY**\n- **BUGS**\n- **SEE ALSO**\n- **REPORTING BUGS**\n- **AVAILABILITY**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "ul", "section": "", "mode": "man", "summary": "ul - do underlining", "synopsis": "ul [options] [file...]", "tldr_summary": "Underline a text.", "tldr_examples": [ { "description": "Display the contents of the file with underlines where applicable", "command": "ul {{file.txt}}" }, { "description": "Display the contents of the file with underlines made of dashes `-`", "command": "ul {{-i|--indicated}} {{file.txt}}" } ], "tldr_source": "official", "flags": [ { "flag": "-i", "long": "--indicated", "arg": null, "description": "Underlining is indicated by a separate line containing appropriate dashes `-'; this is useful when you want to look at the underlining which is present in an nroff output stream on a crt-terminal." }, { "flag": "-T", "long": "--terminal", "arg": null, "description": "Override the environment variable TERM with the specified terminal type." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Display version information and exit." }, { "flag": "-h", "long": "--help", "arg": null, "description": "Display help text and exit." } ], "examples": [], "see_also": [ { "name": "colcrt", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/colcrt/1/json" }, { "name": "login", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/login/1/json" }, { "name": "man", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/man/1/json" }, { "name": "nroff", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/nroff/1/json" }, { "name": "setenv", "section": "3", "url": "https://www.chedong.com/phpMan.php/man/setenv/3/json" }, { "name": "terminfo", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/terminfo/5/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 8, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-i --indicated", "lines": 4, "flag": "-i", "long": "--indicated" }, { "name": "-t -T --terminal", "lines": 2, "flag": "-T", "long": "--terminal" }, { "name": "-V --version", "lines": 2, "flag": "-V", "long": "--version" }, { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" } ] }, { "name": "ENVIRONMENT", "lines": 8, "subsections": [] }, { "name": "HISTORY", "lines": 2, "subsections": [] }, { "name": "BUGS", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "REPORTING BUGS", "lines": 2, "subsections": [] }, { "name": "AVAILABILITY", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "ul - do underlining\n", "subsections": [] }, "SYNOPSIS": { "content": "ul [options] [file...]\n", "subsections": [] }, "DESCRIPTION": { "content": "ul reads the named files (or standard input if none are given) and translates occurrences of\nunderscores to the sequence which indicates underlining for the terminal in use, as specified\nby the environment variable TERM. The terminfo database is read to determine the appropriate\nsequences for underlining. If the terminal is incapable of underlining but is capable of a\nstandout mode, then that is used instead. If the terminal can overstrike, or handles\nunderlining automatically, ul degenerates to cat(1). If the terminal cannot underline,\nunderlining is ignored.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-i --indicated", "content": "Underlining is indicated by a separate line containing appropriate dashes `-'; this is\nuseful when you want to look at the underlining which is present in an nroff output\nstream on a crt-terminal.\n", "flag": "-i", "long": "--indicated" }, { "name": "-t -T --terminal", "content": "Override the environment variable TERM with the specified terminal type.\n", "flag": "-T", "long": "--terminal" }, { "name": "-V --version", "content": "Display version information and exit.\n", "flag": "-V", "long": "--version" }, { "name": "-h --help", "content": "Display help text and exit.\n", "flag": "-h", "long": "--help" } ] }, "ENVIRONMENT": { "content": "The following environment variable is used:\n\nTERM\nThe TERM variable is used to relate a tty device with its device capability description\n(see terminfo(5)). TERM is set at login time, either by the default terminal type\nspecified in /etc/ttys or as set during the login process by the user in their login file\n(see setenv(3)).\n", "subsections": [] }, "HISTORY": { "content": "The ul command appeared in 3.0BSD.\n", "subsections": [] }, "BUGS": { "content": "nroff usually outputs a series of backspaces and underlines intermixed with the text to\nindicate underlining. No attempt is made to optimize the backward motion.\n", "subsections": [] }, "SEE ALSO": { "content": "colcrt(1), login(1), man(1), nroff(1), setenv(3), terminfo(5)\n", "subsections": [] }, "REPORTING BUGS": { "content": "For bug reports, use the issue tracker at https://github.com/karelzak/util-linux/issues.\n", "subsections": [] }, "AVAILABILITY": { "content": "The ul command is part of the util-linux package which can be downloaded from Linux Kernel\nArchive .\n\n\n\nutil-linux 2.37.2 2021-06-02 UL(1)", "subsections": [] } } } }