home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / cli / sksh017.lzh / doc / Readme_1st.doc < prev    next >
Encoding:
Text File  |  1991-05-04  |  5.9 KB  |  265 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                   Important Stuff - Read This First!
  17.  
  18.                                  SKsh
  19.  
  20.                     A ksh-like Shell for the Amiga
  21.  
  22.                               Version 1.7
  23.  
  24.  
  25.                          (Copyright) 1989-1991
  26.  
  27.                               Steve Koren
  28.  
  29.                               May 4, 1991
  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.        Important: Please Read This First!
  74.  
  75.      This archive  contains the 1.7 release of SKsh, a shell for the
  76.      Amiga  which  is  similar to Unix ksh.  1.2 was the first  'Re-
  77.      lease' version; 1.0 and 1.1 were beta versions.
  78.  
  79.      SKsh  is  probably not as  powerful as ARexx (a language inter-
  80.      preter  for  AmigaDos  designed to integrate different applica-
  81.      tions), but I think it will still be very useful.  It  provides
  82.      a  number of things that other Amiga  shells  do  not.  In  any
  83.      case, I hope it will  be  useful to Unix users who wish to have
  84.      a  similar environment on the Amiga.  Unix provides many things
  85.      that SKsh does not, but  SKsh  comes  closer  than  most  other
  86.      Amiga shells.
  87.  
  88.      Please  understand that since the code can change at any  time,
  89.      absolutely anything you read here is also subject to change.
  90.  
  91.      Suggestions can be sent to me  (Steve  Koren)  by  one  of  the
  92.      methods listed in the "MiscInfo.doc" document.
  93.  
  94.      The  following files are  included in this documentation.  This
  95.      list is also subject to change:
  96.  
  97.         Addendum?.?.doc  - An addendum for each release
  98.         Bugs.doc         - Bug reports, limitations, etc. 
  99.         Diffs.doc        - Very incomplete list of diffs from ksh
  100.         ErrorCodes.doc   - The SKsh error codes
  101.         ExtCmds.doc      - Reference manual for external commands
  102.         Hints.doc        - A few hints for using SKsh
  103.         Install.doc      - How to Install SKsh - important
  104.         MiscInfo.doc     - How to report bugs, etc.
  105.         ReadMe_1st.doc   - This file
  106.         Reference.doc    - Reference manual for builtin stuff
  107.         TechNotes.doc    - Technical and implementation notes
  108.         TinySKsh.doc     - Briefly describes tiny_sksh
  109.         UserMan.doc      - User's guide to using SKsh
  110.         View.doc         - Describes the "view" command
  111.  
  112.      The UserMan.doc file is an introduction and tutorial  to  SKsh.
  113.      The Reference.doc file is a more  complete  reference  on  most
  114.      SKsh commands except external binaries, which are described  in
  115.      the ExtCmds.doc and View.Doc files.
  116.  
  117.      The folowing SKsh and initialization files should be included:
  118.  
  119.         sksh             - the main SKsh binary + builtins
  120.         sksh.msg         - the sksh message file
  121.         tiny_sksh        - smaller, unsupported version of SKsh
  122.         .skshinit        - initialization file for SKsh
  123.         .skshinit.pp     - preparsed form of above
  124.         .skshrc          - user customization file for SKsh
  125.         stuff.sksh       - other useful functions
  126.  
  127.  
  128.  
  129.        SKsh Amiga Shell             Page 2           Readme Information
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.      The following external binary files should be included:
  140.  
  141.         cat              - concatenate files
  142.         cmp              - compare files
  143.         cp               - copy files
  144.         crc              - perform crc check on files
  145.         cut              - cut characters or fields
  146.         doc2man          - split man page entries
  147.         du               - check disk usage
  148.         encr             - encrypt/decrypt files
  149.         fgrep            - fast search for strings in files
  150.         find             - find files in directory tree
  151.         grep             - search for expressions in files
  152.         head             - obtain first few lines of files
  153.         indent           - indent lines of files
  154.         join             - join files together
  155.         num              - number lines in files
  156.         split            - split ASCII files into small pieces
  157.         srun             - run command in background
  158.         strings          - search for strings in files
  159.         tail             - obtain last few lines of files
  160.         tee              - copy input to files and std output
  161.         view             - file type encapsulator
  162.         wc               - count lines, words, and characters
  163.         window           - window operations
  164.         xargs            - execute command lines on parameters
  165.         xd               - hex dump of files
  166.  
  167.  
  168.      The  following  SKsh  commands  are  implemented as scripts and
  169.      should be included:
  170.  
  171.         chext            - changes extensions of files
  172.         cleard           - clear the directory stack
  173.         dstack           - list the directory stack
  174.         emacs_mode       - use emacs command line editing mode
  175.         histlist         - list saved history files
  176.         histload         - load shell history from a file
  177.         histrm           - remove saved shell history files
  178.         histsave         - save shell history in a file
  179.         man              - look up entries in manual pages
  180.         path             - examine, set, or modify paths
  181.         popd             - pop directory from directory stack
  182.         pushd            - push directory onto directory stack
  183.         qrm              - query remove files
  184.         usage            - print usage message for commands
  185.         vi_mode          - use vi command line editing mode
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.        SKsh Amiga Shell             Page 3           Readme Information
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.      These files should also be  included, although their use is op-
  206.      tional:
  207.  
  208.         Stuff.sksh       - optional utilities, functions, aliases
  209.         view.magic       - Sample magic file for the "view" command
  210.         tiny_sksh        - A smaller, more limited version of SKsh
  211.         crypted_data     - encrypted english text from encr
  212.         Install_?.?.sksh - a script file to assist installation
  213.  
  214.      If you do not have ALL of  the  above  files,  your  version of
  215.      SKsh is incomplete.
  216.  
  217.      Also, please  carefully read the Installation guide.  You *can-
  218.      not*  simply type  SKsh  and  expect it to run; you must follow
  219.      the directions there for proper results.
  220.  
  221.      Also, please read the SKsh  copyright  statement  contained  in
  222.      the UserMan.doc file.  SKsh is NOT public domain software.
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.        SKsh Amiga Shell             Page 4           Readme Information
  262.  
  263.  
  264.  
  265.