{ "content": [ { "type": "text", "text": "# DIR_COLORS (man)\n\n## NAME\n\ndircolors - configuration file for dircolors(1)\n\n## DESCRIPTION\n\nThe program ls(1) uses the environment variable LSCOLORS to determine the colors in which\nthe filenames are to be displayed. This environment variable is usually set by a command\nlike\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION** (5 subsections)\n- **FILES**\n- **NOTES**\n- **SEE ALSO**\n- **COLOPHON**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "DIR_COLORS", "section": "", "mode": "man", "summary": "dircolors - configuration file for dircolors(1)", "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "dircolors", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/dircolors/1/json" }, { "name": "ls", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ls/1/json" }, { "name": "stty", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/stty/1/json" }, { "name": "xterm", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/xterm/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 28, "subsections": [ { "name": "COLOR yes|all|no|none|tty", "lines": 4 }, { "name": "EIGHTBIT yes|no", "lines": 109 }, { "name": "ISO 6429 (ANSI) color sequences", "lines": 49 }, { "name": "Other terminal types (advanced configuration)", "lines": 16 }, { "name": "Escape sequences", "lines": 23 } ] }, { "name": "FILES", "lines": 11, "subsections": [] }, { "name": "NOTES", "lines": 7, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "COLOPHON", "lines": 7, "subsections": [] } ], "sections": { "NAME": { "content": "dircolors - configuration file for dircolors(1)\n", "subsections": [] }, "DESCRIPTION": { "content": "The program ls(1) uses the environment variable LSCOLORS to determine the colors in which\nthe filenames are to be displayed. This environment variable is usually set by a command\nlike\n\neval `dircolors somepath/dircolors`\n\nfound in a system default shell initialization file, like /etc/profile or /etc/csh.cshrc.\n(See also dircolors(1).) Usually, the file used here is /etc/DIRCOLORS and can be overrid‐\nden by a .dircolors file in one's home directory.\n\nThis configuration file consists of several statements, one per line. Anything right of a\nhash mark (#) is treated as a comment, if the hash mark is at the beginning of a line or is\npreceded by at least one whitespace. Blank lines are ignored.\n\nThe global section of the file consists of any statement before the first TERM statement.\nAny statement in the global section of the file is considered valid for all terminal types.\nFollowing the global section is one or more terminal-specific sections, preceded by one or\nmore TERM statements which specify the terminal types (as given by the TERM environment vari‐\nable) the following declarations apply to. It is always possible to override a global decla‐\nration by a subsequent terminal-specific one.\n\nThe following statements are recognized; case is insignificant:\n\nTERM terminal-type\nStarts a terminal-specific section and specifies which terminal it applies to. Multi‐\nple TERM statements can be used to create a section which applies for several terminal\ntypes.\n", "subsections": [ { "name": "COLOR yes|all|no|none|tty", "content": "(Slackware only; ignored by GNU dircolors(1).) Specifies that colorization should al‐\nways be enabled (yes or all), never enabled (no or none), or enabled only if the out‐\nput is a terminal (tty). The default is no.\n" }, { "name": "EIGHTBIT yes|no", "content": "(Slackware only; ignored by GNU dircolors(1).) Specifies that eight-bit ISO 8859\ncharacters should be enabled by default. For compatibility reasons, this can also be\nspecified as 1 for yes or 0 for no. The default is no.\n\nOPTIONS options\n(Slackware only; ignored by GNU dircolors(1).) Adds command-line options to the de‐\nfault ls command line. The options can be any valid ls command-line options, and\nshould include the leading minus sign. Note that dircolors does not verify the valid‐\nity of these options.\n\nNORMAL color-sequence\nSpecifies the color used for normal (nonfilename) text.\n\nSynonym: NORM.\n\nFILE color-sequence\nSpecifies the color used for a regular file.\n\nDIR color-sequence\nSpecifies the color used for directories.\n\nLINK color-sequence\nSpecifies the color used for a symbolic link.\n\nSynonyms: LNK, SYMLINK.\n\nORPHAN color-sequence\nSpecifies the color used for an orphaned symbolic link (one which points to a nonexis‐\ntent file). If this is unspecified, ls will use the LINK color instead.\n\nMISSING color-sequence\nSpecifies the color used for a missing file (a nonexistent file which nevertheless has\na symbolic link pointing to it). If this is unspecified, ls will use the FILE color\ninstead.\n\nFIFO color-sequence\nSpecifies the color used for a FIFO (named pipe).\n\nSynonym: PIPE.\n\nSOCK color-sequence\nSpecifies the color used for a socket.\n\nDOOR color-sequence\n(Supported since fileutils 4.1) Specifies the color used for a door (Solaris 2.5 and\nlater).\n\nBLK color-sequence\nSpecifies the color used for a block device special file.\n\nSynonym: BLOCK.\n\nCHR color-sequence\nSpecifies the color used for a character device special file.\n\nSynonym: CHAR.\n\nEXEC color-sequence\nSpecifies the color used for a file with the executable attribute set.\n\nSUID color-sequence\nSpecifies the color used for a file with the set-user-ID attribute set.\n\nSynonym: SETUID.\n\nSGID color-sequence\nSpecifies the color used for a file with the set-group-ID attribute set.\n\nSynonym: SETGID.\n\nSTICKY color-sequence\nSpecifies the color used for a directory with the sticky attribute set.\n\nSTICKYOTHERWRITABLE color-sequence\nSpecifies the color used for an other-writable directory with the executable attribute\nset.\n\nSynonym: OWT.\n\nOTHERWRITABLE color-sequence\nSpecifies the color used for an other-writable directory without the executable attri‐\nbute set.\n\nSynonym: OWR.\n\nLEFTCODE color-sequence\nSpecifies the left code for non-ISO 6429 terminals (see below).\n\nSynonym: LEFT.\n\nRIGHTCODE color-sequence\nSpecifies the right code for non-ISO 6429 terminals (see below).\n\nSynonym: RIGHT.\n\nENDCODE color-sequence\nSpecifies the end code for non-ISO 6429 terminals (see below).\n\nSynonym: END.\n\n*extension color-sequence\nSpecifies the color used for any file that ends in extension.\n\n.extension color-sequence\nSame as *.extension. Specifies the color used for any file that ends in .extension.\nNote that the period is included in the extension, which makes it impossible to spec‐\nify an extension not starting with a period, such as ~ for emacs backup files. This\nform should be considered obsolete.\n" }, { "name": "ISO 6429 (ANSI) color sequences", "content": "Most color-capable ASCII terminals today use ISO 6429 (ANSI) color sequences, and many common\nterminals without color capability, including xterm and the widely used and cloned DEC VT100,\nwill recognize ISO 6429 color codes and harmlessly eliminate them from the output or emulate\nthem. ls uses ISO 6429 codes by default, assuming colorization is enabled.\n\nISO 6429 color sequences are composed of sequences of numbers separated by semicolons. The\nmost common codes are:\n\n0 to restore default color\n1 for brighter colors\n4 for underlined text\n5 for flashing text\n30 for black foreground\n31 for red foreground\n32 for green foreground\n33 for yellow (or brown) foreground\n34 for blue foreground\n35 for purple foreground\n36 for cyan foreground\n37 for white (or gray) foreground\n40 for black background\n41 for red background\n42 for green background\n43 for yellow (or brown) background\n44 for blue background\n45 for purple background\n46 for cyan background\n47 for white (or gray) background\n\nNot all commands will work on all systems or display devices.\n\nls uses the following defaults:\n\nNORMAL 0 Normal (nonfilename) text\nFILE 0 Regular file\nDIR 32 Directory\nLINK 36 Symbolic link\nORPHAN undefined Orphaned symbolic link\nMISSING undefined Missing file\nFIFO 31 Named pipe (FIFO)\nSOCK 33 Socket\nBLK 44;37 Block device\nCHR 44;37 Character device\nEXEC 35 Executable file\n\nA few terminal programs do not recognize the default properly. If all text gets colorized\nafter you do a directory listing, change the NORMAL and FILE codes to the numerical codes for\nyour normal foreground and background colors.\n" }, { "name": "Other terminal types (advanced configuration)", "content": "If you have a color-capable (or otherwise highlighting) terminal (or printer!) which uses a\ndifferent set of codes, you can still generate a suitable setup. To do so, you will have to\nuse the LEFTCODE, RIGHTCODE, and ENDCODE definitions.\n\nWhen writing out a filename, ls generates the following output sequence: LEFTCODE typecode\nRIGHTCODE filename ENDCODE, where the typecode is the color sequence that depends on the type\nor name of file. If the ENDCODE is undefined, the sequence LEFTCODE NORMAL RIGHTCODE will be\nused instead. The purpose of the left- and rightcodes is merely to reduce the amount of typ‐\ning necessary (and to hide ugly escape codes away from the user). If they are not appropri‐\nate for your terminal, you can eliminate them by specifying the respective keyword on a line\nby itself.\n\nNOTE: If the ENDCODE is defined in the global section of the setup file, it cannot be unde‐\nfined in a terminal-specific section of the file. This means any NORMAL definition will have\nno effect. A different ENDCODE can, however, be specified, which would have the same effect.\n" }, { "name": "Escape sequences", "content": "To specify control- or blank characters in the color sequences or filename extensions, either\nC-style \\-escaped notation or stty-style ^-notation can be used. The C-style notation in‐\ncludes the following characters:\n\n\\a Bell (ASCII 7)\n\\b Backspace (ASCII 8)\n\\e Escape (ASCII 27)\n\\f Form feed (ASCII 12)\n\\n Newline (ASCII 10)\n\\r Carriage Return (ASCII 13)\n\\t Tab (ASCII 9)\n\\v Vertical Tab (ASCII 11)\n\\? Delete (ASCII 127)\n\\nnn Any character (octal notation)\n\\xnnn Any character (hexadecimal notation)\n\\ Space\n\\\\ Backslash (\\)\n\\^ Caret (^)\n\\# Hash mark (#)\n\nNote that escapes are necessary to enter a space, backslash, caret, or any control character\nanywhere in the string, as well as a hash mark as the first character.\n" } ] }, "FILES": { "content": "/etc/DIRCOLORS\n(Slackware, SuSE and RedHat only; ignored by GNU dircolors(1) and thus Debian.) Sys‐\ntem-wide configuration file.\n\n~/.dircolors\n(Slackware, SuSE and RedHat only; ignored by GNU dircolors(1) and thus Debian.) Per-\nuser configuration file.\n\nThis page describes the dircolors file format as used in the fileutils-4.1 package; other\nversions may differ slightly.\n", "subsections": [] }, "NOTES": { "content": "The default LEFTCODE and RIGHTCODE definitions, which are used by ISO 6429 terminals are:\n\nLEFTCODE \\e[\nRIGHTCODE m\n\nThe default ENDCODE is undefined.\n", "subsections": [] }, "SEE ALSO": { "content": "dircolors(1), ls(1), stty(1), xterm(1)\n", "subsections": [] }, "COLOPHON": { "content": "This page is part of release 5.10 of the Linux man-pages project. A description of the\nproject, information about reporting bugs, and the latest version of this page, can be found\nat https://www.kernel.org/doc/man-pages/.\n\n\n\nGNU 2020-08-13 DIRCOLORS(5)", "subsections": [] } } } }