-.\"
+.\"
.\" manpage for /etc/dir_colors, config file for dircolors(1)
.\" extracted from color-ls 3.12.0.3 dircolors(1) manpage
.\"
.\"
.\" Modified Sat Dec 22 22:25:33 2001 by Martin Schulze <joey@infodrom.org>
.\"
-.TH DIR_COLORS 5 2001-12-26 "GNU fileutils 4.1"
+.TH DIR_COLORS 5 2001-12-26 "GNU" "Linux User Manual"
.SH NAME
dir_colors \- configuration file for dircolors(1)
.SH DESCRIPTION
This configuration file consists of several statements, one per line.
Anything right of a hash mark (#) is treated as a comment, if the
hash mark is at the beginning of a line or is preceded by at least one
-whitespace. Blank lines are ignored.
+whitespace.
+Blank lines are ignored.
.PP
The
.I global
section of the file consists of any statement before the first
.B TERM
-statement. Any statement in the global section of the file is
-considered valid for all terminal types. Following the global section
-is one or more
+statement.
+Any statement in the global section of the file is
+considered valid for all terminal types.
+Following the global section
+is one or more
.I terminal-specific
sections, preceded by one or more
.B TERM
statements which specify the terminal types (as given by the
.B TERM
-environment variable) the following declarations apply to. It is
-always possible to override a global declaration by a subsequent
+environment variable) the following declarations apply to.
+It is always possible to override a global declaration by a subsequent
terminal-specific one.
.PP
The following statements are recognized; case is insignificant:
-.PP
.TP
.B TERM \fIterminal-type\fR
Starts a terminal-specific section and specifies which terminal it
-applies to. Multiple
+applies to.
+Multiple
.B TERM
statements can be used to create a section which applies for several
terminal types.
.BR dircolors (1).)
Specifies that colorization should always be enabled (\fIyes\fR or
\fIall\fR), never enabled (\fIno\fR or \fInone\fR), or enabled only if
-the output is a terminal (\fItty\fR). The default is \fIno\fR.
+the output is a terminal (\fItty\fR).
+The default is \fIno\fR.
.TP
.B EIGHTBIT yes|no
(Slackware only; ignored by GNU
.BR dircolors (1).)
Specifies that eight-bit ISO 8859 characters should be enabled by
-default. For compatibility reasons, this can also be specified as 1 for
-\fIyes\fR or 0 for \fIno\fR. The default is \fIno\fR.
+default.
+For compatibility reasons, this can also be specified as 1 for
+\fIyes\fR or 0 for \fIno\fR.
+The default is \fIno\fR.
.TP
.B OPTIONS \fIoptions\fR
(Slackware only; ignored by GNU
.BR dircolors (1).)
Adds command line options to the default
.B ls
-command line. The options can be any valid
+command line.
+The options can be any valid
.B ls
command line options, and should include the leading minus sign.
Please note that
.TP
.B ORPHAN \fIcolor-sequence\fR
Specifies the color used for an orphaned symbolic link (one which
-points to a nonexistent file). If this is unspecified,
+points to a nonexistent file).
+If this is unspecified,
.B ls
will use the
.B LINK
.TP
.B MISSING \fIcolor-sequence\fR
Specifies the color used for a missing file (a nonexistent file which
-nevertheless has a symbolic link pointing to it). If this is unspecified,
+nevertheless has a symbolic link pointing to it).
+If this is unspecified,
.B ls
will use the
.B FILE
Specifies the color used for a socket.
.TP
.B DOOR \fIcolor-sequence\fR
-(Supported since file-utils 4.1)
+(Supported since fileutils 4.1)
Specifies the color used for a door (Solaris 2.5 and later).
.TP
.B BLK \fIcolor-sequence\fR
Specifies the color used for any file that ends in \fIextension\fR.
.TP
\fB .\fIextension\fR \fIcolor-sequence\fR
-Same as \fB*\fR.\fIextension\fR. Specifies the color used for any file that
-ends in .\fIextension\fR. Note that the period is included in the
+Same as \fB*\fR.\fIextension\fR.
+Specifies the color used for any file that
+ends in .\fIextension\fR.
+Note that the period is included in the
extension, which makes it impossible to specify an extension not
starting with a period, such as
.B ~
for
.B emacs
-backup files. This form should be considered obsolete.
-.SH "ISO 6429 (ANSI) COLOR SEQUENCES"
+backup files.
+This form should be considered obsolete.
+.SS "ISO 6429 (ANSI) Color Sequences"
Most color-capable ASCII terminals today use ISO 6429 (ANSI) color sequences,
and many common terminals without color capability, including
.B xterm
uses ISO 6429 codes by default, assuming colorization is enabled.
ISO 6429 color sequences are composed of sequences of numbers
-separated by semicolons. The most common codes are:
+separated by semicolons.
+The most common codes are:
.sp
.RS +.2i
.ta 1.0i
.nf
0 to restore default color
- 1 for brighter colors
+ 1 for brighter colors
4 for underlined text
5 for flashing text
30 for black foreground
\fBFILE\fR 0 Regular file
\fBDIR\fR 32 Directory
\fBLINK\fR 36 Symbolic link
-\fBORPHAN\fR undefined Orphanned symbolic link
+\fBORPHAN\fR undefined Orphaned symbolic link
\fBMISSING\fR undefined Missing file
\fBFIFO\fR 31 Named pipe (FIFO)
\fBSOCK\fR 33 Socket
.fi
.RE
.sp
-A few terminal programs do not recognize the default
-properly. If all text gets colorized after you do a directory
+A few terminal programs do not recognize the default
+properly.
+If all text gets colorized after you do a directory
listing, change the
.B NORMAL
and
.B FILE
codes to the numerical codes for your normal foreground and background
colors.
-.SH "OTHER TERMINAL TYPES (ADVANCED CONFIGURATION)"
+.SS "Other Terminal Types (Advanced Configuration)"
If you have a color-capable (or otherwise highlighting) terminal (or
printer!) which uses a different set of codes, you can still generate
-a suitable setup. To do so, you will have to use the
+a suitable setup.
+To do so, you will have to use the
.BR LEFTCODE ,
.BR RIGHTCODE ,
and
-.BR ENDCODE
+.B ENDCODE
definitions.
.PP
When writing out a filename,
.BR ENDCODE ,
where the
.I typecode
-is the color sequence that depends on the type or name of file. If the
+is the color sequence that depends on the type or name of file.
+If the
.B ENDCODE
is undefined, the sequence
.B "LEFTCODE NORMAL RIGHTCODE"
-will be used instead. The purpose of the left- and rightcodes is
+will be used instead.
+The purpose of the left- and rightcodes is
merely to reduce the amount of typing necessary (and to hide ugly
-escape codes away from the user). If they are not appropriate for
+escape codes away from the user).
+If they are not appropriate for
your terminal, you can eliminate them by specifying the respective
keyword on a line by itself.
.PP
.B ENDCODE
is defined in the global section of the setup file, it
.I cannot
-be undefined in a terminal-specific section of the file. This means
-any
+be undefined in a terminal-specific section of the file.
+This means any
.B NORMAL
-definition will have no effect. A different
+definition will have no effect.
+A different
.B ENDCODE
can, however, be specified, which would have the same effect.
-.SH "ESCAPE SEQUENCES"
+.SS "Escape Sequences"
To specify control- or blank characters in the color sequences or
filename extensions, either C-style \e-escaped notation or
-.BR stty -style
-^-notation can be used. The C-style notation
+.BR stty \-style
+^-notation can be used.
+The C-style notation
includes the following characters:
.sp
.RS +.2i
Please note that escapes are necessary to enter a space, backslash,
caret, or any control character anywhere in the string, as well as a
hash mark as the first character.
+.SH FILES
+.TP
+.I /etc/DIR_COLORS
+System-wide configuration file.
+.TP
+.I ~/.dir_colors
+Per-user configuration file.
+.PP
+This page describes the
+.B dir_colors
+file format as used in the fileutils-4.1 package;
+other versions may differ slightly.
.SH NOTES
The default
.B LEFTCODE
.BR ls (1),
.BR stty (1),
.BR xterm (1)
-.SH FILES
-.TP
-.I /etc/DIR_COLORS
-System-wide configuration file.
-.TP
-.I ~/.dir_colors
-Per-user configuration file.
-.SH NOTES
-This page describes the
-.B dir_colors
-file format as used in the fileutils-4.1 package;
-other versions may differ slightly.
projects / thirdparty / man-pages.git / blobdiff