home *** CD-ROM | disk | FTP | other *** search
/ Freelog Special Edition 1: Linux / CD1.iso / doc / HOWTO / mini / Colour-ls < prev    next >
Text File  |  1998-10-14  |  12KB  |  307 lines
  1.   Colours with Linux terminals
  2.   Thorbj°rn Ravn Andersen, ravn@dit.ou.dk
  3.   v1.4, 7 August 1997
  4.  
  5.   Most Linux distributions have a 'ls' command for listing the contents
  6.   of a directory that can visually enhance their output by using differ¡
  7.   ent colours, but configuring this to taste may not be a trivial task.
  8.   This document explains the various aspects and approaches of altering
  9.   the setup by configuring existing software, plus locations of alterna¡
  10.   tive software usually not included with Slackware or RedHat, which may
  11.   be used on most versions of Unix.  The HTML version is also available
  12.   from my own source at <http://www.mip.ou.dk/~ravn/colour-ls>.
  13.  
  14.   1.  Introduction
  15.  
  16.   In recent years colour displays have become very common, and users are
  17.   beginning to exploit this by using programs that utilizes colours to
  18.   give quick visual feedback on e.g. reserved keywords in programming
  19.   languages, or instant notification of misspelled words.
  20.  
  21.   As the Linux text console supports colour, the original GNU ls was
  22.   quickly modified to output colour information and included in
  23.   Slackware around version 2.0.  Improved versions of these patches have
  24.   now migrated into the standard GNU distribution of ls, and should
  25.   therefore be a part of all new Linux distributions by now.
  26.  
  27.   This revision is an update on a major rewrite from the initial
  28.   release, including information on xterms and kernel patching.
  29.  
  30.   The information in this document has been confirmed on Redhat 4.1, and
  31.   was originally compiled with the 2.0.2 release of Slackware, and the
  32.   1.1.54 kernel.  The kernel patch information was retrieved on
  33.   slackware 2.2.0 with the 1.2.13 kernel, and tcsh as the default shell,
  34.   and later confirmed with a 2.0.27 kernel.  If you use any other
  35.   configuration, or unix version, I would appreciate a note stating your
  36.   operating system and version, and whether colour support is available
  37.   as standard.
  38.  
  39.   2.  Quickstart for the impatient
  40.  
  41.   If you have a new distribution of Linux, do these modifications to
  42.   these files in your home directory.  They take effect after next
  43.   login.
  44.  
  45.        ~/.bashrc:
  46.            alias ls="ls --color"
  47.  
  48.        ~/.cshrc:
  49.            alias ls 'ls --color'
  50.  
  51.   That's it!
  52.  
  53.   You may also want to do an ``eval `dircolors $HOME/.colourrc`'', to
  54.   get your own colours.  This file is created with ``dircolors -p
  55.   >$HOME/.colourrc'' and is well commented for further editing.
  56.  
  57.   3.  Do I have it at all?
  58.  
  59.   First of all you need to know if you have a version of ls which knows
  60.   how to colourize properly.  Try this command in a Linux text console
  61.   (although an xterm will do):
  62.  
  63.        % ls --color
  64.  
  65.   (the % is a shell prompt):
  66.  
  67.   If you get an error message indicating that ls does not understand the
  68.   option, you need to install a new version of the GNU fileutils
  69.   package.  If you do not have an appropriate upgrade package for your
  70.   distribution, just get the latest version from your GNU mirror and
  71.   install directly from source.
  72.  
  73.   If you do not get an error message, you have a ls which understands
  74.   the command.  Unfortunately, some of the earlier versions included
  75.   previously with Slackware (and possible others) were buggy.  The ls
  76.   included with Redhat 4.1 is version 3.13 which is okay.
  77.  
  78.        % ls --version
  79.        ls - GNU fileutils-3.13
  80.  
  81.   If you ran the ``ls -- color'' command on a Linux textbased console,
  82.   the output should have been colourized according to the defaults on
  83.   the system, and you can now decide whether there is anything you want
  84.   to change.
  85.  
  86.   If you ran it in an xterm, you may or you may not have seen any colour
  87.   changes.  As with ls itself, the original xterm-program did not have
  88.   any support of colour for the programs running inside of it, but
  89.   recent versions do.  If your xterm doesn't support colours, you should
  90.   get a new version as described at the end of this document.  In the
  91.   meantime just switch to textmode and continue from there.
  92.  
  93.   4.  Which colours is there to choose from?
  94.  
  95.   This shell script (thanks to the many who sent me bash versions) shows
  96.   all standard colour combinations on the current console.  If no
  97.   colours appear, your console does not support ANSI colour selections.
  98.  
  99.   #!/bin/bash
  100.   # Display ANSI colours.
  101.   #
  102.   esc="\033["
  103.   echo -n " _ _ _ _ _40 _ _ _ 41_ _ _ _42 _ _ _ 43"
  104.   echo "_ _ _ 44_ _ _ _45 _ _ _ 46_ _ _ _47 _"
  105.   for fore in 30 31 32 33 34 35 36 37; do
  106.     line1="$fore  "
  107.     line2="    "
  108.     for back in 40 41 42 43 44 45 46 47; do
  109.       line1="${line1}${esc}${back};${fore}m Normal  ${esc}0m"
  110.       line2="${line2}${esc}${back};${fore};1m Bold    ${esc}0m"
  111.     done
  112.     echo -e "$line1\n$line2"
  113.   done
  114.  
  115.   The foreground colour number is listed to the left, and the background
  116.   number in the box.  If you want bold characters you add a "1" to the
  117.   parameters, so bright blue on white would be "37;44;1".  The whole
  118.   ANSI selection sequence is then
  119.  
  120.   ESC [ 3 7 ; 4 4 ; 1 m
  121.  
  122.   Note: The background currently cannot be bold, so you cannot have
  123.   yellow (bold brown) as anything but foreground.  This is a hardware
  124.   limitation.
  125.  
  126.   The colours are:
  127.           0 - black    4 - blue           3# is foreground
  128.           1 - red      5 - magenta        4# is background
  129.           2 - green    6 - cyan
  130.           3 - yellow   7 - white          ;1 is bold
  131.  
  132.   5.  How to configure colours with ls
  133.  
  134.   If you wish to modify the standard colour set built into ls, you need
  135.   your personal copy in your home directory, which you get with
  136.  
  137.         cd ; dircolors -p > .coloursrc
  138.  
  139.   After modifying this well-commented file you need to have it read into
  140.   the environment string LS_COLORS, which is usually done with
  141.  
  142.        eval `dircolors .colourrc`
  143.  
  144.   You need to put this line in your .bashrc/.cshrc/.tcshrc (depending on
  145.   your shell), to have it done at each login.  See the dircolors(1)
  146.   manual page for details.
  147.  
  148.   6.  How to change the text-mode default from white-on-black
  149.  
  150.   You will need to tell the terminal driver code that you want another
  151.   default.  There exists no standard way of doing this, but in case of
  152.   Linux you have the setterm program.
  153.  
  154.   "setterm" uses the information in the terminal database to set the
  155.   attributes.  Selections are done like
  156.  
  157.        setterm -foreground black -background white -store
  158.  
  159.   where the "-store" besides the actual change makes it the default for
  160.   the current console as well.  This requires that the current terminal
  161.   (TERM environment variable) is described "well enough" in the termcap
  162.   database.  If setterm for some reason does not work, here are some
  163.   alternatives:
  164.  
  165.   6.1.  Xterm
  166.  
  167.   One of these xterms should be available and at least one of them
  168.   support colour.
  169.  
  170.        xterm -fg white -bg blue4
  171.        color_xterm -fg white -bg blue4
  172.        color-xterm -fg white -bg blue4
  173.        nxterm -fg white -bg blue4
  174.  
  175.   where 'color_xterm' supports the colour version of 'ls'.  This
  176.   particular choice resembles the colours used on an SGI.
  177.  
  178.   6.2.  Virtual console.
  179.  
  180.   You may modify the kernel once and for all, as well as providing a
  181.   run-time default for the virtual consoles with an escape sequence.  I
  182.   recommend the kernel patch if you have compiled your own kernel.
  183.  
  184.   The kernel source file is /usr/src/linux/drivers/char/console.c around
  185.   line 1940, where you should modify
  186.  
  187.           def_color       = 0x07;   /* white */
  188.           ulcolor         = 0x0f;   /* bold white */
  189.           halfcolor       = 0x08;   /* grey */
  190.  
  191.   as appropriate.  I use white on blue with
  192.  
  193.                def_color       = 0x17;   /* white */
  194.                ulcolor         = 0x1f;   /* bold white */
  195.                halfcolor       = 0x18;   /* grey */
  196.  
  197.   The numbers are the attribute codes used by the video card in
  198.   hexadecimal: the most significant digit (the "1" in the example
  199.   colours above) is the background; the least significant the
  200.   foreground. 0 = black, 1 = blue, 2 = green, 3 = cyan, 4 = red, 5 =
  201.   purple, 6 = brown/yellow, 7 = white. Add 8 to get "bright" colours.
  202.   Note that, in most cases, a bright background == blinking characters,
  203.   dull background. (From sjlam1@mda023.cc.monash.edu.au
  204.   <mailto:sjlam1@mda023.cc.monash.edu.au>).
  205.  
  206.   You may also supply a new run-time default for a virtual console, on a
  207.   per-display basis with the non-standard ANSI sequence (found by
  208.   browsing the kernel sources)
  209.  
  210.                ESC [ 8 ]
  211.  
  212.   which sets the default to the current fore- and background colours.
  213.   Then the Reset Attributes string (ESC [ m) selects these colours
  214.   instead of white on black.
  215.  
  216.   You will need to actually echo this string to the console each time
  217.   you reboot.  Depending on what you use your Linux box for, several
  218.   places may be appropriate:
  219.  
  220.   6.2.1.  /etc/issue
  221.  
  222.   This is where "Welcome to Linux xx.yy" is displayed under Slackware,
  223.   and that is a good choice for stand-alone equipment (and probably be a
  224.   pestilence for users logging in with telnet).  This file is created at
  225.   boottime (Slackware in /etc/rc.d/rc.S; Redhat in /etc/rc.d/rc.local),
  226.   and you should modify lines looking somewhat like
  227.  
  228.          echo ""> /etc/issue
  229.          echo Welcome to Linux `/bin/uname -a | /bin/cut -d\  -f3`. >> /etc/issue
  230.  
  231.   to
  232.  
  233.     ESCAPE="<replace with a single escape character here>"
  234.     echo "${ESCAPE}[H${ESCAPE}[37;44m${ESCAPE}[8]${ESCAPE}[2J"> /etc/issue
  235.     echo Welcome to Linux `/bin/uname -a | /bin/cut -d\  -f3`. >> /etc/issue
  236.  
  237.   This code will home the cursor, set the colour (here white on blue),
  238.   save this selection and clean the rest of the screen.  The
  239.   modification takes effect after the next reboot.  Remember to insert
  240.   the _literal_ escape character in the file with C-q in emacs or
  241.   control-v in vi, as apparently the sh used for executing this script
  242.   does not understand the /033 syntax.
  243.  
  244.   6.2.2.  /etc/profile or .profile
  245.  
  246.          if [ "$TERM" = "console" ]; then
  247.              echo "\033[37;44m\033[8]" #
  248.        # or use setterm.
  249.              setterm -foreground white -background blue -store
  250.          fi
  251.  
  252.   6.2.3.  /etc/login or .login
  253.  
  254.          if ( "$TERM" == "console" ) then
  255.            echo "\033[37;44m\033[8]"
  256.        # or use setterm.
  257.              setterm -foreground white -background blue -store
  258.          endif
  259.  
  260.   6.3.  Remote login
  261.  
  262.   You should be able to use the setterm program as shown above.  Again,
  263.   this requires that the remote machine knows enough about your
  264.   terminal, and that the terminal emulator providing the login supports
  265.   colour. In my experience the best vt100 emulation currently available
  266.   for other platforms are:
  267.  
  268.   ╖  MS-DOS:         MS-Kermit (free, not a Microsoft product)
  269.  
  270.   ╖  Windows 95/NT:  Kermit/95 (shareware)
  271.  
  272.   ╖  OS/2:           Kermit/95 (shareware).  Note though that the
  273.      standard telnet understands colours and can be customized locally.
  274.  
  275.   See  <http://www.columbia.edu/kermit/> for details about Kermit.
  276.  
  277.   7.  Software
  278.  
  279.   All the information described here is assuming a GNU/Linux
  280.   installation.  If you have something else (like e.g. a Sun running X
  281.   or so) you can get and compile the actual software yourself.
  282.  
  283.   The colour version of 'xterm' is based on the standard xterm source
  284.   with a patch available from any X11R6 site.  The xterm distributed
  285.   with R6.3 is rumoured to have native colour support, but is untested
  286.   by me.
  287.  
  288.        ftp://ftp.denet.dk/pub/X11/contrib/utilities/color-xterm-R6pl5-patch.gz
  289.  
  290.   See the documentation if you use an older version of X.  Note: I
  291.   haven't tried this myself!
  292.  
  293.   of the several mirrors.  Get at least version 3.13.
  294.  
  295.        ftp://ftp.denet.dk/pub/gnu/fileutils-3.XX.tar.gz
  296.  
  297.   I have myself successfully compiled color-ls on Solaris, SunOS and
  298.   Irix.
  299.  
  300.   I would appreciate feedback on this text.  My e-mail address is
  301.   ravn@dit.ou.dk <mailto:ravn@dit.ou.dk>
  302.  
  303.   --
  304.  
  305.   Thorbj°rn Ravn Andersen
  306.  
  307.