aboutsummaryrefslogtreecommitdiffstats
path: root/opendircolors.1
blob: 8291328aac8990fea8f6aee7829ae336466378ea (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
.\"-
.\" Copyright (c) 2021
.\"	Cameron Katri.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY CAMERON KATRI AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL CAMERON KATRI OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd April 27, 2021
.Dt OPENDIRCOLORS 1
.Os
.Sh NAME
.Nm opendircolors
.Nd Generate colors for
.Xr ls 1
.Sh SYNOPSIS
.Nm
.Op Fl bch
.Ar file
.Sh DESCRIPTION
The
.Nm
utility reads the inputed file and generates values for 
.Ev LSCOLORS
and
.Ev LS_COLORS .
This is a near drop in replacement for GNU's
.Xr dircolors 1 ,
except it does not contain 
.Fl p
or have any default values. If
.Ar file
is a single dash
.Pq Sq Fl
.Nm
reads from the standard input.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl b , -sh , -bourne-shell
Format the output for use with a bourne-shell.
.It Fl c , -csh , -c-shell
Format the output for use with
.Xr csh 1
or
.Xr tcsh 1 .
.It Fl h , -help
.El
.Sh ENVIRONMENT
.Bl -tag -width indent
.It Ev LSCOLORS
The color string used for
.Xr ls 1 .
.It Ev LS_COLORS
The color string for GNU
.Xr ls 1
and various other utilities such as
.Xr tree 1 .
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLE
Add 'eval "`opendircolors ~/.dir_colors`"' to your
.Pa .shrc
to automatically set LSCOLORS and LS_COLORS.
.Sh SEE ALSO
.Xr dirconvert 1
.Sh HISTORY
The
.Xr dircolors 1
utility first appeared in GNU coreutils on Apr 29, 1996, written by
.%A H. Peter Anvin .