opendircolors.1

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