home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume14 / lc / part01 / README < prev   
Encoding:
Text File  |  1990-09-15  |  4.8 KB  |  112 lines
  1.  
  2.             LC
  3.  
  4.         "@(#)README    1.3 9/7/90 Kent Landfield"
  5.  
  6. This directory contains the source to lc. lc is much like the ls 
  7. command except it separates the types of files into groups and then
  8. displays located file names to the user is a columnar fashion. 
  9.  
  10. lc was initially implemented by myself after I became accustomed
  11. to the lc command on a Mark Williams Coherent system I was running back
  12. in 1984.  When I started moving to different systems I found that I did
  13. not like the lack of information, flexibility and the general display 
  14. that ls provided.  I have found that I am not the only one that has 
  15. become feed up with ls and its jumbled output. All the people here use 
  16. lc much more than they use ls. It is a locally well known fact that when
  17. a new machine comes into the house, the first local software that is put 
  18. on the machine is lc.  It is far from perfect but it is better than ls on 
  19. a general use basis.
  20.  
  21. lc uses three different environment variables COLS, CDPATH, and LC
  22. allowing you to customize how you wish lc to perform on a default 
  23. basis. COLS is used to switch the column width between 80 and 132 
  24. column display.  LC is used to set lc specific options. The command 
  25. line options shown in the option list below are available to be used 
  26. in setting up how lc is to work for you. Options that you supply on 
  27. the command line override options that are specified in the environment.
  28. lc uses CDPATH to locate files that are requested but are not in the 
  29. specified location or within the local directory.
  30.  
  31. lc has incorporated minimal spell checking using slightly modified
  32. routines found in the book, The UNIX Programming Environment, by 
  33. Brian Kernighan and Rob Pike.
  34.  
  35. The following is a quick reference of options to lc. These options
  36. can be specified in the Environment variable LC so that they are
  37. done each time lc is executed.
  38.  
  39.  lc -- categorize files in a directory and list column-wise
  40.  
  41.    Usage:       lc [ options ] [ directory ... ]
  42.  
  43.    Options:
  44.         -a      List dot files as well.
  45.         -b      List block special files only
  46.         -c      List character special files only
  47.         -d      List directories only
  48.         -D      Do not display singular files
  49.         -e      Mark executable files with '*'
  50.         -f      List regular files only
  51.         -F      List fifo files only
  52.         -1      List files one per line instead of in columns
  53.         -r      Do not sort the file names before displaying.
  54.         -m      List shared memory name space entry files only
  55.         -M      List semaphore name space entry files only
  56.         -S      List socket file only
  57.         -s      List symbolic links only
  58.         -L      Display symbolic links
  59.         -l      Mark symbolic links with '@'
  60.         -I      Suppress unresolved symbolic link messages.
  61.   
  62.    The "only" options can not be combined.
  63.  
  64.    If there is no 'directory' specified, the current directory is used.
  65.  
  66.    Not all options are supported on every system. (e.g. no symbolic links
  67.    on your system ? Options -s, -L or -l won't be available..)
  68.    If your system does not support shared memory name space entry files, 
  69.    then you cannot use the -m option...
  70.  
  71. History:
  72.       Initially designed on an IBM-XT running Coherent in 1984.
  73.       Ported to XENIX on an IBM-AT in 1984.
  74.       Ported to System V on AT&T 3Bs in 1985.
  75.       Ported to DEC Vax 11/750 running System V in 1986.
  76.       Ported to BSD4.2 on a Sequent Balance 8000 in 1986.
  77.       Jeff Minnig added the initial support for links.
  78.       Ported to SunOS 4.0 on a Sun 3/60 in 1988.
  79.       Rick Ohnemus did major surgery to remove static storage
  80.       and *greatly* enhanced the link support. Thanks rick!
  81.       Tested with Ultrix 3.0 & 3.1 on a DECstation 3100 in 1989.
  82.       Tested with Ultrix 3.0 & 3.1 on a VAXstation 3500 in 1989.
  83.       Ported to AIX 2.2 on an IBM RT.
  84.       Tested with UTek on a Tektronix 4319 in 1989.
  85.       Tested with IRIX System V on a Silicon Graphics Iris 4D/210GTX in 1989.
  86.       Tested with AmigaDOS 1.3 on an Amiga 1000 in 1989.
  87.       Tested with SunOS 4.0.3 on a Sparkstation 1 in 1989.
  88.       Tested with UTek on a Tektronix XD8810 in 1989.
  89.       Tested with AIX 3.+ on a Risc System/6000 in 1990.
  90.  
  91. The following is a todo list that may get done someday...
  92.  
  93. 1. Port to all flavors of unix on all platforms. Lofty goal but
  94.    on-going... :-)
  95. 2. Need to modify lc so that one environment (or compile) option will
  96.    only let you see files you own or have access to.
  97. 3. Add spell checking code to CDPATH usage
  98. 4. Allow combination of only options...
  99.                                                         
  100.                           *PLEASE!* 
  101. If you have a problem, there's someone else out there who either has
  102. had or will have the same problem.  Please send all "lc" ideas, patches, 
  103. etc to 
  104.  
  105. INTERNET: kent@sparky.IMD.Sterling.COM or UUCP: uunet!ssbell!sparky!kent
  106.  
  107. so that I can continue to improve the functionality and portability of lc.
  108.  
  109.             -Kent+
  110.  
  111.     
  112.