home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / os2clu01.zip / UTILS.DOC < prev    next >
Text File  |  1993-07-04  |  31KB  |  1,045 lines
  1.  Documentation for OS/2 2.0 Command Line Utilities                   Page 1
  2.  
  3.             Command Line Utilities Documentation -- 04th July 1993
  4.  
  5.                           Package Version 1.04 (Beta)
  6.  
  7.              Package Copyright (c) 1993 Jonathan de Boyne Pollard
  8.               Licensed under General Public Licence version 1.00
  9.  
  10.                 Jonathan de Boyne Pollard, c/o 1 Queen's Close
  11.                       KENILWORTH  CV8 1JR, United Kingdom
  12.                    Telephone +44 926 484514 (1000-1800 GMT)
  13.  
  14.      This file is plain ANSI text with embedded tabs and form-feeds. It may be
  15.      viewed with an ANSI file viewer. This is preferable to printing it out,
  16.      because saving paper saves the environment.
  17.  
  18.      To view :    LIST UTILS.DOC         (Vernon Buerg's file viewer)
  19.      To print :   PRINT UTILS.DOC        (MDOS and OS/2 print utility)
  20.  
  21.      This file contains documentation for the command line utilities written
  22.      for OS/2 version 2.0 by Jonathan de Boyne Pollard. The DOS session
  23.      versions of the utilities have been tested under OS/2 2.0 VDM sessions,
  24.      MDOS 6.0 and DR-DOS 6.0.
  25.  
  26.      Although I have taken great pains to ensure that these utilities are
  27.      problem-free (or at least, any known problems are thoroughly documented),
  28.      if you do find a problem with them, please contact me in writing at the
  29.      address given and I will attempt to cure it. Please provide BAT, CMD or
  30.      BTM files for complex command sequences, and state the make and version of
  31.      the operating system.
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  Copyright (c) 1993 JdeBP
  59.  Documentation for OS/2 2.0 Command Line Utilities                   Page 2
  60.  
  61.      What are the utilities ?
  62.      ────────────────────────
  63.  
  64.      The command line utilities are written to provide equal functionality in
  65.      OS/2 and DOS sessions under OS/2 version 2.0, and extend the functionality
  66.      of the bundled command processors.
  67.  
  68.      Some features :
  69.  
  70.      ■ All utilities extend the normal DOS and OS/2 wildcards with a Bourne
  71.        shell like syntax, allowing for easy manipulation of specific groups of
  72.        files as a whole.
  73.  
  74.      ■ All utilities support the /? online help option.
  75.  
  76.      ■ All utilities will access the NLS message database for error messages
  77.        under OS/2 2.0 (e.g. "SYS0002: Fichier non-trouve." will be used in
  78.        France). Details of setting this up for VMB sessions as well are
  79.        available in the OPSYS.DOC document.
  80.  
  81.      ■ The option set is orthogonal. E.g. the /A and /S options are the same
  82.        for all utilities.
  83.  
  84.      ■ All utilities support NLS date and time, and automatically reformat
  85.        output for the current country specified in CONFIG.SYS.
  86.  
  87.      ■ Utilities with "pause" features will adjust to EGA and VGA 43 and 50
  88.        line modes.
  89.  
  90.      ■ All utilities support HPFS long filenames under OS/2.
  91.  
  92.      These utilities were designed primarily for use under OS/2 2.0 in both
  93.      OS/2 and DOS sessions. Although they work under DR-DOS and MDOS, this is
  94.      not their primary purpose. Where OS/2 and DR-DOS or MDOS differ, OS/2 is
  95.      assumed.
  96.  
  97.      The rest of this document
  98.      ─────────────────────────
  99.  
  100.      ■ The utilities from all three discs are detailed in alphbetical order;
  101.  
  102.      ■ Then there is a note on extended wildcards;
  103.  
  104.      ■ After that, the "standard" command line options are listed;
  105.  
  106.      ■ And finally the credits.
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  Copyright (c) 1993 JdeBP
  117.  Documentation for OS/2 2.0 Command Line Utilities                   Page 3
  118.  
  119.      The utilities
  120.      ─────────────
  121.  
  122.      ATTRIB [/Help] [/Options[-|+]] [-|+[ndvRASH]] Filespecs ...
  123.  
  124.       ■ ATTRIB supports the /A /D /L /N /P /R /S /V /Y standard options ■
  125.  
  126.         The ATTRIB command allows file attributes to be changed, exactly as the
  127.         DOS ATTRIB command does. However, it supports extended wildcards, can
  128.         act upon subdirectories, and allows multiple operations upon files.
  129.  
  130.         Attributes may be turned on and off using '+letter' and '-letter'
  131.         between filenames (which is why options may not be preceded by '-' for
  132.         this command). Attributes are incremental along the command line, e.g.
  133.  
  134.                  ATTRIB -H *.HID -S *.SYS +R *.EXE
  135.  
  136.         will remove the Hidden attribute from *.HID files, remove the Hidden
  137.         AND System attributes from *.SYS files, and remove both and add the
  138.         ReadOnly attribute to *.EXE files.
  139.  
  140.         On Novell networks in DOS sessions, the -N and +N attributes will
  141.         enable and disable the Netware "shareable" attribute.
  142.  
  143.      CMOS [/Help] [/All] [/dsex]
  144.  
  145.         The CMOS command displays the contents of CMOS RAM on AT and above
  146.         class machines. The /D(ate), /S(tatus), /E(quipment), and /X(hex)
  147.         toggle options enable display of specific information.
  148.  
  149.         Under OS/2 2.0 you must either have IOPL=YES or IOPL=CMOS in your
  150.         CONFIG.SYS file to enable the program to access the CMOS RAM.
  151.  
  152.         Because it cannot easily do so under OS/2, CMOS does not check the BIOS
  153.         to ansure that it is run on an AT class machine, or to obtain the drive
  154.         table.  Drive types are encoded into CMOS.EXE.
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  Copyright (c) 1993 JdeBP
  175.  Documentation for OS/2 2.0 Command Line Utilities                   Page 4
  176.  
  177.      COM2EXE [/Help] InFile[.com] [OutFile[.exe]]
  178.      EXE2COM [/Help] InFile[.exe] [OutFile[.com]]
  179.  
  180.         EXE2COM is a version of the EXE2BIN program that comes supplied with
  181.         MDOS 3.x and DR-DOS 6.0, which is not supplied with OS/2 2.0, MDOS 5.0
  182.         or MDOS 6.0.
  183.  
  184.         EXE2COM's operation is based upon the DR-DOS variant of the EXE2BIN
  185.         command, in that a COM or BIN extension is chosen based upon the
  186.         initial value of IP in the EXE header record, and program output
  187.         closely mimics DR-DOS' EXE2BIN.
  188.  
  189.         COM2EXE is used to convert COM format files to EXE files. Early
  190.         versions of CodeView and other debuggers would not load COM files
  191.         correctly, and COM2EXE can be used to create an EXE format file that
  192.         can be debugged.
  193.  
  194.         Because they are compressed, DR-DOS 6.0 contains all DOS commands in
  195.         EXE format, despite the COM extension of some commands. Similarly, MDOS
  196.         6.0 contains some COM files which are really EXE files with the wrong
  197.         extension. Both EXE2COM and COM2EXE will check the header record of a
  198.         file for the 'MZ' signature before conversion and act accordingly.
  199.  
  200.         OS/2 2.0 supplies most commands as "dual mode" commands, using the "New
  201.         EXE" format. EXE2COM and COM2EXE will refuse to operate on these
  202.         programs.
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  Copyright (c) 1993 JdeBP
  233.  Documentation for OS/2 2.0 Command Line Utilities                   Page 5
  234.  
  235.      DUMP [/Help] [/Options[+|-]] Filespecs ...
  236.  
  237.       ■ DUMP supports the /A /S standard options ■
  238.  
  239.         DUMP is a file content display program, which recognises files
  240.         according to their extensions and attempts to display them accordingly.
  241.  
  242.         EXE and COM programs will have their initial 'MZ' header record
  243.         displayed, if available, showing the size of the program and various
  244.         loading parameters. DUMP will recognise EXE format programs that have
  245.         been converted from COM programs using COM2EXE or PKLITE.
  246.  
  247.         LIB and OBJ files will be have their Intel OMF records displayed. DUMP
  248.         recognises several of the Borland and Microsoft OMF additions, such as
  249.         Borland AutoMAKE records, and display them accordingly.
  250.  
  251.         ARC, ARJ, LZH, ZIP, and ZOO files will have their archive contents
  252.         displayed. In addition, ZIP files will have their ZIP archive comment
  253.         displayed.
  254.  
  255.       ■ Note ■
  256.  
  257.         Until an OS/2 version of Vernon Buerg's FV file viewer is widely
  258.         available, you may copy DUMP.EXE to FV.EXE, allowing you to operate the
  259.         Archive [V]iew option in Vernon Buerg's LISTOS2.
  260.  
  261.         Users of 4OS2 may use the easier ALIAS FV=DUMP .
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  Copyright (c) 1993 JdeBP
  291.  Documentation for OS/2 2.0 Command Line Utilities                   Page 6
  292.  
  293.      FF [/Help] [/Options[+|-]] Pathspecs ...
  294.  
  295.       ■ FF supports the /L /P standard options ■
  296.  
  297.         FF is a File Finder program for use under OS/2 2.0 that will locate
  298.         files in subdirectories and within archives. It supports the following
  299.         toggle options :
  300.  
  301.            /ARC      Search inside ARC format archives;
  302.            /ARJ      Search inside ARJ format archives (not multi-volume);
  303.            /LZH      Search inside LZH format archives;
  304.            /PAK      Search inside PZK format archives;
  305.            /ZIP      Search inside ZIP format archives (not multi-volume);
  306.            /ZOO      Search inside ZOO format archives;
  307.            /DIR      Search the normal DOS directory (enabled by default).
  308.  
  309.         The /N option may be used to disable all archive searching options
  310.         (normally all archive types apart from ARC and PAK will be searched)
  311.         for a faster search.
  312.  
  313.         The /R option forces the search to start from the root directory.
  314.         Normally the search starts from the directory specified in the path
  315.         specification (the current directory by default). This is because
  316.         starting from the root directory is less than useful on networks.
  317.  
  318.         The /D option (normally off) enables a "progress display" of the
  319.         current archive or directory being searched. In an OS/2 windowed
  320.         session this can significantly slow down the search.
  321.  
  322.         The /T option disables output of filenames, and displays the total
  323.         number of files found, and the total number found in each archive type
  324.         (if any) along with the total sizes in each category.
  325.  
  326.         The /V option (normally on) enables display of attribute and datestamp
  327.         information along with each file. Because of FF's simple approach to
  328.         ZIP archives, no attribute information is available when displaying
  329.         files found therein.
  330.  
  331.         The /W(ide) option in combination with /V- disables output of attribute
  332.         and datestamp information for each file, displaying filenames in a
  333.         columnar format.
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  Copyright (c) 1993 JdeBP
  349.  Documentation for OS/2 2.0 Command Line Utilities                   Page 7
  350.  
  351.      KEYLOCKS [/Help] [/Options[-|+]]
  352.  
  353.         KEYLOCKS alters the state of the keyboard shift locks (CAPS, NUM, and
  354.         SCROLL). The /C(aps), /N(um) and /S(croll) options will either toggle
  355.         the existing status, or will force the appropriate lock on if
  356.         followed by + or off if followed by -.
  357.  
  358.         KEYLOCKS works in full screen VDM, VMB, or OS/2 sessions. It does not
  359.         work in sessions that are windowed on the desktop.
  360.  
  361.      LINES [/Help] [/Options[-|+]] ROWS [COLS]
  362.  
  363.         LINES changes the screen size of a text mode or windowed OS/2 or DOS
  364.         session. The /C and /M options force use of a colour or monochrome
  365.         mode, otherwise the current setting is retained if possible.
  366.  
  367.         Unlike the MODE command, LINES will not clear the screen when changing
  368.         screen size, and will attempt to keep the current cursor position.
  369.  
  370.         The /V option to lines will cause it to display (after changing mode)
  371.         the display mode and adapter that were previously in operation.
  372.  
  373.         LINES supports 5 to 102 line modes in an OS/2 windowed session.
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  Copyright (c) 1993 JdeBP
  407.  Documentation for OS/2 2.0 Command Line Utilities                   Page 8
  408.  
  409.      MEM [/Help] [/Options[-|+]]
  410.  
  411.       ■ MEM is available as a DOS tool only. ■
  412.  
  413.         MEM displays the DOS memory map and some useful information for
  414.         checking which memory managers are loaded and what types of memory are
  415.         available.
  416.  
  417.         MEM will detect XMS and DPMI and display information about them,
  418.         including the amound of UMB memory available from ther XMS driver, the
  419.         XMS entry point, the DPMI entry point, the DPMI server version number;
  420.         whether it is a 16-bit or 32-bit server; and the CPU that the DPMI
  421.         server is supporting.
  422.  
  423.         MEM will display in order
  424.  
  425.             a full memory map of DOS memory from 0000:0000 to FFFF:FFFF,
  426.             including all device drivers, system areas, and the XMS and DPMI
  427.             entry points if available
  428.  
  429.             a summary of available memory;
  430.  
  431.             the DOS version number and HMA loading information;
  432.  
  433.             and any DPMI server information.
  434.  
  435.         The /S(ystem) option enables inclusion of system areas and information
  436.         in the display. The /D(rivers) option enables display of loaded device
  437.         drivers, including their attribute words. The /M(ap) option displays
  438.         the summary map of available memory.
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  Copyright (c) 1993 JdeBP
  465.  Documentation for OS/2 2.0 Command Line Utilities                   Page 9
  466.  
  467.      MOREANSI [/Help] [/Options[+|-]] Filespecs ...
  468.  
  469.         MOREANSI is a simple rewrite of the MORE command that is able to
  470.         display ANSI files created by ANSI screen generators like TheDraw
  471.         in a more intelligent fashion.
  472.  
  473.         MOREANSI will attempt to pause before every clear screen, and every
  474.         time a screenfull of text has scrolled by. It attempts to do the
  475.         latter by counting CRLFs, and discounting the dummy CRLF sequences
  476.         that screen generators have to insert in order to overcome
  477.         line-wrap problems.
  478.  
  479.         MOREANSI is useful as an external ANSI file viewer in mail readers
  480.         that do not directly support ANSI internally (such as MegaMail),
  481.         and is part of the forthcoming MishMugs QWK mail reader for OS/2
  482.         2.1.
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  Copyright (c) 1993 JdeBP
  523.  Documentation for OS/2 2.0 Command Line Utilities                   Page 10
  524.  
  525.      PROFF [/Help] [/atf] [/v(stv)] Files ...
  526.  
  527.         PROFF is a simple text formatter for displaying ProText documents on
  528.         the screen. ANSI screen codes wust be enabled for PROFF to work
  529.         properly.
  530.  
  531.         For an example of a PROFF document, see the UTILS.1 document from which
  532.         UTILS.DOC was constructed. Very much like a poor man's NROFF, PROFF
  533.         allows files to be created with a simple text editor (ProText was not
  534.         used to create the UTILS.1 file !) and them formatted with headers,
  535.         footers, tabulation and margins.
  536.  
  537.      TOUCH [/Help] [/Options[-|+]] Filespecs ...
  538.  
  539.       ■ TOUCH supports the /A /D /L /N /P /R /S /V /Y standard options ■
  540.  
  541.         TOUCH allows the "last modified" datestamps of files to be changed.
  542.         Based upon the command syntax of DR-DOS' TOUCH, it not only defaults to
  543.         updating files to today's date, but can be given a specific date and
  544.         time to use.
  545.  
  546.         The /D option must be followed by a date string in the format
  547.         appropriate to the country set by COUNTRY= in your CONFIG.SYS file.
  548.         Similary the /T option must be followed by a (24 hour) time string in
  549.         your local time format.
  550.  
  551.         E.g. for United Kingdom users the following formats are required :
  552.  
  553.                  OS/2 2.0            DD-MM-YY HH:MM:SS
  554.                  MDOS 6.0            DD/MM/YY HH:MM:SS
  555.                  DR-DOS 6.0          DD-MM-YY HH:MM:SS
  556.  
  557.         Users in other countries should consult the output of their DATE and
  558.         TIME commands.
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  Copyright (c) 1993 JdeBP
  581.  Documentation for OS/2 2.0 Command Line Utilities                   Page 11
  582.  
  583.      WC [/Help] [/!] [/Options[-|+]] Filespecs ...
  584.  
  585.       ■ WC supports the /A /L /S standard options ■
  586.  
  587.         WC is a word counting program which will count and display the number
  588.         of lines, words, letters, characters, and bytes in the files specified
  589.         on the command line, or from the standard input if no files are given.
  590.  
  591.         WC fully supports extended wildcards and subdirectory searches. The '-'
  592.         filename instructs WC to count the standard input in a list of files.
  593.  
  594.         WC will normally split words at any character that is not a letter
  595.         character. The /H option when enabled stops hyphens splitting words.
  596.         Similary the /U option when enabled stops punctuation from splitting
  597.         words.
  598.  
  599.         The /C option when enabled stops control characters from being counted
  600.         as characters.  Blank spaces or Tabs do not count as characters.
  601.  
  602.      WHAT [/Help] [/Options[-|+]] Filespecs ...
  603.  
  604.       ■ WHAT supports the /A /L /S standard options ■
  605.  
  606.         The WHAT command searches for identity strings in files This is an
  607.         amalgam of various file identification programs.
  608.  
  609.         The /N option enables the display of identification strings found in
  610.         Novell programs.  These are strings preceded by the VeRsIoN= tag.
  611.  
  612.         The /U option enables the display of identification strings generated
  613.         by SCCS systems.  This is the @(#) tag.
  614.  
  615.         The /T option enables the display of the strings created by SCCS
  616.         variant used by Tandon corporation in their DOS. This is the @[#] tag.
  617.  
  618.         The /G option enables the display of strings enclosed in double braces,
  619.         e.g. {{ My File 01 Jan 93 by me }}.
  620.  
  621.         The /C option will perform a CRC-16 of each file as it is scanned, and
  622.         print the result in hexadecimal.
  623.  
  624.         All of the utilities included in this package have an SCCS tag.
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  Copyright (c) 1993 JdeBP
  639.  Documentation for OS/2 2.0 Command Line Utilities                   Page 12
  640.  
  641.      WHICH [/Help] [/e PATHENV] Program
  642.  
  643.         WHICH determines what command would be executed were it to be typed at
  644.         the command line. It searches the PATH environment variable (although
  645.         the /E option can denote another variable) for the command, using the
  646.         COM, EXE, BAT, BTM, and CMD extensions if none are supplied.
  647.  
  648.         WHICH is also aware of commands built in to various command processors
  649.         (COMMAND.COM and CMD.EXE) and will indicate internal commands.
  650.  
  651.         Like 4DOS and 4OS2 (J.P. SOFTWARE's command interpreters), WHICH will
  652.         search the current directory first only if it is not already mentioned
  653.         in the PATH. Also WHICH supports 4DOS and 4OS2 "executable extensions"
  654.         and will indicate any found.
  655.  
  656.         Note that because WHICH supports extended wildcards, it is useful for
  657.         full utility directories :
  658.  
  659.            WHICH *BOOT*           "How many boot utilities do I have ?"
  660.  
  661.            WHICH *FF*             "Show me all of the File Finders ..."
  662.  
  663.         Also which can be used to locate library or help files :
  664.  
  665.            WHICH /E HELPFILES *.HLP
  666.            WHICH /E LIB *87*.LIB
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  Copyright (c) 1993 JdeBP
  697.  Documentation for OS/2 2.0 Command Line Utilities                   Page 13
  698.  
  699.      XDEL [/Help] [/Options[-|+]] Filespecs ...
  700.  
  701.       ■ XDEL supports the /A /D /L /N /P /R /S /V /Y standard options ■
  702.  
  703.         XDEL is an extension of the DEL command, based (again) on the syntax of
  704.         DR-DOS' XDEL command. It supports subdirectory searches and extended
  705.         wildcards.
  706.  
  707.         The /Z(ap) option to XDEL forces files to be overwritten with zeros
  708.         before deletion, making recovery with an UNDELETE utililty rather
  709.         pointless.
  710.  
  711.         The /D(irectory) option to XDEL will remove empty subdirectories when
  712.         performing a recursive delete.
  713.  
  714.      XDIR [/Help] [/Options[+|-]] Filespecs ...
  715.  
  716.       ■ XDIR supports the /A /D /L /N /O /P /R /S /V /Y standard options ■
  717.  
  718.         XDIR is an extension of the DIR command, based (once more) on the
  719.         syntax of DR-DOS' XDIR command. It supports subdirectory searches and
  720.         extended wildcards.
  721.  
  722.         Note that, unlike other DIR and XDIR commands, this XDIR can be told to
  723.         display either of the creation or last access datestamps instead of the
  724.         last modification timestamp under OS/2 2.0, and will sort on the
  725.         datestamp selected.
  726.  
  727.         Normally XDIR will scan all filenames into memory and display a sorted
  728.         list. Where there are too many filenames, or scanning is slow and
  729.         sorting undesirable, the /N option will display filenames as they are
  730.         scanned, and not read them into memory.
  731.  
  732.         The sorting options are as for MDOS 5.0 and OS/2 2.0, with the addition
  733.         of Y (which is currently unused). Note that the G (file type) sorting
  734.         option sorts files into Directories > Executables > Other files.
  735.  
  736.         The /B option disables full output of attributes and file datestamps.
  737.  
  738.         The /F option enables display of the full pathname of files found. If
  739.         it is disabled, then only the 13 character base file name is displayed.
  740.  
  741.  
  742.  
  743.  
  744.  
  745.  
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  Copyright (c) 1993 JdeBP
  755.  Documentation for OS/2 2.0 Command Line Utilities                   Page 14
  756.  
  757.      Wildcards
  758.      ─────────
  759.  
  760.      Wildcards on the command line may be used as follows :
  761.  
  762.          *   matches zero or more characters, including full stops '.';
  763.          ?   matches a single character, including a full stop '.';
  764.          [abc] ranges delimited with brackets match one character included in
  765.              the range;
  766.          {,} braces denote a list of comma-separated strings, any one of which
  767.              may match that part of the filename;
  768.          .   matches either another full stop '.' or the end of the filename;
  769.  
  770.          Any other character matches that character alone.
  771.  
  772.      Under OS/2 2.0 (both real and protected mode sessions) and on networked
  773.      drives with Novell Netware, the behaviour of the '*' wildcard is the same
  774.      as for the UNIX Bourne shell, in that '*abc*' will match names with 'abc'
  775.      contained anywhere in them. Under other DOSes, this is not so, and the
  776.      utilities will attempt to correct for this if they fail to detect OS/2
  777.      2.0.
  778.  
  779.      This may cause performance problems under other other DOSes. For instance,
  780.      suppose a directory containing 300 files, 30 of which end in 's'. Under
  781.      OS/2 2.0, the operating system will return only 30 file names for the
  782.      utility to process, whereas under another DOS, all 300 will be returned,
  783.      and the utility will have to select those ending in 's' itself.
  784.  
  785.      Some wildcard examples :
  786.  
  787.          *                          All files.
  788.  
  789.          *.*                        All files (for compatibility with DOS).
  790.  
  791.          *.                         All files without an extension.
  792.  
  793.          *.{exe,com,bat}            All executable and batch files.
  794.  
  795.          [abc]*                     All files beginning with A, B, or C.
  796.  
  797.          [^abc]*                    All files not beginning with A, B, or C.
  798.  
  799.          *b*                        All files with B in their name, including
  800.                                     in the extension.
  801.  
  802.          *b*.*                      All files with B in the name.
  803.  
  804.          ???.*                      All 3 letter files (any extension).
  805.  
  806.          *.?                        All files with a single extension letter.
  807.  
  808.  
  809.  
  810.  
  811.  
  812.  Copyright (c) 1993 JdeBP
  813.  Documentation for OS/2 2.0 Command Line Utilities                   Page 15
  814.  
  815.      Command line options
  816.      ────────────────────
  817.  
  818.          All utilities support command line options in the same way :
  819.  
  820.                /?         The help screen is displayed (with any options
  821.                /Help      preceding on the command line in effect), and the
  822.                           utility terminated.
  823.  
  824.                /S+        A toggle option followed by '+' will turn it on.
  825.                /S-        A toggle option followed by '-' will turn it off.
  826.                /S         A toggle option on its own will reverse the value.
  827.  
  828.                /P+S+Y+    Options may be combined after a single '/'.
  829.  
  830.                -S+        Options may also follow '-' for UNIX diehards, except
  831.                           in the ATTRIB command.
  832.  
  833.          All options are processed before any filenames, whatever the order is
  834.          on the command line.
  835.  
  836.          To disable misinterpretation of filenames beginning with '/', the '//'
  837.          string will disable further option processing.
  838.  
  839.          (Similary to disable misinterpretation of filenames beginning with
  840.          '-', the '--' string will disable further option processing.)
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869.  
  870.  Copyright (c) 1993 JdeBP
  871.  Documentation for OS/2 2.0 Command Line Utilities                   Page 16
  872.  
  873.      Some "standard" option letters
  874.      ──────────────────────────────
  875.  
  876.      /A   The /A option allows inclusion of files by their attributes.
  877.           '+' followed by an attribute letter will include files with that
  878.           attribute. '-' followed by a letter will exclude files. An attribute
  879.           letter on its own will force ONLY files with that attribute to be
  880.           processed. The attributes are :
  881.  
  882.               N(etShare), D(irectory), V(olume label)
  883.               R(ead only), A(rchive), S(ystem), H(idden).
  884.  
  885.      /D   The /D option enables operation on directories where this is
  886.           meaningful. For instance, XDEL will delete empty subdirectories if
  887.           this is enabled.
  888.  
  889.      /L   The /L option indicates that filenames should be converted to
  890.           lowercase.
  891.  
  892.      /N   This stops actual execution of commands that change files (such as
  893.           XDEL, TOUCH, or ATTRIB), but produces output as if the command had
  894.           executed.  This is useful for finding out what a command would do.
  895.  
  896.      /O   This allows ordering of the XDIR command. The first letter is the
  897.           primary sorting order, and following letters refine the sort.
  898.           Preceding a letter by '-' reverses the order. For symmetry '+' may
  899.           precede a letter to indicate ascending order, which is the default.
  900.           The order letters are :
  901.  
  902.               N(ame), E(xtension), D(ate and time),
  903.               S(ize), Y(*nothing*), G(file type)
  904.  
  905.           (When sorting by file type, directories are first, followed by EXE
  906.            and COM executable files, then BAT, COM and BTM batch files, and
  907.            lastly any other files.)
  908.  
  909.  
  910.  
  911.  
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.  Copyright (c) 1993 JdeBP
  929.  Documentation for OS/2 2.0 Command Line Utilities                   Page 17
  930.  
  931.      /P   The /P option has two meanings.
  932.  
  933.           For commands that change files (XDEL, TOUCH, or ATTRIB), this
  934.           disables the global prompt, and enables Yes/No prompting for
  935.           individual files. The action to be taken is displayed; pressing 'Y'
  936.           will perform the action, and 'N' will skip the file and proceed to
  937.           the next.
  938.  
  939.           For informational commands (WC, WHAT, XDIR, or FF), this causes a
  940.           prompt to be displayed at every screen full of output (or as near as
  941.           can be calculated to a screen full). Pressing [Return] will continue
  942.           for another screen, [Esc] will terminate the program, [Space] will
  943.           display another file, or [C] will enable continuous output. If
  944.           continuous output is enabled, or pausing is disabled, then pressing
  945.           [Space] will turn pausing on again.
  946.  
  947.      /R   The /R option enables overriding of READ-ONLY files for XDEL and
  948.           TOUCH. Otherwise, read-only files will be skipped. On networks you
  949.           must have permission to change file attributes if the /R option is to
  950.           be used successfully.
  951.  
  952.      /S   The /S option enables recursion into subdirectories.
  953.  
  954.      /V   The /V is normally on, and enables output. For use in batch files /V-
  955.           (along with /Y+) can disable output of individual file names, and
  956.           will just display the total number of files processed.
  957.  
  958.      /Y   The /Y (Yes) option disables the global prompt in XDEL, TOUCH, and
  959.           ATTRIB. If /Y- is used, then for each filespec on the command line
  960.           you will be prompted as to whether you wish to perform the specified
  961.           action on the files named.
  962.  
  963.           You will be reminded at the global prompt if /S, /R, or /D options
  964.           are also in effect.
  965.  
  966.  
  967.  
  968.  
  969.  
  970.  
  971.  
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  Copyright (c) 1993 JdeBP
  987.  Documentation for OS/2 2.0 Command Line Utilities                   Page 18
  988.  
  989.      Warranty and Licence
  990.      ────────────────────
  991.  
  992.      For warranty and licence conditions, see the file COPYING, which
  993.      contains my General Public Licence. These utilities are issued under the
  994.      terms of "NON-CHARGEABLE SOFTWARE".
  995.  
  996.      Although I am not demanding payment for use of these utilities, if you
  997.      find them useful (or if you send in a wish list), I hope that you feel
  998.      morally obliged to send a small (£10) donation (no foreign cheques please)
  999.      to finance their continuing development.
  1000.  
  1001.      All contributions are presently going toward purchase of IBM's OS/2 2.0
  1002.      Programmers Refence Documentation (lots of expensive Big Blue Books!) and
  1003.      CSet/2, in order that further enhancements may support other OS/2 2.0
  1004.      goodies.
  1005.  
  1006.      Credits
  1007.      ───────
  1008.  
  1009.      The utilities were written using Borland C++ for DOS version 3.0 and a
  1010.      custom version of a POSIX.1 compliant ANSI C library that works in real
  1011.      and 16-bit protected mode (also supporting 16-bit Family API applications)
  1012.      written by the author.
  1013.  
  1014.      The utilities were originally written to test the operation of that
  1015.      library, but the author's colleagues found them so useful that he has
  1016.      inflicted them on the outside world. This is why the version numbers of
  1017.      some of the utilities are so high.
  1018.  
  1019.      The library will be available early June 1993 "on all good BBSes" in
  1020.      object form as shareware. Full source licences will be available if anyone
  1021.      is interested.
  1022.  
  1023.      Many thanks to Russell Freeman, and to Philip Wray for his "intelligent
  1024.      monkey" method of program testing.
  1025.  
  1026.      Upgrades to the Utilities
  1027.      ─────────────────────────
  1028.  
  1029.      Major enhancements or fixes for major bugs will be posted as new
  1030.      versions of the utility package on The IBM OS/2 BBS and Mission Impossible
  1031.      BBS in the United Kingdom.
  1032.  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  Copyright (c) 1993 JdeBP
  1045.