home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / disk / directory / dirking / usermanual.doc < prev    next >
Text File  |  1995-02-27  |  91KB  |  1,857 lines
  2.                   __
  3.                  / ////
  4.           __    ///
  5.           \ \  ///          < < <<<  DirKing v2.12e  >>> > >
  6.            \ \///
  7.             \__////        USER MANUAL - Release : 05-Mar-93
  8.  
  9.                 Copyright ©1990-1993 Chris P. Vandierendonck, [AmiSYS].
  10.  
  11.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12.        Copyright Notice
  13.        ~~~~~~~~~~~~~~~~
  14.          DirKing  is  released  as  SHAREWARE, not excluding the copyright
  15.          and all other rights  which  remain  with  the  author  Chris  P.
  16.          Vandierendonck.  The  program  and  files  included   with   this
  17.          distribution are not freely distributable. Shareware  means  that
  18.          you must register if you use the program.
  19.  
  20.          Prior  written  permission  from  the  author  is   required   to
  21.          distribute  DirKing  or to use  it  in  commercial  releases,  on
  22.          coverdisks or diskmagazines. When distributed, all files must  be
  23.          kept together, in the original unmodified form. 
  24.  
  25.          (AmigaDOS is a trademark of Commodore Amiga Inc.)
  26.  
  27.        Disclaimer
  28.        ~~~~~~~~~~
  29.          DirKing  is  provided  "AS  IS",  WITHOUT  ANY  WARRANTY  to  its
  30.          quality, performance or fitness for a particular purpose.  In  no
  31.          event shall the author be liable or responsible to  the  user  or
  32.          any other person, for any kind of damage caused  by  the  use  of
  33.          this software.
  34.  
  35.          Registering   for   DirKing  is  necessary   to   ensure   future
  36.          development. More information on how to register can be found  in
  37.          this document or in the "Registration.doc".
  38.  
  39.          Registrations, suggestions, remarks and bug  reports  about  this
  40.          program can be send to the following address :
  41.  
  42.               Chris Vandierendonck
  43.               Koning Albertstraat 188
  44.             B-8210   VELDEGEM
  45.               BELGIUM
  46.  
  47.        Preface
  48.        ~~~~~~~
  49.          DirKing  is  a  feature  packed  directory  list  program,  which
  50.          overlaps the AmigaDOS commands List, Dir and  Info.  It  has  all
  51.          the features of the AmigaDOS commands,  but  also  includes  many
  52.          enhancements. The program supports different filter  for  reading
  53.          a directory, allows complex sorting and  gives  full  control  on
  54.          the listing format.   
  55.  
  56.          DirKing is reentrant, so it can be made resident.
  57.  
  58.        System Requirements
  59.        ~~~~~~~~~~~~~~~~~~~
  60.          DirKing v2.12 requires AmigaDOS v1.2 or higher.
  61.  
  62.  
  63.  
  64.                              DirKing v2.1xe (English) User Manual - Page 1
  65.  
  66.        Shareware Registration
  67.        ~~~~~~~~~~~~~~~~~~~~~~
  68.          Registering  for  DirKing ensures  future  development  of  this
  69.          software. You can register under the following conditions :
  70.  
  71.          o See  "Registration.doc" for  more  information,  and  for  the
  72.            registration fee in US dollars, GB  pounds,  German  marks  or
  73.            Belgian franks.
  74.  
  75.          o The base fee is  US$  12.00.  This  fee  covers  a  registered
  76.            version of  DirKing (English, German, French or Ducth version)
  77.            and one free update. 
  78.  
  79.          The following  additional products can only be obtained when you
  80.          pay the base fee, or if you're  already  a  registered  user  of
  81.          DirKing :
  82.  
  83.          o You  can  order  DirKing in other language versions  (English,
  84.            German, French or Dutch) at the price of US$ 6.00. 
  85.  
  86.            NOTE: the one  free  update  in  the  base  registration  fee,
  87.                  does NOT apply to these extra ordered versions!
  88.  
  89.            REMARK: only the program itself supports these languages,  the
  90.                    DirKing documents are only  in  the  english  language
  91.                    (but the user manual is adapted  for  those  functions
  92.                    which use language specific arguments).
  93.  
  94.          o A  laser  printed  copy  of  this  user  manual,  and  related
  95.            documents can be obtained for US$ 6.00 (price per version). 
  96.  
  97.          o All above mentioned amounts include P&P. So you don't have  to
  98.            pay extra, wherever you live.
  99.  
  100.          o You can transfer the money in three ways :
  101.              - in cash (PAPER money ONLY) -> fast and cheap;
  102.              - by EuroCheck (only in Belgian Francs [BEF] !!);
  103.              - by (international) postal money order.
  104.            DO NOT SEND FOREIGN BANKCHECKS, since it's too  expensive  too
  105.            clear them.
  106.  
  107.          o If possible, please use a printout of the  included  'RegForm'
  108.            file to register.
  109.  
  110.          o From the moment I receive the registration  (order)  form  and
  111.            the necessary payments, your order will be processed.
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                              DirKing v2.1xe (English) User Manual - Page 2
  129.  
  130.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  131.                              USER MANUAL CONTENTS  
  132.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  133.          §1  Preliminary remarks. . . . . . . . . . . . . . . . . . .  4
  134.          §2  DirKing keyword and argument syntax. . . . . . . . . . .  5
  135.          §3  Directory scanning . . . . . . . . . . . . . . . . . . .  5
  136.              A. Specifying the directory path . . . . . . . . . . . .  5
  137.                 A.1. Normal directory paths . . . . . . . . . . . . .  5
  138.                      a. General use . . . . . . . . . . . . . . . . .  5
  139.                      b. Advanced use : recursive directory paths. . .  6
  140.                 A.2. Deep level pattern matching. . . . . . . . . . .  6
  141.              B. Filtering directory information . . . . . . . . . . .  7
  142.                 B.1. Global filters . . . . . . . . . . . . . . . . .  8
  143.                 B.2. Filter options . . . . . . . . . . . . . . . . .  9
  144.                 B.3. File- and directoryname filtering. . . . . . . .  9
  145.                 B.4. Conditional date filters . . . . . . . . . . . . 10
  146.              C. Tracing the scanning process. . . . . . . . . . . . . 11
  147.          §4  Directory information. . . . . . . . . . . . . . . . . . 12
  148.              A. Volume (disk) information . . . . . . . . . . . . . . 12
  149.              B. Listing header/end information. . . . . . . . . . . . 14
  150.              C. File- and directory fields. . . . . . . . . . . . . . 15
  151.          §5  Directory sorting. . . . . . . . . . . . . . . . . . . . 17
  152.          §6  Listing formatting . . . . . . . . . . . . . . . . . . . 18
  153.              A. Listing table formatting. . . . . . . . . . . . . . . 18
  154.                 A.1. Setting the listing table width. . . . . . . . . 18
  155.                 A.2. Formatting the listing table . . . . . . . . . . 18
  156.              B. Predefined listing table formats. . . . . . . . . . . 20
  157.              C. Free formatting and script generation (LFORMAT) . . . 20
  158.          §7  DirKing MULTI-mode (multiple directory scanning) . . . . 22
  159.          §8  Listing styles . . . . . . . . . . . . . . . . . . . . . 23
  160.              A. Information format. . . . . . . . . . . . . . . . . . 23
  161.              B. Listing print styles. . . . . . . . . . . . . . . . . 24
  162.          §9  Listing output redirection . . . . . . . . . . . . . . . 25
  163.          §10 Listing paging . . . . . . . . . . . . . . . . . . . . . 26
  164.          §11 Disk identification coding support . . . . . . . . . . . 27
  165.          §12 DirKing program information. . . . . . . . . . . . . . . 28
  166.  
  167.          Appendix: DirKing keyword reference. . . . . . . . . . . . . 29
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                              DirKing v2.1xe (English) User Manual - Page 3
  193.  
  194.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  195.                               DIRKING USER MANUAL  
  196.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  197.              
  198.        §1 Preliminary remarks.
  199.           ~~~~~~~~~~~~~~~~~~~~
  200.           o Although DirKing can be used in the same way as  the  AmigaDOS
  201.             command  List,  the  real  power and flexibility of DirKing is
  202.             found in  the  additional  features.  For  the  more  advanced
  203.             features, you'll need to experiment a  bit,  but  you'll  soon
  204.             get the hang of it.
  205.  
  206.           o Like the AmigaDOS command  List,  DirKing  can  only  be  used
  207.             from a Shell  (CLI)  or  script.  DirKing  can  also  be  made
  208.             resident by  using  the  AmigaDOS  command  'Resident',  since
  209.             DirKing is reentrant.
  210.  
  211.           o From  the  DirKing  usage  prompt  you'll  notice   that   all
  212.             argument  keywords are printed in  upper  case.  This  doesn't
  213.             mean you have to type them as well in upper case,  lower  case
  214.             will do since DirKing doesn't parse the arguments  on  a  case
  215.             sensitive basis. The rule is that everything  may  be  printed
  216.             in lower case, unless explicitly stated otherwise. 
  217.  
  218.             Except for one argument, all arguments can  be  typed  on  the
  219.             command  line  in  any  order you want. This  means  that  for
  220.             example you could type in  the  directory  path  at  the  end.
  221.             DirKing  will  still   recognize   it. Some  options  however,
  222.             consist  of  two   separate   arguments, which  are  a keyword
  223.             argument and a  data-argument.  Naturally these arguments have
  224.             to typed in that order. 
  225.  
  226.             The exception as mentioned earlier, is  the  LFORMAT argument.
  227.             This argument has always to be typed  last,  since  everything
  228.             after the keyword is regarded as being the format string.
  229.  
  230.             Due to the fact  that  the  arguments  can  be  typed  in  any
  231.             order, you must be careful not to override  a  previous  typed
  232.             option. For instance,  if  you  first  type  'INCL'  and  then
  233.             'EXCL',  the latter can alter the settings of the INCL  option
  234.             if you don't watch it. 
  235.             
  236.           o Some DirKing  options  need  a  data-argument in the form of a
  237.             string. In  case  this  string  should  contain  spaces,  then
  238.             you've to enclose it between double quotation marks.
  239.  
  240.           o DirKing  also  supports  pattern matching. In this version not
  241.             all AmigaDOS  wildcards  are  supported,  but  I  don't  think
  242.             you'll  need  those  exotic  wildcards  anyway.  (Although   a
  243.             future planned AmigaDOS  2  version  only,  will  support  all
  244.             wildcards.)
  245.  
  246.             The following wildcards are supported by DirKing :
  247.  
  248.                 ? : matches just one character;
  249.                 # : the next character may occur zero or more times;
  250.                 ' : take the next character literally;
  251.                 * : although not supported by  AmigaDOS,  DirKing  accepts
  252.                     this equivalent  for  '#?'.  (This  wildcard  is  also
  253.                     used in all examples.)
  254.  
  255.  
  256.                              DirKing v2.1xe (English) User Manual - Page 4
  257.  
  258.                 | : separator for using multiple patterns. 
  259.  
  260.           o Throughout this  manual,  you'll  find  numerous  examples  to
  261.             demonstrate the use  of  DirKing's  features.  Those  examples
  262.             are always printed after  '|'s.  What  has  to  typed  on  the
  263.             command line,  is  enclosed  between  single  quotation  marks
  264.             ('). I didn't use double quotation marks ("), since  they  may
  265.             sometimes be part of a data-argument.
  266.  
  267.        §2 DirKing keyword and argument syntax.
  268.           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  269.           When you use the question mark (?) on the command line,  DirKing
  270.           will print the usage  prompt  (which  will  remind  you  of  the
  271.           correct argument syntax) :
  272.  
  273.          [PATH] [[F|D|]<path|patt>]  [QUICK]  [ALL]  [TOLEVEL  <#>] [DIRS]
  274.          [FILES]        [READ [F|D|]<pattern>]      [PASS [F|D|]<pattern>]
  275.          [SUB [F|D|]<string>]           [SINCE "[F|D|]<[DOSdate] [time]>"]
  276.          [UPTO "[F|D|]<[DOSdate] [time]>"]       [FROM [F|D|]<ch> TO <ch>]
  277.          [INCL   {fkbladtc}]   [EXCL   {fkbladtc}]   [DESC]    [FD|DF|MIX]
  278.          [SORT {nksadtc}]   [NOSORT]     [FULLPATH]     [HEAD {fdvpimtse}]
  279.          [DISKINFO]    [DISKID <str>]   [BARELIST]   [NOHEAD]    [MAXHEAD]
  280.          [NOSTAT]        [ENDMSG]   [EXPAND]   [MAXWIDTH <#>]  [SHOWLEVEL]
  281.          [NEWPAGE [[{th}]<#>]]   [DIRSTYLE [r|i|b|y|f|a|e][r|i|b|y|f|a|e]]
  282.          [PRTSTYLE {rdlbpes}]    [PRT]    [TO <file>]  [DATES]  [BINFLAGS]
  283.          [HEXVAL]     [LISTF <0..4>]     [DATEF <0..7>]     [TIMEF <0..3>]
  284.          [LISTORD <fmt>]   [DFORMAT <fmtstr>] [TFORMAT <fmtstr>] [DISKUSE]
  285.          [TRACE] [MULTI] [VERSION] [LFORMAT <fmtstr>]
  286.  
  287.        §3 Directory scanning.
  288.           ~~~~~~~~~~~~~~~~~~~
  289.           The following arguments direct the way the  directory  is  read.
  290.           By default DirKing will only read the files and  directories  of
  291.           the current directory or the specified path. Thus DirKing  won't
  292.           descend in the sub-directories.
  293.  
  294.        A. Specifying the directory path.
  295.  
  296.           A.1. Normal directory paths. 
  297.  
  298.         o [[F|D|]<path|patt>]
  299.  
  300.           a. General use.
  301.  
  302.           If you don't specify a path to a directory (or  file)  to  scan,
  303.           then DirKing will scan your Shell's current directory. 
  304.  
  305.              | current directory : 'Workbench:c' 
  306.              | 'DirKing' : will read the 'Workbench:c' directory
  307.  
  308.           If you do specify a path, then DirKing will obviously  check  if
  309.           this path exists, and if so, list its contents. This  path  must
  310.           be a valid AmigaDOS path, otherwise you'll cause a DOS error.
  311.  
  312.              | 'DirKing workbench:s' : will read 'Workbench:S'
  313.  
  314.           It's also possible to use pattern matching. You can do this  for
  315.           both a specified path or the current  directory.  Normally  this
  316.           pattern will be effective on both  files  and  directories,  but
  317.           you can alter this by using the '[F]' or the  '[D]'  option.  To
  318.  
  319.  
  320.                              DirKing v2.1xe (English) User Manual - Page 5
  321.  
  322.           To select one of these options, you have to put  an  'F'  or  an
  323.           'D' at the beginning of the path. IMPORTANT:  this  option  code
  324.           has always to be typed in UPPER  CASE  and  must  be  the  first
  325.           character of the path! Otherwise DirKing will interprete  it  as
  326.           being part of the path.
  327.  
  328.           The specified  patterns  will  be  effective  during  the  whole
  329.           scanning process. Thus not just for the scanned  directory,  but
  330.           for all further read  sub-directories.  If  you  only  want  the
  331.           pattern to be effective in one directory level,  then  you  must
  332.           use "deep level pattern matching", which is explained later.   
  333.             
  334.              | 'DirKing   workbench:*s*' : only  read  those   files   and
  335.              | directories which contain an 's' in their name
  336.  
  337.              | 'DirKing   Fworkbench:*a*|*b*' : only  read   those   files
  338.              | which  contain  an  'a'  or  'b'  in   their   name.   (All
  339.              | directories will be accepted.
  340.  
  341.           b. Advanced use : recursive directory-paths.
  342.  
  343.           Recursive paths to a directory or a file always start  from  the
  344.           current directory. To climb up the directory tree (recurse)  you
  345.           have to make use of the '/' and ':' characters. 
  346.  
  347.           Using ':' goes back to the root  of  the  volume  on  which  the
  348.           current directory is situated.
  349.  
  350.             | current directory : 'Workbench:devs/keymaps'
  351.             | 'DirKing :' : DirKing use 'Workbench:' as the path.    
  352.  
  353.           The '/' character refers to a parent directory of  your  current
  354.           directory. The more '/'s you  use,  the  higher  you  climb  the
  355.           directory tree. How many '/'s you may use, depends  on  how  far
  356.           you're away from the root directory.  If  you  enter  more  '/'s
  357.           than there are parent directories, then DirKing  will  fail  and
  358.           output an invalid path error!
  359.  
  360.              | current directory : 'Workbench:devs/keymaps'
  361.              | 'DirKing /'   : read the 'Workbench:devs' directory
  362.              | 'DirKing //'  : read the 'Workbench:' directory
  363.              | 'DirKing ///' : error, no parent of 'Workbench:' exists
  364.  
  365.         o [PATH]
  366.  
  367.           The only  function  of  PATH  is  to  inform  DirKing  that  the
  368.           argument following is the path, and  not  an  argument  keyword.
  369.           PATH is only useful in case you want to scan a sub-directory  of
  370.           your current directory which has the same name  as  an  argument
  371.           keyword. If PATH wouldn't be used  in  such  a  situation,  then
  372.           DirKing would interprete your path as an argument  keyword,  and
  373.           not as the path (the AmigaDOS commands 'List'  and  'Dirs'  make
  374.           this mistake).
  375.            
  376.           A.2. Deep level pattern matching.
  377.  
  378.           The term 'deep level pattern matching' is the  only  way  I  can
  379.           describe the following feature. As mentioned  above,  this  kind
  380.           of pattern matching is more suited when DirKing has  to  descend
  381.           the directory tree. Since you can specify patterns for  upto  32
  382.  
  383.  
  384.                              DirKing v2.1xe (English) User Manual - Page 6
  385.  
  386.           directory levels. The patterns are typed in the place where  you
  387.           would normally type the name of a directory in  the  path.  When
  388.           nothing is typed in this place then this means that  there's  no
  389.           pattern for that directory level. 
  390.  
  391.           Note: the  patterns  are  also  effective  on  both  files   and
  392.                 directories, unless  you  make  use  of  the  'F'  or  'D'
  393.                 options.
  394.  
  395.             | 'DirKing workbench:*s*/p*|*x*' will be interpreted as :
  396.             | path = 'workbench:', 
  397.             | pattern for level 0 = '*s*', for level 1 = 'p*' & '*x*'
  398.  
  399.             | 'DirKing workbench:s/p*' will be interpreted as :
  400.             | path = 'workbench:s', pattern for level 0 = 'p*'
  401.  
  402.             | 'DirKing workbench:/p*|*x*//*c*|*y' is interpreted as :
  403.             | path = 'workbench:', 
  404.             | pattern for level 0 = '' (no pattern),
  405.             |    "    for level 1 = 'p*' & '*x*',
  406.             |    "    for level 2 = '', (no pattern)
  407.             |    "    for level 3 = '*c*' & '*y',
  408.  
  409.           'Deep level pattern matching' can  also  be  used in conjunction
  410.           with  a  recursive  path. It then is very important  to  have  a
  411.           clear notion of what you enter, since DirKing has to use a  part
  412.           of your path string as the path to scan, and the rest of  it  as
  413.           the patterns.  The  recursive  indicators  ':'  and  '/'  should
  414.           always  be  at  the  front  of  the  path  string,  without  any
  415.           characters in between. From  the  moment  another  character  is
  416.           typed in, then from thereon the string will be used  as  a  path
  417.           (with or without deep level pattern matching).
  418.  
  419.              | 'DirKing :/*c*' means path = ':' or volume (root)
  420.              |                 level 0 pattern = '' (no pattern),
  421.              |                 level 1 pattern = '*c*'
  422.  
  423.              | current directory = 'Workbench:devs/keymaps'
  424.              | 'DirKing //*s*//*y*' means path = 'Workbench:'
  425.              |                      level 0 pattern = '*s*', 
  426.              |                      level 1 pattern = '' (no pattern), 
  427.              |                      level 2 pattern = '*y*' 
  428.  
  429.              | current directory = 'Workbench:devs/keymaps'
  430.              | 'DirKing //devs//*s*//*y*' means path = 'Workbench:devs'
  431.              |                      level 0 pattern = '' (no pattern), 
  432.              |                      level 1 pattern = '*s*', 
  433.              |                      level 2 pattern = '' (no pattern), 
  434.              |                      level 3 pattern = '*y*' 
  435.  
  436.           I know it gets very complicated,  but  the  only  way  to  fully
  437.           master this feature is to experiment a bit. The best way  to  do
  438.           this is by sending the listing of a large directory tree to  the
  439.           printer, and then starting to experiment on that directory  with
  440.           its listing in front of you.
  441.  
  442.        B. Filtering directory information.
  443.  
  444.           Although you can filter what has to be read  by  using  patterns
  445.           in the path, most of the time you want more than that. For  this
  446.  
  447.  
  448.                              DirKing v2.1xe (English) User Manual - Page 7
  449.  
  450.           this purpose DirKing supports three kinds of  powerful  filters,
  451.           which are explained below. 
  452.  
  453.           B.1. Global filters.
  454.  
  455.           As their name suggest, these filters have an overall control  on
  456.           the scanning  process.  With  most  you'll  be  familiar,  since
  457.           they're also present in the AmigaDOS directory list commands.
  458.  
  459.         o [ALL]
  460.  
  461.           By default Dirking will only read one directory level (which  is
  462.           the Shell's current directory or a specified path). If  you  use
  463.           ALL then  DirKing  will  descend  into  all  sub-directories  it
  464.           finds, until no more are found. 
  465.  
  466.             | 'DirKing  Workbench:  ALL' : the whole Workbench  disk  will
  467.             | be scanned.
  468.  
  469.         o [DIRS]
  470.  
  471.           At first glance one would assume that  DirKing  will  only  read
  472.           directories.  In  a  way  this  is  true,  but  it's  better  to
  473.           interprete  this   argument   so   that   DirKing   may  include
  474.           directories. (Because if you also use 'FILES', then  files  will
  475.           also be included.).
  476.  
  477.           The 'DIRS' option in conjunction with 'ALL' is  a  good  way  to
  478.           get a clear view of the  directory  tree  (since  no  files  are
  479.           listed).
  480.  
  481.         o [FILES]
  482.  
  483.           This DirKing option acts the same as DIRS, but  now  for  files.
  484.           If this option is used, then DirKing will only read  files,  and
  485.           ignore all directories. This means that DirKing will  only  read
  486.           one directory level, and that the options  "ALL"  and  "TOLEVEL"
  487.           won't work.
  488.  
  489.           Exception: the above isn't true for  the  LFORMAT  option.  Here
  490.                      the FILES  option  means  that  only  files  will  be
  491.                      listed.  If   directories   are   encountered,   then
  492.                      DirKing will enter them if  the  "ALL"  or  "TOLEVEL"
  493.                      option is used.
  494.  
  495.         o [TOLEVEL <#>]
  496.  
  497.           This option  works  in  the  same  way  as  'ALL',  except  that
  498.           'TOLEVEL' specifies how many directory levels  may be scanned. I
  499.           speak of 'may' because it doesn't matter if  the  TOLEVEL  value
  500.           is greater than the actual number of directory levels present. 
  501.  
  502.             | Assume current directory is 'Workbench:Devs'
  503.             | 'DirKing  TOLEVEL   0' : will  only  read  entries  in  this
  504.             | directory  level,  without  descending  down  the  directory
  505.             | tree.
  506.             | 'DirKing  TOLEVEL  1' : does the same, but  will  also  read
  507.             | the 'KeyMaps' and 'Printers' directories.
  508.  
  509.  
  510.  
  511.  
  512.                              DirKing v2.1xe (English) User Manual - Page 8
  513.  
  514.           B.2. Filter options. -> [F|D|] 
  515.  
  516.           All  the  following  filters  (including  the  conditional  date
  517.           filters) support the use of 'F', 'D' and '' options. The use  of
  518.           these options has already been  discussed  with  the  path,  but
  519.           when used with filters, they add another  dimension.  First  I'd
  520.           like to remind you of the meaning of the three options :
  521.  
  522.             - ''  : if you don't enter an option code, then  DirKing  will
  523.                     use the filter on both files and directories;
  524.             - 'F' : the filter will only be used for files;
  525.             - 'D' : the filter will only be used for directories.
  526.  
  527.           Note: the option code must always be typed in  UPPER  CASE,  and
  528.                 always be the first character of the data-argument!
  529.  
  530.           The options used with filters, add  another  dimension  to  that
  531.           filter. Since you can use the filter upto  three  times  on  the
  532.           command  line,  providing  that  each  filter  argument  has   a
  533.           different option. In other words you  can  enter  a  filter  for
  534.           both files and directories, one for files only, and another  for
  535.           directories.
  536.  
  537.           B.3. File- and directoryname filtering.
  538.  
  539.           The  following  filters  operate  on  the  name  of  files   and
  540.           directories, thus presenting more powerful  filtering  than  the
  541.           previous filter type. 
  542.  
  543.         o [READ [F|D|]<pattern>]
  544.  
  545.           This argument instructs DirKing to  only  read  (include)  those
  546.           directory entries (files and/or  directories)  which  match  the
  547.           given  pattern(s).  An  unlimited  number  of  patterns  can  be
  548.           specified. The vertical  bar  "|"  is  used  to  separate  these
  549.           patterns. (If one of the patterns should  contain  spaces,  then
  550.           you must  enclose  the  whole  data-argument  between  quotation
  551.           marks.)
  552.  
  553.             | 'READ *s*' : include only those  directories  and  files  if
  554.             |              their name includes 's'.
  555.  
  556.             | 'READ *s*|*a*' : include only those  directories  and  files
  557.             |                  if their name either includes 's' or 'a'.
  558.  
  559.             | 'READ F*a* READ D*b* READ *c*' :
  560.             | Files are only included if their name matches the  '*a*'  or
  561.             | the '*c*' patterns. Directories are only included  if  their
  562.             | name matches the '*b*' or the '*c*' patterns. 
  563.  
  564.             | 'READ F*a*|*b*|*c*' :
  565.             | Files are only included if their name  matches  one  of  the
  566.             | three specifies patterns (*a*, *b*,  *c*).  All  directories
  567.             | will be included, since  this  argument  is  only  effective
  568.             | for files!
  569.  
  570.         o [PASS [F|D|]<pattern>]
  571.  
  572.           The PASS argument works in the same way as  the  READ  argument,
  573.           except that  all directory entries  (files  and/or  directories)
  574.  
  575.  
  576.                              DirKing v2.1xe (English) User Manual - Page 9
  577.  
  578.           that match the given pattern(s) are ignored (excluded).
  579.  
  580.             | 'PASS *s*|*a*' : ignore  those  directories  and  files   if
  581.             |                  their name either includes 's' or 'a'.
  582.  
  583.             | 'PASS F*a* PASS D*b* PASS *c*' :
  584.             | Files are ignored  if their name matches the  '*a*'  or  the
  585.             | '*c*'  patterns.  Directories  are  ignored  if  their  name
  586.             | matches the '*b*' or the '*c*' patterns. 
  587.  
  588.         o [SUB [F|D|]<string>]
  589.  
  590.           In order to be included in the listing, the names of  the  files
  591.           and/or directories must contain the specified string(s).
  592.  
  593.             | 'SUB s|a' : include only  those  directories  and  files  if
  594.             |             their name either contains 's' or 'a'.
  595.  
  596.             | 'SUB Fa|d SUB Db SUB c' :
  597.             | Files are only included if their name contains 'a',  'd'  or
  598.             | 'c'. Directories are only included if  their  name  contains
  599.             | 'b' or 'c'. 
  600.  
  601.         o [FROM [F|D|]<ch> TO <ch>]
  602.  
  603.           The 'FROM TO' argument enables  filtering on the first character
  604.           of the name of files and/or directories.  Since  AmigaDOS  names
  605.           aren't handled case sensitive, typing 'A' is the same as  typing
  606.           'a'.
  607.  
  608.           The <ch>aracter is only valid if it's in  the  range  [0..9]  or
  609.           [a..z].
  610.  
  611.             | 'FROM a  TO  d' : only include directories and files, if the
  612.             | first character of their  name  is  equal  or  greater  than
  613.             | 'a', but not greater than 'd'.
  614.  
  615.             | 'FROM 5  TO  a' : only include directories and files, if the
  616.             | first character of their  name  is  equal  or  greater  than
  617.             | '5', but not greater than 'a'.
  618.  
  619.             | 'FROM Fa  TO  d' : only include files if the first character
  620.             | of their name is equal or greater than 'a' but  not  greater
  621.             | than 'd'. All  directories  will  be  included,  since  this
  622.             | filter doesn't apply to them.
  623.  
  624.           If the TO <ch>aracter is  smaller  than  the  FROM  <ch>aracter,
  625.           then this TO <ch>aracter will be  replaced  by  the  last  valid
  626.           character in the range.
  627.  
  628.             | 'FROM s TO a' : will be interpreted as 'FROM s TO z'.
  629.  
  630.           B.4. Conditional date filters.
  631.  
  632.           Conditional  dates  provide  filters for the date- and timestamp
  633.           of a file or directory. The syntax of the conditional  date  can
  634.           be one of the following :
  635.  
  636.            1° DOSdate : only a datestamp is given, in the  usual  AmigaDOS
  637.                         format, which is DD-MMM-YY  (e.g.  14-aug-92).  If
  638.  
  639.  
  640.                             DirKing v2.1xe (English) User Manual - Page 10
  641.  
  642.                         the date is within the last week  of  the  current
  643.                         date, then you  may  use  the  actual  dayname  of
  644.                         that date (Sunday...Saturday); you  may  also  use
  645.                         'Today'  and  'Yesterday'.  The  dates  after  the
  646.                         current date can be  replaced  by  'Tomorrow'  and
  647.                         'Future' (represents the day  after  tomorrow  and
  648.                         later).
  649.  
  650.            2° time : only a timestamp is  given,  in  the  usual  AmigaDOS
  651.                      format,  which  is  HH:MM:SS  (e.g.  18:15:42).  (The
  652.                      seconds  can  be  omitted,  in  which  case  '00'  is
  653.                      used).
  654.  
  655.            3° DOSdate & time : a date- and  timestamp  is  given,  in  the
  656.                                above   specified   formats.   (Note   that
  657.                                you  can   also   enter   the   date-   and
  658.                                timestamp in reverse order.)
  659.  
  660.           REMARK: the date- and timestamp  must  be  typed  in  the  above
  661.                   mentioned formats,  otherwise  DirKing  won't  recognize
  662.                   your date/timestamp!
  663.  
  664.         o [SINCE "[F|D|]<[DOSdate] [time]>"]
  665.  
  666.           Using SINCE means  that  only  those  directory  entries  (files
  667.           and/or directories) will  be  included  if  their  date-  and/or
  668.           timestamp is equal or later than the given conditional date. 
  669.  
  670.             | 'SINCE 14-aug-92' : include  only  files   and   directories
  671.             | which were created on or after 14 August 1992.
  672.  
  673.             | 'SINCE 14:30:00' : include  only   files   and   directories
  674.             | which were created on or after 14:30:00.
  675.  
  676.             | 'SINCE "14-aug-92 14:30:00"' : include   only   files    and
  677.             | directories  which  were  created  on  or  after  14-Aug-92,
  678.             | 14:30:00.
  679.  
  680.             | Assume that today is 16-Aug-92
  681.             | 'SINCE   yesterday' : include  only  files  and  directories
  682.             | which were created on or after 15-Aug-92.
  683.  
  684.             | 'SINCE   Ftoday' : include  only  files  that  were  created
  685.             | today or later. All  directories  found  will  be  included,
  686.             | since this filter is only effective for files.
  687.           
  688.         o [UPTO "[F|D|]<[DOSdate] [time]>"]
  689.  
  690.           Everything  said  for  SINCE  applies  for   UPTO,   with   this
  691.           difference that now only files/directories will be  included  if
  692.           their  date/timestamp  is  equal or earlier than the conditional
  693.           date/timestamp.
  694.  
  695.        C. Tracing the scanning process. 
  696.  
  697.         o [TRACE]
  698.  
  699.           This  is  a  rather  exotic feature of DirKing. TRACE is used to
  700.           monitor the scanning process. This option  is  extremely  useful
  701.           when scanning large directories, and you  want  to  know  what's
  702.  
  703.  
  704.                             DirKing v2.1xe (English) User Manual - Page 11
  705.  
  706.           going on. The information printed consists of the following :
  707.  
  708.             - the currently scanned path;
  709.             - the number of directories included  so  far,  and  the  last
  710.               one found;
  711.             - the number of files  included  so  far,  and  the  last  one
  712.               found;
  713.  
  714.           Note:  this  feature  will  slightly  slow  down  the   scanning
  715.                  process, but once you used  it,  you'll  be  addicted  to
  716.                  it.
  717.  
  718.        §4 Directory information.
  719.           ~~~~~~~~~~~~~~~~~~~~~~
  720.           By  default, DirKing will print the listing in roughly the  same
  721.           format as the AmigaDOS 'List' command, but with more  style  and
  722.           information. First of all DirKing will print  the  scanned  path
  723.           and the date/timestamp of the listing. Then the  actual  listing
  724.           is printed in a table form, with a title  line  indicating  what
  725.           all the printed fields mean  (the  List  command  doesn't  print
  726.           such a title line!). After  the  listing  has  been  printed,  a
  727.           statistic line will be  printed,  which  states  the  number  of
  728.           files and directories found, the  amount  of  bytes  and  blocks
  729.           used by the files and the number of bytes free on the volume.
  730.  
  731.           This default listing format can be altered  by  the  options  as
  732.           described below. But for good understanding, it's  necessary  to
  733.           explain some terms used :
  734.  
  735.             o DirectoryEntry : refers to files and directories;
  736.             o Field : each  separate  information  of  a  directory  entry
  737.                       (e.g. name, blocks used, datestamp,...);
  738.             o Listing : what  DirKing  prints  on  the  scanned  directory
  739.                         (consists  of  the  listing  header,  the   actual
  740.                         listing and the listing end);
  741.             o ListingHeader : a block of  information  about  the  scanned
  742.                               directory (and volume);
  743.             o ActualListing : that section of the  listing,  only  holding
  744.                               the   directory   entries,   including   the
  745.                               title line  (which  states  the  meaning  of
  746.                               the different fields);
  747.             o ListingEnd : the block of information  printed  at  the  end
  748.                            of  the  listing   (thus   after   the   actual
  749.                            listing).
  750.             o DiskInfoBlock : a block  of  extensive  information  on  the
  751.                               volume  that  was  accessed  to   read   the
  752.                               directory;
  753.  
  754.        A. Volume (disk) information.
  755.  
  756.         o [DISKINFO]
  757.  
  758.           The DISKINFO option can be compared with  the  AmigaDOS  command
  759.           'Info',  except  that  it  gives  more  information  than   this
  760.           command. The information is printed in  a  block  consisting  of
  761.           three lines of information : 
  762.  
  763.           Line_1 : - 'Volume'     : volume name;
  764.                    - 'Created'    : date/time stamp of creation;
  765.           Line_2 : - 'RootKey'    : block number of the root directory;
  766.  
  767.  
  768.                             DirKing v2.1xe (English) User Manual - Page 12
  769.  
  770.                    - 'DiskSize'   : number of blocks on the disk;
  771.                    - 'BlockSize'  : number of bytes in a block;
  772.                    - 'BlocksFree' : number of blocks free on the disk;
  773.                    - 'BytesFree'  : number of bytes free on the disk;
  774.                    - 'Errors'     : number of soft-errors on the disk;
  775.                    - 'DiskStatus' : status  of   the   disk   (Read/Write,
  776.                                     ReadOnly, Validating);
  777.                    - 'DOSType'    : DOS type of the  disk  (OFS:OldFiling-
  778.                                     System,  FFS:FastFilingSystem,   KICK:
  779.                                     KickstartDisk,MSDOS:MS-DOSdisk,IOFS:
  780.                                     InterOFSdisk, IFFS:InterFFSdisk);
  781.           Line_3 : - 'Most Recent DateStamp' : not filled;
  782.                    - 'TotalFiles' : not filled;
  783.                    - 'TotalDirs'  : not filled;
  784.                    - 'BlocksUsed' : number of blocks used on the disk;
  785.                    - 'BytesUsed'  : number of bytes used on the disk;
  786.                    - 'Full'       : disk full percentage.
  787.  
  788.           Note: the lines 2 and 3 form the  'DiskInfoBlock'.  Three  items
  789.                 of line 3 aren't  filled,  because  DirKing  doesn't  scan
  790.                 the  disk when 'DISKINFO' is  selected.  If  you  do  want
  791.                 these  items filled, then you must use 'HEAD vpi  EXCL  f'
  792.                 instead  of  'DISKINFO'  (for  more   details   on   these
  793.                 arguments, see later). 
  794.  
  795.           IMPORTANT: when 'DISKINFO'  is  used,  then  all  other  DirKing
  796.                      options  will  be  ignored,  except  for   the   path
  797.                      argument (DirKing must know  from  which  volume  you
  798.                      want  information).  Since  DirKing  doesn't  read  a
  799.                      directory,   the   volume   information   is    given
  800.                      instantly.
  801.            
  802.             | 'DirKing DISKINFO' : gives information about the  volume  on
  803.             |                      which   the   current   directory    is
  804.             |                      situated.
  805.  
  806.             | 'DirKing DF1: DISKINFO' : gives  information  on  the   disk
  807.             |                           which   is   inserted   in   drive
  808.             |                           'DF1:'.
  809.  
  810.         o [DISKUSE]
  811.  
  812.           By default the  'blocksUsed'  and  'bytesUsed'  infofields  show
  813.           how many blocks and bytes are used by the  files  found  in  the
  814.           scanned directory. This however  isn't  the  exact value of used
  815.           diskspace. This  is  where  the  new  option  DISKUSE  makes  an
  816.           entry. 
  817.  
  818.           When this option is used,  then  the 'blocksUsed' infofield will
  819.           show  the  exact  number  of  blocks  used  by  the  files   and
  820.           directories in the  scanned  directory.  In  other  words,  this
  821.           value  also includes the blocks used by DOS  (header  blocks) to
  822.           maintain the  directory  tree.  The 'bytesUsed' is then equal to
  823.           the number of  blocks  used,  multiplied  by  the blocksize. Now
  824.           DirKing gives the same value as the 'List' command.
  825.           
  826.           NOTE: the  above  mentioned  infofields  can  be  found  in  the
  827.                 listing header with the DiskInfoBlock or  in  the  listing
  828.                 end with the statistic line.
  829.  
  830.  
  831.  
  832.                             DirKing v2.1xe (English) User Manual - Page 13
  833.  
  834.        B. Listing header/end information.
  835.  
  836.           By  default DirKing  will  use  a  listing  header  stating  the
  837.           following information : scanned  directory  (using  the  correct
  838.           upper/lower  case  notation)  and  the  date/timestamp  of   the
  839.           listing. The listing end consists of a  statistic  line,  giving
  840.           the number of files and directories found,  and  the  number  of
  841.           bytes and blocks used by them.
  842.  
  843.           With the following options, you can alter what is printed  as  a
  844.           listing header an as a listing end.
  845.  
  846.         o [FULLPATH]
  847.  
  848.           When  you  normally enter a path to a directory or file,  you'll
  849.           use lower case characters (since AmigaDOS isn't  case  sensitive
  850.           on this subject). However, DirKing will search for  the  correct
  851.           upper/lower case notation of that path, before  printing  it  in
  852.           the listing. 
  853.  
  854.           By  default, DirKing will only  correct  the  path  that  you've
  855.           specified. It won't look for the correct path from the root  on.
  856.           Sometimes you'll want to know the  correct  path  starting  from
  857.           the volume-root. You can do this by using  FULLPATH. This option
  858.           instructs DirKing to construct the  path  from  the  volume-root
  859.           upto the directory or file specified.
  860.  
  861.             | Assume we're scanning your Workbench (system) disk.
  862.             | 'DirKing devs:' : DirKing  will   print   'DEVS:'   as   the
  863.             |                   scanned path.
  864.             | 'DirKing devs: FULLPATH' : 'Workbench:Devs'  is  printed  as
  865.             |                             the scanned path.
  866.  
  867.             | Assume current directory is 'Workbench:Devs'.
  868.             |  'DirKing' : (read current directory) '' is printed  as  the
  869.             |             scanned path.
  870.             | 'DirKing  FULLPATH' : 'Workbench:Devs'  is  printed  as  the
  871.             |                       scanned path.
  872.  
  873.             | Assume current directory is 'Workbench:Devs'
  874.             | 'DirKing  keymaps' : will read the  'Workbench:Devs/Keymaps'
  875.             |                     directory,  where  DirKing  will   print
  876.             |                     'Keymaps' as the scanned path.
  877.             | 'DirKing keymaps FULLPATH' : reads the same  directory,  but
  878.             |                              'Workbench:Devs/Keymaps'   will
  879.             |                              be printed as the path read.
  880.  
  881.             | Assume your Workbench disk in drive 'DF1:'.
  882.             | 'DirKing df1:' : 'DF1:' is printed as the scanned path.
  883.             | 'DirKing df1: FULLPATH' : 'Workbench:'  is  printed  as  the
  884.             |                           scanned path.
  885.           
  886.         o [HEAD {fdvpimtse}]
  887.  
  888.           The default listing header and listing  end  have  already  been
  889.           explained at the beginning of '§4B'. The HEAD option now  allows
  890.           you to specify what information you want in the  listing  header
  891.           and the listing end.
  892.  
  893.           Note: although  the  argument  keyword  is  called  'HEAD',   it
  894.  
  895.  
  896.                             DirKing v2.1xe (English) User Manual - Page 14
  897.  
  898.                 defines both the listing header and listing end!
  899.  
  900.           To define which listing header and listing  end  you  want,  you
  901.           have to use the following codes (the  codes  are  given  in  the
  902.           order they'll appear in the header) :
  903.  
  904.           > Listing head codes
  905.  
  906.             - F : display the maximum  listing  head;  this  code  is  the
  907.                   equivalent of using 'HEAD dvpit'.
  908.             - D : print date and time of scanning;
  909.             - V : print name and creation  date  of  the  accessed  volume
  910.                   (disk);
  911.             - P : if a path was scanned (any path,  except  when  it  only
  912.                   represents a volume or device name, or an  assign)  then
  913.                   print it;  
  914.             - I : print  the   DiskInfoBlock   as   explained   with   the
  915.                   'DISKINFO' option;
  916.             - M : print the default listing header line;
  917.             - T : print the title above the listing table;
  918.  
  919.           > Listing end codes
  920.  
  921.             - E : print the '~~~~~ End  of  Directory  ~~~~~'  message  at
  922.                   the end.
  923.             - S : print the statistic line  at  the  end  of  the  listing
  924.                   (default listing end);
  925.  
  926.         o [MAXHEAD]
  927.  
  928.           This argument is equal to using 'HEAD f' or 'HEAD dvpit'.
  929.  
  930.         o [NOHEAD]
  931.  
  932.           If used,  then  no  listing  head  will  be  printed  above  the
  933.           listing, except for the listing title.
  934.  
  935.         o [BARELIST]
  936.  
  937.           Only the actual listing  will  be  printed,  without  the  title
  938.           line. In other words only the directory entries are given.
  939.  
  940.         o [NOSTAT]
  941.  
  942.           Prevents  that  the  statistic line is printed at the end of the
  943.           listing. This option will primarily  be  used  to  suppress  the
  944.           default listing end (which is this statistic line).
  945.  
  946.         o [ENDMSG]
  947.  
  948.           Lets DirKing print the '~~~~  End  of  Directory  ~~~~'  message
  949.           after the actual listing. 
  950.  
  951.        C. File- and directory fields.
  952.  
  953.           The following arguments  define  which  fields  of  a  directory
  954.           entry are printed. By default DirKing will print  the  following
  955.           fields in the given order (the names between  ''  are  the  ones
  956.           printed in the listing title line) : 
  957.  
  958.  
  959.  
  960.                             DirKing v2.1xe (English) User Manual - Page 15
  961.  
  962.             - 'FileName' : name of a file or directory;
  963.             - 'Keys'     : the disk key (block  number  of  file/directory
  964.                            header);
  965.             - 'Blocks'   : blocks used by a file  (for  directories  'Dir'
  966.                            is printed instead);
  967.             - 'Bytes'    : bytes used by a  file  (for  directories  'Dir'
  968.                            is printed instead);
  969.             - 'Flags'    : the   file/directory   attributes   (protection
  970.                            flags);
  971.             - 'Date'     : datestamp of file/directory;
  972.             - 'Time'     : timestamp of file/directory.
  973.  
  974.           Note:  filenotes  (comments)  aren't  printed  in  the   default
  975.                  setting. You have to use 'INCL' to include them.
  976.  
  977.         o [QUICK]
  978.  
  979.           If 'QUICK' is used the only the  file/directory  name  field  is
  980.           printed.
  981.  
  982.         o [INCL {fnkbladtc}]
  983.  
  984.           The INCL option is used to specify which fields you want  to  be
  985.           printed in the actual listing. The  following  field  codes  are
  986.           defined :
  987.  
  988.             - F : the  equivalent  of  'INCL  nkbladtc'  (in  other  words
  989.                   prints all fields);
  990.             - N : include file/directory name;
  991.             - K : include file/directory diskkey;
  992.             - B : include filesize in blocks (prints 'Dir' for dirs.);
  993.             - L : include filesize in bytes (prints 'Dir' for dirs.);
  994.             - A : include file/directory attributes (protectionflags);
  995.             - D : include file/directory datestamp;
  996.             - T : include file/directory timestamp;
  997.             - C : include file/directory filenote  (comment);  the   file-
  998.                   note is only printed when one is present.
  999.  
  1000.             | 'INCL nd' : only print the name and datestamp fields.
  1001.  
  1002.             | 'INCL n' : only print name field (equivalent of 'QUICK').
  1003.  
  1004.             | 'INCL nkbladt' : is  the  same  as   the   default   setting
  1005.             |                  (explained earlier).
  1006.  
  1007.         o [EXCL {fnkbladtc}]
  1008.  
  1009.           The 'EXCL' option is used to  specify  which  fields  you  don't
  1010.           want to be printed. 'EXCL' is only useful for  excluding  fields
  1011.           from  the  default  settings,  because  if  you've  used  'INCL'
  1012.           earlier, then you've already specified which fields you want. 
  1013.  
  1014.             | 'EXCL  f' : you'll get an empty listing, only  the  listing
  1015.             |            header and listing end will be printed.
  1016.  
  1017.             | 'EXCL kbladt' : is the same as using  the  QUICK  argument,
  1018.             |                 in other words, only the name of the  files
  1019.             |                 and directories is printed.
  1020.  
  1021.  
  1022.  
  1023.  
  1024.                             DirKing v2.1xe (English) User Manual - Page 16
  1025.  
  1026.        §5 Directory sorting.
  1027.           ~~~~~~~~~~~~~~~~~~
  1028.           By default DirKing will sort the names of files and  directories
  1029.           in ascending alphabetical order.  In  the  listing  itself,  all
  1030.           files will be printed first, and last the directories. 
  1031.  
  1032.         o [SORT {nksadtc}]
  1033.  
  1034.           DirKing is able to execute  a  complex sort on all the fields of
  1035.           a directory entry. On which  field  to  sort,  is  specified  by
  1036.           their appropriate code.  Important  however  is  to  type  these
  1037.           codes in the order you want DirKing to sort the fields.
  1038.  
  1039.           The following codes (and fields) are supported :
  1040.  
  1041.             - N : sort on file/directory names;
  1042.             - K : sort on file/directory diskkey;
  1043.             - S : sort on filesize (dirs have no size);
  1044.             - A : sort on file/directory attributes (sorts on  the  binary
  1045.                   value of these attributes);
  1046.             - D : sort on file/directory datestamp;
  1047.             - T : sort on file/directory timestamp;
  1048.             - C : sort on file/directory filenote if it's present.
  1049.  
  1050.           REMARK: since  AmigaDOS  names  of  files  and  directories  are
  1051.                   unique in the  same  directory  level,  any  sort  codes
  1052.                   after the 'N' code aren't executed (because  this  would
  1053.                   be a waste of valuable processing time!).
  1054.  
  1055.           Note:  specifying the fields  to  sort  on,  doesn't  mean  that
  1056.                  these items will be  printed  in  the  listing.  What  is
  1057.                  actually printed depends  on  the  options  explained  in
  1058.                  '§4C'.
  1059.  
  1060.             | 'SORT ds' : first sort on the date, then on the size.
  1061.  
  1062.             | 'SORT tna' : first sort on the time, then on  the  name.  No
  1063.             |              sort  is  executed  on  the  attributes,  since
  1064.             |              filenames are unique. 
  1065.           
  1066.         o [NOSORT]
  1067.  
  1068.           If used then the listing won't be sorted. Thus giving  a  slight
  1069.           scanning speed increase.
  1070.  
  1071.         o [DESC]
  1072.  
  1073.           By default the directory is sorted ascending (thus from  low  to
  1074.           high). If  you  want  a  descending sort (from high to low), you
  1075.           have to use DESC.
  1076.  
  1077.         o [FD|DF|MIX]
  1078.  
  1079.           The files and directories can  be  printed  at  three  different
  1080.           places in the listing. You can select the appropriate format  by
  1081.           using one of the following arguments :
  1082.  
  1083.            - 'FD'  : (default) print files first, directories last.
  1084.            - 'DF'  : print directories first, files last.
  1085.  
  1086.  
  1087.  
  1088.                             DirKing v2.1xe (English) User Manual - Page 17
  1089.  
  1090.            - 'MIX' : print files and directories among each other. 
  1091.           
  1092.        §6 Listing formatting.
  1093.           ~~~~~~~~~~~~~~~~~~~
  1094.           The format of the actual listing can be either  a  table  format
  1095.           or a script format. Most of the time, however,  you'll  use  the
  1096.           table format.
  1097.  
  1098.        A. Listing table formatting. 
  1099.  
  1100.           A.1. Setting the listing table width.
  1101.  
  1102.         o [MAXWIDTH <#>]
  1103.  
  1104.           DirKing will expand the listing table  in  accordance  with  the
  1105.           fields to be printed, and the length of the FileName  field.  In
  1106.           most cases, you'll want to set  a  limit to this expanding. With
  1107.           'MAXWIDTH' you can specify how many characters  may  be  printed
  1108.           on one line. If the listing is too wide, then if the name  field
  1109.           is printed, it will be cut (the name field  is  the  only  field
  1110.           that can be trimmed, all other fields have a fixed  length).  If
  1111.           the name of a file or directory should be too  long  to  fit  in
  1112.           the FileName field, then the last character will be  an  '$'  to
  1113.           indicate that more characters are following in that name. 
  1114.  
  1115.           Note: the MAXWIDTH  option  is  only  effective  on  the  actual
  1116.                 listing, not on the listing header or listing end.
  1117.  
  1118.           REMARK: the limit set with 'MAXWIDTH' won't work in  all  cases.
  1119.                   This depends on the fields to  be  printed.  The  fields
  1120.                   that have a fixed length will always be  fully  printed.
  1121.                   The only variable field is  the  'FileName'  field,  but
  1122.                   it can't be smaller than  16  characters.  DirKing  will
  1123.                   always  print  the  fixed  fields  and  the  minimal  16
  1124.                   characters,  even  if  the  total  width   exceeds   the
  1125.                   'MAXWIDTH' setting. 
  1126.  
  1127.             | 'MAXWIDTH 70' : the actual listing  width  can  only  be  70
  1128.             |                 characters wide. 
  1129.  
  1130.         o [EXPAND]
  1131.  
  1132.           By  default, DirKing will only print as wide as is necessary  to
  1133.           print all the wanted fields. So  the  listing  width  will  vary
  1134.           from directory to directory. If you want DirKing to make use  of
  1135.           the full allowed listing width, then you must use EXPAND.
  1136.  
  1137.           When  MAXWIDTH is used, then DirKing will print a  listing  with
  1138.           an actual width as specified. When you don't use MAXWIDTH,  then
  1139.           DirKing will use the default width of 77 characters.
  1140.  
  1141.           A.2. Formatting the listing table.
  1142.  
  1143.           With the following options you can customize the format  of  the
  1144.           listing table, and the format of the date-  and  timestamp.  All
  1145.           these format options, support the use of  AmigaDOS print control
  1146.           sequences. To introduce such a  sequence  in  the  formatstring,
  1147.           you have  to  use  a  '\'  character  followed  by  one  of  the
  1148.           following codes :
  1149.  
  1150.  
  1151.  
  1152.                             DirKing v2.1xe (English) User Manual - Page 18
  1153.  
  1154.             - e : insert an  ESCape  character  (refer  to  your  AmigaDOS
  1155.                   manual  for  a  list  of  the  supported  print  control
  1156.                   sequences);
  1157.             - t : insert a TAB character;
  1158.             - n : insert a line feed;
  1159.             - ' : print a double quotation mark (");
  1160.             - \ : used to print '\'.
  1161.  
  1162.         o [LISTORD <fmt>]
  1163.  
  1164.           Normally the listing is printed in the form of  a  table,  where
  1165.           each  column  represents  a  field.  By  default the fields  are
  1166.           printed in the following order  :  name,  keys,  blocks,  bytes,
  1167.           attributes  (protectionflags),  date  and  time  (if  there's  a
  1168.           comment, then it's printed on the next line).
  1169.  
  1170.           With the following  codes  you  can  define  the  order  of  the
  1171.           fields :
  1172.  
  1173.             - N : 'FileName';
  1174.             - K : 'Keys';
  1175.             - B : 'Blocks,;
  1176.             - L : 'Bytes,;
  1177.             - A : 'Flags';
  1178.             - S : 'Date';
  1179.             - T : 'Time'.
  1180.  
  1181.             | 'LISTORD dalnktb' : defines  the  order   :   date,   flags,
  1182.             |                     bytes, name, keys, time and blocks.
  1183.  
  1184.           Note: the use of LISTORD doesn't mean  that  these  fields  will
  1185.                 actually be  printed.  This  depends  on  the  options  as
  1186.                 described under '§4C'.
  1187.  
  1188.           Important:  as mentioned above the default order  is  'nkbladt'.
  1189.                      When defining the fields order,  you  don't  have  to
  1190.                      enter  all  codes  for  the  fields  that   will   be
  1191.                      printed. When  you  only  define  the  order  of  the
  1192.                      first fields, DirKing  will  use  the  default  order
  1193.                      for the rest of the fields.
  1194.  
  1195.             | 'LISTORD an' : only two fields are  defined,  the  rest  are
  1196.             |                printed  in  the  default  order.  The  order
  1197.             |                will  then  be  : flags, name, keys,  blocks,
  1198.             |                bytes, date and time. 
  1199.  
  1200.           As mentioned earlier, the LISTORD will also support the  use  of
  1201.           AmigaDOS print control sequences. You can also use normal  text,
  1202.           although this isn't much recommandable since it can disrupt  the
  1203.           listing  table.  So  it's  best  to  only  use   print   control
  1204.           sequences.
  1205.  
  1206.             | 'LISTORD  \e[1mN\e[0m' : all names will be printed  in  bold
  1207.             | style characters.  The  other  fields  are  printed  in  the
  1208.             | usual default order, and in plain text.
  1209.  
  1210.             | 'LISTORD nkbladt' : same as the default order.
  1211.  
  1212.  
  1213.  
  1214.  
  1215.  
  1216.                             DirKing v2.1xe (English) User Manual - Page 19
  1217.  
  1218.         o [DFORMAT <fmtstr>]
  1219.  
  1220.           DirKing uses the AmigaDOS dateformat  (which  is  DD-MMM-YY)  as
  1221.           its default format. With  'DFORMAT'  you  can  define  your  own
  1222.           dateformat. This formatstring can  contain  normal  text,  print
  1223.           control  sequences  and  of   course   the   date   substitution
  1224.           operators. The substitution operators indicate which  date  item
  1225.           has  to  be  printed.  Such  an  operator  consists  of  an  '%'
  1226.           character and one of the following date item codes :
  1227.  
  1228.            - w : insert a two character dayname (e.g.Sa,Su,Mo,...);
  1229.            - W : insert the full dayname (e.g.Sunday,Monday,...);
  1230.            - d : insert the day in the month;
  1231.            - m : insert the month number (1..12);
  1232.            - M : insert a three character month name (e.g.Jul,Aug,...);
  1233.            - y : insert the last two digits of the year (e.g.91,92,...);
  1234.            - Y : insert a four digit year (e.g.1991,1992,...).
  1235.  
  1236.             | 'DFORMAT %w_%d/%Y/%m' : gives a date like Su_23/1992/08.  
  1237.  
  1238.             | 'DFORMAT "\e[1m%W\e[0m  \e[3m%d  %M  %Y\e[0m"'  (Notice  the
  1239.             | quotation marks! They're  used  because  the  DFORMAT  data-
  1240.             | argument contains spaces!) 
  1241.             | The defined date format will result in a date  looking  like
  1242.             | this : 'Friday 11 Sep 1992' 
  1243.  
  1244.           Note. The TFORMAT codes are also supported with DFORMAT. 
  1245.  
  1246.         o [TFORMAT <fmtstr>]
  1247.  
  1248.           Everything said for  DFORMAT  is  true  for  TFORMAT,  the  only
  1249.           difference is the specific set of time item codes :
  1250.  
  1251.             - H : insert the hour in 24 hour mode (0..23);
  1252.             - h : insert the hour in 12 hour mode (0..11);
  1253.             - i : insert the minutes;
  1254.             - s : insert the seconds;
  1255.             - T : insert AM  or  PM  according  to  the  hour  ('T'  works
  1256.                   independent from 'H' and 'h', in other words  you  don't
  1257.                   have to use 12 hour mode to use AM/PM!).
  1258.  
  1259.             | 'TFORMAT %h:%m_%T' : gives time like '08:53_AM'.
  1260.  
  1261.             | 'TFORMAT \e[1m%h\e[0m:\e[3m%i\e[0m:\e[4m%s\e[0m' : gives   a
  1262.             | time like : '14:30:18'. 
  1263.  
  1264.           Note. The DFORMAT codes are also supported with TFORMAT. 
  1265.  
  1266.        B. Predefined listing table formats.
  1267.  
  1268.           As a shortcut,  DirKing  has  several  predefined  formats,  for
  1269.           selecting  a  listing  order,  a  date-  or  timeformat.   These
  1270.           predefined formats can be accessed by their appropriate code.
  1271.  
  1272.         o [LISTF <code 0..4>]
  1273.  
  1274.           The following listing order formats are supported :
  1275.  
  1276.             - 0 : NKBLADT (default)
  1277.             - 1 : NAKLBDT
  1278.  
  1279.  
  1280.                             DirKing v2.1xe (English) User Manual - Page 20
  1281.  
  1282.             - 2 : NADTLBK
  1283.             - 3 : NDALBKT
  1284.             - 4 : ALBKDTN
  1285.  
  1286.         o [DATEF <code 0..7>]
  1287.  
  1288.           The following dateformats are supported :
  1289.  
  1290.            - 0  : '%d-%M-%y'  -> DOS format dd-mmm-yy (e.g. '14-Aug-92')
  1291.            - 1  : '%y-%M-%d'  -> INT format yy-mmm-dd (e.g. '92-Aug-14')
  1292.            - 2  : '%m-%d-%y'  -> USA format mm-dd-yy  (e.g. '08-14-92')
  1293.            - 3  : '%d-%m-%y'  -> CDN format dd-mm-yy  (e.g. '14-08-92')
  1294.            - 4  : '%w %d-%M-%y' -> (DOS format - e.g. 'Fr 11-Sep-92')
  1295.            - 5  : '%w %y-%M-%d' -> (INT format - e.g. 'Fr 92-Sep-11')
  1296.            - 6  : '%w %m-%d-%y' -> (USA format - e.g. 'Fr 09-11-92')
  1297.            - 7  : '%w %d-%m-%Y' -> (CDN format - e.g. 'Fr 11-09-92')
  1298.  
  1299.         o [TIMEF <code 0..3>]
  1300.  
  1301.           The following timeformats are supported :
  1302.  
  1303.             - 0 : '%H:%i:%s'     (e.g. '14:30:00' )
  1304.             - 1 : '%h:%i:%s-%T'  (e.g. '02:30:00 PM') 
  1305.             - 2 : '%H:%i'        (e.g. '14:30')
  1306.             - 3 : '%h:%i-%T'     (e.g. '02:30 PM')
  1307.  
  1308.        C. Free formatting and script generation. -> [LFORMAT <fmtstr>]
  1309.  
  1310.           LFORMAT is the only way to  have  full  control  on  the  actual
  1311.           listing print  format.  I  say  'actual  listing'  because  when
  1312.           LFORMAT is used, no listing head, title or end will be  printed.
  1313.           The main use of LFORMAT  will  probable  be  the  generation  of
  1314.           scripts, but you don't have to limit it to this.
  1315.  
  1316.           IMPORTANT : LFORMAT MUST ALWAYS  BE  THE  LAST  ARGUMENT,  SINCE
  1317.           EVERYTHING AFTER THE LFORMAT  KEYWORD  IS  PART  OF  THE  FORMAT
  1318.           STRING!! (This means that quotation marks may only  be  used  if
  1319.           they're needed in the output!)
  1320.  
  1321.           The 'LFORMAT' option works in the same way as  in  the  AmigaDOS
  1322.           'List'  command,  so  you  should  have   no   difficulties   to
  1323.           understand the use of it.
  1324.  
  1325.           The format string can  contain  three  sorts  of  text.  Firstly
  1326.           normal text, secondly the substitution operators (like  '%S'  or
  1327.           '%N'), and thirdly AmigaDOS print control  sequences  (refer  to
  1328.           the  previous  explanation  on  the  use  of  these  in   format
  1329.           strings). Like the AmigaDOS command  'List',  DirKing  uses  two
  1330.           sorts of substitution operators :      
  1331.  
  1332.           a. Usage of '%S' operators.
  1333.  
  1334.           The usage of '%S' substitution  operators  is  limited,  because
  1335.           you only have access to the name and path of  directory  entries
  1336.           (files/directories). To  know  where  and  what  information  to
  1337.           print, DirKing uses the followig table of '%S' occurences :
  1338.  
  1339.             Occurences  1st     2nd     3rd     4th     5th     6th...  
  1340.             1           name    -       -       -       -       -
  1341.             2           path    name    -       -       -       -
  1342.  
  1343.  
  1344.                             DirKing v2.1xe (English) User Manual - Page 21
  1345.  
  1346.             Occurences  1st     2nd     3rd     4th     5th     6th...  
  1347.             3           name    path    name    -       -       -
  1348.             4           path    name    path    name    -       -
  1349.             5           name    path    name    path    name    -
  1350.             6           path    name    path    name    path    name
  1351.             ...
  1352.  
  1353.             | 'LFORMAT Path:[%s]   Name:[%s]' :  Just  try  this   format-
  1354.             | string on a directory  and  see  the  magic.  Note  that  no
  1355.             | quotation marks were used, since  these  aren't  needed  for
  1356.             | LFORMAT, unless you want them in the output!
  1357.  
  1358.           b. Usage of field specific operators.
  1359.  
  1360.           The  usage  of  '%S'   substitution   operators   isn't   really
  1361.           recommended since its range is limited, and  the  format  string
  1362.           can sometimes be hard to read if many operators are  used.  It's
  1363.           better to use  the  field  specific  operators,  since  you  can
  1364.           exactly specify which field to print, and where to print it. 
  1365.  
  1366.           DirKing supports the same field substitution  operators  as  the
  1367.           AmigaDOS command  'List'.  These  operators  consist  of  a  '%'
  1368.           character followed by one of the following codes :
  1369.  
  1370.             - N : print file/directory name;
  1371.             - K : print file/directory diskkey;
  1372.             - B : print filesize in blocks ('Dir' is used for dirs.);
  1373.             - L : print filesize in bytes ('Dir' is used for dirs.);
  1374.             - A : print file/directory attributes (protectionflags);
  1375.             - D : print file/directory datestamp;
  1376.             - T : print file/directory timestamp;
  1377.             - C : print file/directory filenote   (comment);   prints   an
  1378.                   empty string if no comment is present;
  1379.             - P : print the path of the file  or  directory,  relative  to
  1380.                   the scanned path;
  1381.             - F : print the full  path  name  of  the  file  or  directory
  1382.                   (thus beginning with the volume name).
  1383.  
  1384.             | Assume current directory is 'Workbench:Devs'
  1385.             | 'DirKing keymaps LFORMAT File:[%N] Path:[%P] FullP:[%F]'
  1386.             | DirKing will read  the  'Workbench:Devs/KeyMaps'  directory.
  1387.             | The output can then be something like this :
  1388.             | 'File:[usa] Path:[] FullP:[KeyMaps/]'
  1389.             | If you also use  FULLPATH  in  the  command  line  then  the
  1390.             | output will be :
  1391.             | 'File:[usa] Path:[] FullP:[Workbench:Devs/KeyMaps/]'
  1392.  
  1393.             | 'DirKing TO RAM:script FILES LFORMAT RENAME %N %N.iff' :
  1394.             | This will  generate  a  script  in  the  'RAM:'  disk.  When
  1395.             | executed, the rename commands will add an  'iff'  suffix  to
  1396.             | the name of files found in the current directory. 
  1397.  
  1398.        §7 DirKing MULTI-mode (multiple directory scanning). -> [MULTI]
  1399.           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1400.           The MULTI mode was implemented to present  a  more  flexible way
  1401.           of scanning several disks in a  row. If DirKing is first started
  1402.           with  MULTI  in  its  command  line,  then  the  directory  will
  1403.           immediately be read. When the listing has been printed,  instead
  1404.           of breaking off, DirKing will print a prompt giving  the  choice
  1405.           between the following operations :
  1406.  
  1407.  
  1408.                             DirKing v2.1xe (English) User Manual - Page 22
  1409.  
  1410.             - S : start scanning the directory. 
  1411.  
  1412.                   If you want to read several disks, then you must  use  a
  1413.                   drive name as  the  path  (e.g.  'DF1:').  DirKing  will
  1414.                   then always scan the disk in  drive  'DF1:'.  (Otherwise
  1415.                   if you type the name of a disk like  'Workbench:',  then
  1416.                   each time you press  'S'  to  reply  the  MULTI  prompt,
  1417.                   DirKing will always access that disk.)
  1418.  
  1419.                   The  only  time  MULTI  mode  is  useful   when   you've
  1420.                   specified a  path  other  than  a  drive  name,  is  for
  1421.                   printing several copies of that directory.   
  1422.  
  1423.             - Q : quit DirKing.
  1424.  
  1425.             - A : let's you enter new DirKing  arguments,  just  like  you
  1426.                   would when starting  DirKing.  It's  important  to  know
  1427.                   that you don't have to  type  'DirKing'  anymore,  since
  1428.                   you  aren't  starting  the  program!   Only   type   the
  1429.                   arguments.
  1430.             
  1431.                   REMARK: when you don't type anything when  DirKing  asks
  1432.                           for new arguments, then the old  arguments  will
  1433.                           be used again.
  1434.  
  1435.                   Note: you  don't  have  to  type  MULTI  anymore,  since
  1436.                         DirKing will stay in MULTI  mode  until  an  error
  1437.                         occurs, or you want to quit the program.
  1438.  
  1439.             - U : will print the DirKing usage prompt, so you  would  know
  1440.                   the correct syntax before entering new arguments.
  1441.  
  1442.        §8 Listing styles.
  1443.           ~~~~~~~~~~~~~~~
  1444.           DirKing normally prints the files in plain characters,  and  the
  1445.           directories in italic. The directory entries are  also  indented
  1446.           to show the structure of the directory.
  1447.             
  1448.        A. Information format.
  1449.  
  1450.         o [SHOWLEVEL]
  1451.  
  1452.           Instead of indenting with spaces ('   '),  DirKing  will  indent
  1453.           with '__' for files and '_/' for directories. SHOWLEVEL is  very
  1454.           useful to get a clear view of the directory tree structure.
  1455.  
  1456.             | 'DirKing  RAM:  SHOWLEVEL  ALL  DIRS' : you'll get  a  clear
  1457.             | view of the directory tree of your  'Ram  Disk'.  Note  that
  1458.             | the  use  of   DIRS   forces   DirKing   only   to   include
  1459.             | directories.
  1460.  
  1461.         o [BINFLAGS]
  1462.  
  1463.           By default DirKing uses 'hsparwed' to represent  the  file-  and
  1464.           directory attributes (protectionflags). BINFLAGS will result  in
  1465.           a   binary   value   representation  (e.g.  00010000)  of  these
  1466.           attributes.
  1467.  
  1468.  
  1469.  
  1470.  
  1471.  
  1472.                             DirKing v2.1xe (English) User Manual - Page 23
  1473.  
  1474.         o [DATES]
  1475.  
  1476.           Like the AmigaDOS command 'List', DirKing will use the  daynames
  1477.           (Sunday...Saturday) of the dates  if  they're  within  the  last
  1478.           week     of     the     current     date.     Besides      these
  1479.           'Yesterday','Today','Tomorrow' and 'Future' are also used.
  1480.  
  1481.           You can disable this by using 'DATES'. This  forces  DirKing  to
  1482.           print all dates in the  same date format (the default is DD-MMM-
  1483.           YY).
  1484.  
  1485.         o [HEXVAL]
  1486.  
  1487.           Normally all values printed in the listing are in their  decimal
  1488.           notation.  Using  'HEXVAL'  instructs   DirKing   to   use   the
  1489.           hexadecimal notation instead. 
  1490.  
  1491.  
  1492.        B. Listing print styles.
  1493.  
  1494.           The following options define in which style  the  entire  listig
  1495.           is printed, and also how the directory entries  themselves  will
  1496.           be printed.
  1497.  
  1498.         o [DIRSTYLE [r|i|b|y|f|a|e][r|i|b|y|f|a|e]]
  1499.  
  1500.           The   default  print  style  for  files  is  plain  text,  while
  1501.           directories use italics. These styles can be  altered  by  using
  1502.           predifined style codes. Only the first  two  characters  of  the
  1503.           'DIRSTYLE's  data-argument  will  be  used,  where   the   first
  1504.           character gives the style for directories, and  the  second  for
  1505.           files. (One character data-arguments are also valid,  the  files
  1506.           will  then  be  printed  in  their  default  style,  while   the
  1507.           directories will use the specified style.) 
  1508.  
  1509.           The following character style codes are supported :
  1510.  
  1511.             - R : Red 
  1512.             - I : Italic 
  1513.             - B : Bold
  1514.             - Y : Yuppy -> Red/Italic
  1515.             - F : Fat   -> Red/Bold
  1516.             - A : All   -> Red/Italic/Bold
  1517.             - E : Elite -> Italic/Bold
  1518.             - N : Normal (plain)
  1519.  
  1520.           Note:  DIRSTYLEs determine in  which  style  a  directory  entry
  1521.                  will be printed. If you want to print  a  specific  field
  1522.                  in another style, then you  must  make  use  of  AmigaDOS
  1523.                  print  control  sequences  with  the  LISTORD,   DFORMAT,
  1524.                  TFORMAT arguments.
  1525.  
  1526.             | 'DIRSTYLE ab' : print the directories  in  red,  italic  and
  1527.             |                 bold  characters,  and  the  files  in  bold
  1528.             |                 characters.
  1529.  
  1530.         o [PRTSTYLE {rdlbpes}]
  1531.  
  1532.           If the DirKing  output  is  directed  to  the  printer, then the
  1533.           printer style settings won't be changed,  unless  the  following
  1534.  
  1535.  
  1536.                             DirKing v2.1xe (English) User Manual - Page 24
  1537.  
  1538.           codes are given :
  1539.  
  1540.             - R : reset to normal characters
  1541.             - D : print in draft quality
  1542.             - L : print in near_letter_quality
  1543.             - B : print in subscript
  1544.             - P : print in superscript
  1545.             - E : print in elite (12 cpi)
  1546.             - S : print with doublestriking
  1547.  
  1548.             | 'PRTSTYLE de' : print in elite and draft quality.
  1549.  
  1550.  
  1551.        §9 Listing output redirection.
  1552.           ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1553.           The default output is to the  Shell  window  where  DirKing  was
  1554.           started. Although you can use  the  AmigaDOS  redirection  (e.g.
  1555.           '>PRT:')  to  output  somewhere   else,   it's   sometimes   not
  1556.           recommended. This is the case when you use  TRACE  for  example.
  1557.           If you would use AmigaDOS  redirection  when  TRACE  is  active,
  1558.           then  all  TRACE  information  would  be  send   to   this   new
  1559.           destination,  which  isn't  what   you   want.   Therefore   two
  1560.           redirection arguments were implemented in DirKing to  split  the
  1561.           output.  The  DirKing  messages  (e.g.  TRACE  information)  are
  1562.           printed in the Shell window as usual, but the directory  listing
  1563.           will be send to the selected output device.  
  1564.  
  1565.         o [PRT]
  1566.  
  1567.           a. General use.
  1568.  
  1569.           As the argument keyword suggest, this  redirects  the  directory
  1570.           listing to the printer ('PRT:').
  1571.  
  1572.           b. Use in MULTI-mode.
  1573.  
  1574.           When DirKing has to send the directory listing, it  first  opens
  1575.           a channel to the  printer  (this  is  called  'locking'). As you
  1576.           know from the explanation of MULTI, DirKing  doesn't  break  off
  1577.           after printing the directory, instead a prompt is printed.  When
  1578.           you reply this prompt with  'S'  then  DirKing  starts  scanning
  1579.           again. DirKing will then  send  this  listing  again  along  the
  1580.           previously opened channel.
  1581.  
  1582.           It's  important to note that DirKing doesn't close  this  output
  1583.           channel when in MULTI-mode, since DirKing always uses  the  same
  1584.           arguments. ONLY when new arguments are entered (the  prompt  was
  1585.           replied with 'A'), then DirKing will close this  output  channel
  1586.           (and open a new channel to the  new  specified  output  device)!
  1587.           DirKing does this to make sure it always has  direct  access  to
  1588.           the  printer,  so   the   listing   can   be   printed   without
  1589.           interruptions.
  1590.  
  1591.         o [TO <file>]
  1592.  
  1593.           a. General use.
  1594.  
  1595.           With the 'TO'  argument  you  can  send  the  directory  listing
  1596.           anywhere you like, as long as it's a valid AmigaDOS path.
  1597.  
  1598.  
  1599.  
  1600.                             DirKing v2.1xe (English) User Manual - Page 25
  1601.  
  1602.             | 'DirKing  DF1:  TO  RAM:df1'  will  output  the  listing  of
  1603.             | 'DF1:' to a file in RAM: called 'df1'.
  1604.  
  1605.             | 'TO PRT:' : naturally you can also use the  TO  argument  to
  1606.             |             send the directory listing to the printer.
  1607.  
  1608.           b. Use in MULTI-mode.
  1609.  
  1610.           As mentioned with 'PRT', DirKing only opens the  output  channel
  1611.           once. Only when new  arguments  are  supplied  is  this  channel
  1612.           closed, and another opened if needed.
  1613.  
  1614.           This way of working is extremely  useful,  since  you  can  send
  1615.           several directory listings to one file.  All  listings  will  be
  1616.           placed after one another.
  1617.  
  1618.             | 'DirKing  DF1:  TO  RAM:df1_dirs  MULTI'   will   send   all
  1619.             | directory listings of the disks you've  inserted  in  'DF1:'
  1620.             | to the file in RAM: called 'df1_dirs'
  1621.  
  1622.           c. Use in conjunction with PRT.
  1623.  
  1624.           If only 'TO' is used, then DirKing will save  the  listing  with
  1625.           the Shell control  sequences.  When  you  also  use  'PRT'  then
  1626.           DirKing will use the printer control sequence instead. 
  1627.           Let's take a  look  at  the  printing  of  bold  characters,  to
  1628.           demonstrate the difference between these control sequences :
  1629.  
  1630.             -> Shell control sequences > bold on  : 'esc[1m' 
  1631.                                          bold off : 'esc[0m' <<
  1632.             -> Print control sequences > bold on  : 'esc[1m'
  1633.                                          bold off : 'esc[22m' <<
  1634.  
  1635.        §10 Listing paging. -> [NEWPAGE [[{th}]<#>]
  1636.            ~~~~~~~~~~~~~~~
  1637.           By  default DirKing will print the directory listing in one  go.
  1638.           If a long listing is send to a Shell  window,  then  it  can  be
  1639.           annoying to see it flying by. To prevent this from happening,  a
  1640.           paging facility was implemented in DirKing.
  1641.  
  1642.           The NEWPAGE argument  can  be  used  in  three  different  ways.
  1643.           Besides this, the effect of  'NEWPAGE'  isn't  always  the  same
  1644.           when output is send to the Shell, to a file or to the printer. 
  1645.  
  1646.           a. Command : 'NEWPAGE'.
  1647.  
  1648.           When only 'NEWPAGE' is used,  and  output is redirected by 'PRT'
  1649.           or  'TO  <file>' then at the end a new page  character  will  be
  1650.           send.
  1651.  
  1652.           REMARK: the bare 'NEWPAGE' command has  no  effect  when  output
  1653.                   is send to your Shell window!  
  1654.  
  1655.           b. Command : 'NEWPAGE <#>'. 
  1656.  
  1657.           NEWPAGE will mostly be used in  this  way.  By  adding  a  value
  1658.           (greater than 10) to the NEWPAGE keyword, you  can  specify  how
  1659.           many lines should be printed on each page.
  1660.  
  1661.           If  output  is  send  to  your  Shell  window, then DirKing will
  1662.  
  1663.  
  1664.                             DirKing v2.1xe (English) User Manual - Page 26
  1665.  
  1666.           display a RETURN-prompt when the  specified  maximum  lines  has
  1667.           been reached. When RETURN is pressed, the Shell window  will  be
  1668.           cleared, and the next number of  lines  will  be  printed.  This
  1669.           process will be repeated  until  the  entire  listing  has  been
  1670.           printed.
  1671.  
  1672.           When  output  is  redirected  with  'PRT'  or  'TO  <file>' then
  1673.           instead of printing a RETURN-prompt in the Shell window,  a  new
  1674.           page charachter will be inserted  in  the  listing.  This  means
  1675.           that, if for instance output is send to the  printer,  that  the
  1676.           paper will be ejected, each time the specified number  of  lines
  1677.           is reached. As with the  bare  'NEWPAGE'  command,  a  new  page
  1678.           character will be send at the end of the listing.
  1679.  
  1680.             | 'NEWPAGE 20' : only print 20 lines on a page.
  1681.  
  1682.           REMARK: If the given value is less than 10, then the  number  of
  1683.                   lines will be set to 10!
  1684.  
  1685.           c. Command : 'NEWPAGE {ht}' or 'NEWPAGE {ht}<#>'.
  1686.  
  1687.           The  NEWPAGE  argument  also  supports  two  additional options,
  1688.           which are indicated by the  following  characters  (all  options
  1689.           can be used at once)  and  are  used  in  conjunction  with  the
  1690.           commands as explained in (a.) en (b.) :
  1691.  
  1692.             - H : after  the  listing  header  is  printed,  a  new   page
  1693.                   character will be send.
  1694.             - T : always print a listing  title  at  the  beginning  of  a
  1695.                   new page. 
  1696.  
  1697.             | 'NEWPAGE h' : after the listing head has been  printed,  use
  1698.             |               a new page to print the actual listing.
  1699.  
  1700.             | 'NEWPAGE ht20' : print  the  listing  header  on  one  page,
  1701.             |                  then use only 20 lines per  page  to  print
  1702.             |                  the listing itself.
  1703.  
  1704.        §11 Disk identification coding support.  -> [DISKID <str>]
  1705.            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1706.           a. General use.
  1707.  
  1708.           If  you  use  a  catalog  tool  to  keep  track  of  your   disk
  1709.           collection, then this feature of  DirKing  is  very  useful.  It
  1710.           enables you to insert a string (this can be a disk ID  used  for
  1711.           cataloging your disks, or any  other  message)  in  the  listing
  1712.           header.  
  1713.  
  1714.           REMARK: Most times the DISKID string  will  contain  spaces,  in
  1715.                   which case you must  place  the  string  between  double
  1716.                   quotation marks.  
  1717.  
  1718.             | 'DISKID PD0/00.0000' : this disk ID will be printed  in  the
  1719.             |                        header.
  1720.  
  1721.             | 'DISKID "This is a  test  ID  string!"' : prints this string
  1722.             | in the listing header (notice the double quotation marks).
  1723.  
  1724.  
  1725.  
  1726.  
  1727.  
  1728.                             DirKing v2.1xe (English) User Manual - Page 27
  1729.  
  1730.           b. Use in MULTI-mode. 
  1731.  
  1732.           The disk ID string that was typed  in  the  command  line  (thus
  1733.           when starting DirKing from Shell) will only be used  once!  Each
  1734.           time you reply the  MULTI  prompt  with  'S'  (start  scanning),
  1735.           DirKing will first ask  to  enter  a  new  disk  ID  string  (or
  1736.           message) before reading the directory.
  1737.  
  1738.        §12 DirKing program information.  -> [VERSION]
  1739.            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1740.           VERSION simply  instructs  DirKing  to  print  the  version  and
  1741.           copyright prompt.
  1742.  
  1743.  
  1744.  
  1745.  
  1746.  
  1747.  
  1748.  
  1749.  
  1750.  
  1751.  
  1752.  
  1753.  
  1754.  
  1755.  
  1756.  
  1757.  
  1758.  
  1759.  
  1760.  
  1761.  
  1762.  
  1763.  
  1764.  
  1765.  
  1766.  
  1767.  
  1768.  
  1769.  
  1770.  
  1771.  
  1772.  
  1773.  
  1774.  
  1775.  
  1776.  
  1777.  
  1778.  
  1779.  
  1780.  
  1781.  
  1782.  
  1783.  
  1784.  
  1785.  
  1786.  
  1787.  
  1788.  
  1789.  
  1790.  
  1791.  
  1792.                             DirKing v2.1xe (English) User Manual - Page 28
  1793.  
  1794.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1795.                      APPENDIX : DIRKING KEYWORD REFERENCE  
  1796.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1797.         Pattern matching . . . . . . . . . . . . . . . . . . . . . .  4
  1798.         ---------------------------------------------------------------
  1799.         <path|patt>. . . [[F|D|]<path|patt>] . . . . . . . . . . . .  5
  1800.         ALL. . . . . . . . . . . . . . . . . . . . . . . . . . . . .  8
  1801.         BARELIST . . . . . . . . . . . . . . . . . . . . . . . . . . 15
  1802.         BINFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . 23
  1803.         DATEF. . . . . . [DATEF <0..7>]. . . . . . . . . . . . . . . 21
  1804.         DATES. . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
  1805.         DESC . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
  1806.         DF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
  1807.         DFORMAT. . . . . [DFORMAT <fmtstr>]. . . . . . . . . . . . . 20
  1808.         DIRS . . . . . . . . . . . . . . . . . . . . . . . . . . . .  8
  1809.         DIRSTYLE . . . . [DIRSTYLE [r|i|b|y|f|a|e][r|i|b|y|f|a|e]] . 24
  1810.         DISKID . . . . . [DISKID <str>]. . . . . . . . . . . . . . . 27
  1811.         DISKINFO . . . . . . . . . . . . . . . . . . . . . . . . . . 12
  1812.         DISKUSE. . . . . . . . . . . . . . . . . . . . . . . . . . . 13
  1813.         ENDMSG . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
  1814.         EXCL . . . . . . [EXCL {fkbladtc}] . . . . . . . . . . . . . 16
  1815.         EXPAND . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
  1816.         FD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
  1817.         FILES. . . . . . . . . . . . . . . . . . . . . . . . . . . .  8
  1818.         FROM..TO . . . . [FROM [F|D|]<ch> TO <ch>] . . . . . . . . . 10
  1819.         FULLPATH . . . . . . . . . . . . . . . . . . . . . . . . . . 14
  1820.         HEAD . . . . . . [HEAD {fdvpimtse}]. . . . . . . . . . . . . 14
  1821.         HEXVAL . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
  1822.         INCL . . . . . . [INCL {fkbladtc}] . . . . . . . . . . . . . 16
  1823.         LFORMAT. . . . . [LFORMAT <fmtstr>]. . . . . . . . . . . . . 21
  1824.         LISTF. . . . . . [LISTF <0..4>]. . . . . . . . . . . . . . . 20
  1825.         LISTORD. . . . . [LISTORD <fmt>] . . . . . . . . . . . . . . 19
  1826.         MAXHEAD. . . . . . . . . . . . . . . . . . . . . . . . . . . 15
  1827.         MAXWIDTH . . . . [MAXWIDTH <#>]. . . . . . . . . . . . . . . 18
  1828.         MIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
  1829.         MULTI. . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
  1830.         NEWPAGE. . . . . [NEWPAGE [[{th}]<#>]] . . . . . . . . . . . 26
  1831.         NOHEAD . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
  1832.         NOSORT . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
  1833.         NOSTAT . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
  1834.         PASS . . . . . . [PASS [F|D|]<pattern>]. . . . . . . . . . .  9
  1835.         PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . .  6
  1836.         PRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
  1837.         PRTSTYLE . . . . [PRTSTYLE {rdlbpes}]. . . . . . . . . . . . 24
  1838.         QUICK. . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
  1839.         READ . . . . . . [READ [F|D|]<pattern>]. . . . . . . . . . .  9
  1840.         SHOWLEVEL. . . . . . . . . . . . . . . . . . . . . . . . . . 23
  1841.         SINCE. . . . . . [SINCE "[F|D|]<[DOSdate] [time]>"]. . . . . 11
  1842.         SORT . . . . . . [SORT {nksadtc}]. . . . . . . . . . . . . . 17
  1843.         SUB. . . . . . . [SUB [F|D|]<string>]. . . . . . . . . . . . 10
  1844.         TFORMAT. . . . . [TFORMAT <fmtstr>]. . . . . . . . . . . . . 20
  1845.         TIMEF. . . . . . [TIMEF <0..3>]. . . . . . . . . . . . . . . 21
  1846.         TO . . . . . . . [TO <file>] . . . . . . . . . . . . . . . . 25
  1847.         TOLEVEL. . . . . [TOLEVEL <#>] . . . . . . . . . . . . . . .  8
  1848.         TRACE. . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
  1849.         UPTO . . . . . . [UPTO "[F|D|]<[DOSdate] [time]>"] . . . . . 11
  1850.         VERSION. . . . . . . . . . . . . . . . . . . . . . . . . . . 28
  1851.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1852.         DirKing v2.12e, Copyright ©1990-1993 by Chris P. Vandierendonck,
  1853.                         All Rights Reserved.
  1854.  
  1855.  
  1856.                             DirKing v2.1xe (English) User Manual - Page 29
  1857.