home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 6 File / 06-File.zip / DHRFF.ZIP / DHRFF.DOC next >
Text File  |  1992-09-17  |  22KB  |  550 lines
  1.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  2.         Copyright (c) 1992 by Dennis H. Rosenthal
  3.         09/92
  4.  
  5.  
  6.  
  7.         Overview        Overview        Overview        ________        ________        ________
  8.  
  9.         The program DHRFF is an OS/2 command line file and directory list
  10.         and search program. In mode 0, the output matches the DIR command
  11.         output. With the proper System Setup Country Settings, the output
  12.         will match the DIR command exactly. Some of the DIR options have
  13.         been extended and corrected. Additional options are provided. In
  14.         mode 1, the output matches the RexxUtil SysFileTree output. Mode
  15.         2 is used for finding files and combines mode 1 with the /s
  16.         option. Does not operate is DOS sessions.
  17.  
  18.  
  19.         Mode 0 Operation        Mode 0 Operation        Mode 0 Operation        ________________        ________________        ________________
  20.  
  21.         The DHRFF program in mode 0 matches the output of the DIR com-
  22.         mand, corrects some DIR problems, and for large displays is
  23.         faster than DIR.
  24.  
  25.         DIR functions supported -
  26.  
  27.           All including the undocumented (in OS/2) 'set DIRCMD='
  28.           Most error messages extracted from the same system message file
  29.             used by DIR
  30.  
  31.         DIR improvements -
  32.  
  33.           Sort options work with large directories (max 20,000 files, tested
  34.             on a subdirectory with over 10,000 files - DIR just closes the
  35.             session)
  36.           Option /a includes option to show files that have EAs
  37.           Option /r works in OS/2 command environment showing long names for
  38.             FAT or HPFS files
  39.           Option to show access date-time and creation date-time along with
  40.             the standard write date-time for HPFS files
  41.           Option to show file attributes (system, hidden, read only, etc.)
  42.           Option to show EA names
  43.           Option to select files by date-time range
  44.           Option to create file
  45.           Option to turn off console display
  46.           Complies with code page and system setup country settings for date
  47.             and time formats
  48.           Eliminates trailing spaces on output with the /w option
  49.  
  50.  
  51.         Mode 1 Operation        Mode 1 Operation        Mode 1 Operation        ________________        ________________        ________________
  52.  
  53.         The DHRFF program in mode 1 matches the output format of the
  54.         RexxUtil SysFileTree, extends options, and corrects some SysFile-
  55.         Tree problems.
  56.  
  57.           Corrects time format between midnight and 1 AM
  58.             (SysFileTree formats time as 00:04a instead of 12:04a)
  59.  
  60.  
  61.                                         1
  62.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  63.         Copyright (c) 1992 by Dennis H. Rosenthal
  64.         09/92
  65.  
  66.  
  67.  
  68.           Complies with code page and system setup country settings for date
  69.             and time formats
  70.           Finds all files
  71.             (SysFileTree uses 32 bit functions which do not find
  72.                 subdirectories with leading spaces at this time)
  73.           Allows complete specification of attributes with /a options just
  74.             like DIR - default is to show files including directories, use -
  75.             /af to show just files
  76.             /ad to show just directories
  77.           Supports sorting within subdirectories like DIR
  78.  
  79.  
  80.         Command Syntax        Command Syntax        Command Syntax        ______________        ______________        ______________
  81.  
  82.         DHRFF [Options] [Disk:][Starting Directory\][File Selection] [...]
  83.  
  84.         [Options] - Optional parameters to control output. See below.
  85.             Options may appear anywhere on the command line, before, after,
  86.             or before and after the file information.
  87.         [Disk] - Optional Drive Letter. Specify as d...d: where d is
  88.             one or more drive letters - Or ?: to search all drives
  89.             starting with the C drive.
  90.         [Starting Directory] - Optional fully qualified directory where
  91.             search is to start.
  92.         [File Selection] - Optional file selection criterion using
  93.             standard DOS-OS/2 format including * and ?.
  94.         [...] - The [Disk:][Starting Directory\][File Selection] combination
  95.             may be repeated
  96.  
  97.  
  98.         Command Line Options        Command Line Options        Command Line Options        ____________________        ____________________        ____________________
  99.  
  100.          /a:... - Select All Files Unless Followed By -
  101.               a - Select Only Archived (Modified) Files
  102.              -a - Select No Archived (Modified) Files
  103.               d - Select Only Directories
  104.              -d - Select No Directories
  105.               e - Select Only Files or Directories with Extended Attributes **
  106.              -e - Select No Files or Directories with Extended Attributes **
  107.               h - Select Only Hidden Files
  108.              -h - Select No Hidden Files
  109.               r - Select Only Read Only Files
  110.              -r - Select No Read Only Files
  111.               s - Select Only System Files
  112.              -s - Select No System Files
  113.          /b - Display files without heading and summary
  114.          /f - Display Fully Qualified File Names Only
  115.          /p - Pause on full screen
  116.          /s - Process Subdirectories
  117.          /l - Display file names in lower case
  118.          /n - Display files on FAT disks in HPFS format
  119.          /o... - Sort display by specified fields
  120.  
  121.  
  122.                                         2
  123.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  124.         Copyright (c) 1992 by Dennis H. Rosenthal
  125.         09/92
  126.  
  127.  
  128.  
  129.               n - File name and type with A first
  130.              -n - File name and type with A last
  131.               e - File type with A first
  132.              -e - File type with A last
  133.               d - Date and Time - most recent last
  134.              -d - Date and Time - most recent first
  135.               s - Size - smallest first
  136.              -s - Size - largest first
  137.               g - Directories first
  138.              -g - Directories last
  139.          /r - Display long file names
  140.          /w - Display files in multiple columns
  141.  
  142.         Those items above marked with ** are extensions and the following
  143.         are extensions -
  144.  
  145.          /d - Select file by date (see below)
  146.                 - /d[,=,g,l]YYMMDDHHMM[-YYMMDDHHMM]
  147.          /k - Create DAT File with Directory and File Information in
  148.                  RexxUtil format
  149.          /e - Show EA Names
  150.          /t - Show Attribute Information
  151.          /j - Display Access Date and Creation Date for files on HPFS disks
  152.          /v - Suppress Video Display
  153.          /0 - Mode 0 Selection, OS/2 DIR like display (default)
  154.          /1 - Mode 1 Selection, RexxUtil SysFileTree like display
  155.          /2 - Mode 2 Selection, Mode 1 plus /s for file name searching
  156.          /? - Display List of Options
  157.  
  158.  
  159.         Date Selection        Date Selection        Date Selection        ______________        ______________        ______________
  160.  
  161.         The /d option is used to select files based on write date-time. A
  162.         single date-time may be entered in the format YYMMDDHHMM (year-
  163.         month-day-hour-minute) along with an '=', 'G', or 'L' to indicate
  164.         comparison type. The '=' indicates that all selected files must
  165.         match the entered date-time. The 'G' indicates that all selected
  166.         files must have a date-time that is greater than the entered
  167.         date-time. The 'L' indicates that all selected files must have a
  168.         date-time that is less than the entered date-time. The default is
  169.         '=' and does not have to be entered. The complete date-time also
  170.         does not have to be entered. Examples -
  171.  
  172.          /d910101 or /d=910101 - select files with date of 01/01/91
  173.          /dg910101 - select files with date greater than 01/01/91
  174.          /dl910101 - select files with date less than 01/01/91
  175.          /d9101 - select file with the year and month equal to 01/??/91
  176.          /d91 - select file with the year equal to ??/??/91
  177.          /d9101010101 - select files with date of 01/01/91 and time of 01:01a
  178.  
  179.         The /d option also supports a date range /d9101010101-9104010101.
  180.         The date range is inclusive. Examples -
  181.  
  182.  
  183.                                         3
  184.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  185.         Copyright (c) 1992 by Dennis H. Rosenthal
  186.         09/92
  187.  
  188.  
  189.  
  190.  
  191.          /d91-/92 - select files with year >= 91 and <= 92
  192.          /d9108-/92 - select files with date >= 08/??/91 and <= 92
  193.          /d920804-/920903 - select files with date >= 08/04/92 and <= 09/03/92
  194.  
  195.         Multiple dates may be entered. Any file date that matches any
  196.         date entered will be selected. Example -
  197.  
  198.          /d920904 /d920901 - select file with date 09/04/92 or 09/01/92
  199.  
  200.  
  201.         Set DIRCMD        Set DIRCMD        Set DIRCMD        __________        __________        __________
  202.  
  203.         The 'Set DIRCMD=' environment variable is supported. Values set
  204.         in the environment are processed before command line options.
  205.         Command line options may override environment options. The DHRFF
  206.         program also looks for the environment variable XDIRCMD. It will
  207.         be used in place of the DIRCMD values if found. Example -
  208.  
  209.         set DIRCMD=/n - DIR or DHRFF will always show files in HPFS
  210.                         format even on FAT disks.
  211.         set XDIRCMD=/os - DHRFF will sort files in size sequence before
  212.                         display. The DIRCMD setting will be ignored.
  213.  
  214.  
  215.         Date and Time Display        Date and Time Display        Date and Time Display        _____________________        _____________________        _____________________
  216.  
  217.         The display of dates and times by DHRFF are controlled by the
  218.         values specified in the codepage selection in CONFIG.SYS and the
  219.         customized values set in the Country Settings panel which is
  220.         found in the System Setup folder. Dates may appear in the format
  221.         Month-Day-Year, Day-Month-Year, or Year-Month-Day. The separator
  222.         may also be customized (-, /, etc.). Times may appear in 12 hour
  223.         or 24 hour format. The 12 hour format may additionally have AM or
  224.         PM appended (upper or lower case). The hour - minute separator
  225.         may also be customized.
  226.  
  227.  
  228.         Data File Format        Data File Format        Data File Format        ________________        ________________        ________________
  229.  
  230.         The /k option will create a file in RexxUtil SysFileTree format.
  231.         The file name will match the program name (DHRFF unless renamed,
  232.         and a max of 8 characters) with a file type of DAT. Each line
  233.         contains the date (MM/DD/YY), time (HH:MMx), file size, file
  234.         attributes (ADHRS), and fully qualified file name. The format of
  235.         the date and time are not adjustable. Example data -
  236.  
  237.          8/14/92   2:37p           0  -D---  G:\OS2PGMS\IBMC\...\X-X-X-X
  238.          9/07/92   4:18p       11135  -----  G:\OS2PGMS\IBMC\...\DECPARM.C
  239.          8/31/92   2:47p       57477  -----  G:\OS2PGMS\IBMC\...\DHRCMP.EXE
  240.  
  241.         In a REXX file, the RXQUEUE command may be used to send the
  242.  
  243.  
  244.                                         4
  245.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  246.         Copyright (c) 1992 by Dennis H. Rosenthal
  247.         09/92
  248.  
  249.  
  250.  
  251.         output of the program to the REXX stack for processing -
  252.  
  253.         DHRFF /2 \*.EXE | RXQUEUE
  254.         dirstem.0 = queued()
  255.         do dir_ctr = 1 to dirstem.0
  256.              pull dirstem.dir_ctr
  257.         end
  258.  
  259.  
  260.         Limitations        Limitations        Limitations        ___________        ___________        ___________
  261.  
  262.         DHRFF is not perfect. Although this program could replace the DIR
  263.         command completely, I would not recommend it. For small displays
  264.         the program load time is longer than the DIR display time. For
  265.         small sort requests, DIR is faster as it appears to insert each
  266.         new entry into a linked list according to sort sequence rather
  267.         than load and sort as is done in DHRFF.
  268.  
  269.  
  270.         Copyright and Disclaimer        Copyright and Disclaimer        Copyright and Disclaimer        ________________________        ________________________        ________________________
  271.  
  272.         The program DHRFF.EXE is placed in the public domain. The program
  273.         and this documentation are
  274.           Copyright (c) 1992 by Dennis H. Rosenthal,
  275.         the author. You may copy and distribute the program and
  276.         documentation without restriction.
  277.  
  278.         The program DHRFF.EXE is distributed as is, with no guarantee
  279.         that it will work correctly in all situations.  In no event will
  280.         the Author be liable for any damages whatsoever, including,
  281.         without limitation, loss of profit, loss of information, or
  282.         special, incidental, or consequential damages or other similar
  283.         claims, arising out of the use of or inability to use this
  284.         program, even if the Author has been advised of the possibility
  285.         of such damages, or for any claim by any other party.
  286.  
  287.         The DHRFF program is written entirely in C and compiled with the
  288.         IBM C Set/2 compiler. The source is available for a fee. I may be
  289.         contacted via CompuServe ID 75176,3003 or via mail -
  290.  
  291.         Dennis H. Rosenthal
  292.         417 Hialeah Drive
  293.         Cherry Hill, NJ 08002
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.                                         5
  306.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  307.         Copyright (c) 1992 by Dennis H. Rosenthal
  308.         09/92
  309.  
  310.  
  311.  
  312.         Examples        Examples        Examples        ________        ________        ________
  313.  
  314.  
  315.         DHRFF dhrff.exe        DHRFF dhrff.exe        DHRFF dhrff.exe
  316.  
  317.              Displays the dhrff.exe in the current directory exactly like
  318.         the DIR command -
  319.  
  320.          The volume label in drive G is FDISKG.
  321.          The Volume Serial Number is A4BB:7814
  322.          Directory of G:\OS2PGMS\IBMC\WKFRAME\DHRFF
  323.  
  324.         DHRFF    EXE    68096   9-14-92   3:37p
  325.                  1 file(s)      68096 bytes used
  326.                              35749888 bytes free
  327.  
  328.  
  329.         DHRFF /s /ae /n \        DHRFF /s /ae /n \        DHRFF /s /ae /n \
  330.  
  331.              Displays all files on the current disk that have extended
  332.         attributes. Display is in HPFS format to show EA size -
  333.  
  334.          The volume label in drive D is OS2.
  335.          The Volume Serial Number is A561:C014
  336.  
  337.          Directory of D:\
  338.  
  339.          7-01-92   9:21p     <DIR>         296  NOWHERE
  340.          7-01-92   9:21p     <DIR>        1116  OS!2_2.0_D
  341.          3-30-92  12:00p    716044          49  OS2KRNL
  342.          7-04-92  11:56p        94         402  DHRRU100.CMD
  343.                  4 file(s)     716138 bytes used
  344.  
  345.          Directory of D:\OS2
  346.  
  347.          3-30-92  12:00p      5655          53  ANSI.EXE
  348.          3-30-92  12:00p     36765          53  ATTRIB.EXE
  349.          3-30-92  12:00p     83433          53  BACKUP.EXE
  350.          ...
  351.  
  352.          Directory of D:\OS!2_2.0_D\PGM_TOOL\TOOLKIT\SAMPLE_P
  353.  
  354.          7-03-92  10:58a       416        3755  WP_CAR_S
  355.                  1 file(s)        416 bytes used
  356.  
  357.         Total files listed:
  358.                299 file(s)   13680450 bytes used
  359.                              12304384 bytes free
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.                                         6
  367.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  368.         Copyright (c) 1992 by Dennis H. Rosenthal
  369.         09/92
  370.  
  371.  
  372.  
  373.         DHRFF /t /a        DHRFF /t /a        DHRFF /t /a
  374.  
  375.              Displays all files in current directory in DIR format along
  376.         with attribute information. The attribute information shows a
  377.         letter or a dash indicating the status of the attribute for the
  378.         file - ADHRS indicates Archive, Directory, Hidden, Read Only, and
  379.         System -
  380.  
  381.           The volume label in drive D is OS2.
  382.           The Volume Serial Number is A561:C014
  383.           Directory of D:\
  384.  
  385.          NOWHERE      <DIR>      7-01-92   9:21p -D---
  386.          OS2          <DIR>      7-01-92   8:47p -D---
  387.          OS!2_2   0_D <DIR>      7-01-92   9:21p -D---
  388.          PSFONTS      <DIR>      7-01-92   8:57p -D---
  389.          SPOOL        <DIR>      7-01-92   9:20p -D---
  390.          OS2BOOT          1099   7-01-92   8:55p --HRS
  391.          OS2KRNL        716044   3-30-92  12:00p --HRS
  392.          OS2LDR          32256   3-30-92  12:00p --HRS
  393.          EA DATA   SF   917504   7-01-92   8:47p A-HRS
  394.          WP ROOT   SF      264   9-15-92   9:40a A-H-S
  395.          ...
  396.                  26 file(s)    1784977 bytes used
  397.                               12304384 bytes free
  398.  
  399.  
  400.         DHRFF /e /s \*.cmd        DHRFF /e /s \*.cmd        DHRFF /e /s \*.cmd
  401.  
  402.              Displays all CMD files on the current disk along with ex-
  403.         tended attribute information. Names appear on a separate line
  404.         which includes EA value length and length of name -
  405.  
  406.           The volume label in drive D is OS2.
  407.           The Volume Serial Number is A561:C014
  408.  
  409.           Directory of D:\
  410.  
  411.          ATTR1    CMD      123   7-07-92  10:18a
  412.          ATTR2    CMD      145   7-07-92  10:18a
  413.          DHRRU100 CMD       94   7-04-92  11:56p
  414.           EA Value Length    68, Name - (16)REXX.METACONTROL
  415.           EA Value Length    91, Name - (16)REXX.LITERALPOOL
  416.           EA Value Length    53, Name - (16)REXX.VARIABLEBUF
  417.           EA Value Length   102, Name - (16)REXX.TOKENSIMAGE
  418.                   3 file(s)        362 bytes used
  419.          ...
  420.          Total files listed:
  421.                  54 file(s)     359924 bytes used
  422.                               12304384 bytes free
  423.  
  424.  
  425.  
  426.  
  427.                                         7
  428.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  429.         Copyright (c) 1992 by Dennis H. Rosenthal
  430.         09/92
  431.  
  432.  
  433.  
  434.  
  435.         DHRFF /1 /s /ae /n \   or   DHRFF /2 /ae /n \        DHRFF /1 /s /ae /n \   or   DHRFF /2 /ae /n \        DHRFF /1 /s /ae /n \   or   DHRFF /2 /ae /n \
  436.  
  437.              Displays all files on the current disk that have extended
  438.         attributes in RexxUtil SysFileTree format -
  439.  
  440.          7/01/92   9:21p           0  -D---    296  D:\NOWHERE
  441.          7/01/92   9:21p           0  -D---   1116  D:\OS!2_2.0_D
  442.          3/30/92  12:00p      716044  --HRS     49  D:\OS2KRNL
  443.          7/04/92  11:56p          94  -----    402  D:\DHRRU100.CMD
  444.          3/30/92  12:00p        5655  -----     53  D:\OS2\ANSI.EXE
  445.          3/30/92  12:00p       36765  -----     53  D:\OS2\ATTRIB.EXE
  446.          3/30/92  12:00p       83433  -----     53  D:\OS2\BACKUP.EXE
  447.          3/30/92  12:00p       40951  -----     53  D:\OS2\DISKCOMP.COM
  448.          3/30/92  12:00p       45108  -----     53  D:\OS2\DISKCOPY.COM
  449.          3/30/92  12:00p       71442  -----   3542  D:\OS2\E.EXE
  450.          ...
  451.  
  452.  
  453.         DHRFF /2 /j \*.exe        DHRFF /2 /j \*.exe        DHRFF /2 /j \*.exe
  454.  
  455.              Displays all EXE files on the current disk along with the
  456.         last access date and creation date (HPFS disks only) in RexxUtil
  457.         format -
  458.  
  459.          3/30/92  12:00p        5655  -----  ( 8/11/92 10:49a) ( 7/11/92 11:41a)
  460.         I:\OS2\ANSI.EXE
  461.          3/30/92  12:00p       36765  -----  ( 8/11/92 10:49a) ( 7/11/92 12:06p)
  462.         I:\OS2\ATTRIB.EXE
  463.          ...
  464.          3/30/92  12:00p       14436  -----  ( 8/11/92 10:53a) ( 7/11/92 11:42a)
  465.         I:\OS2\SYSTEM\HARDERR.EXE
  466.          3/30/92  12:00p       15360  -----  ( 8/11/92 10:53a) ( 7/11/92 11:54a)
  467.         I:\OS2\SYSTEM\LOGDAEM.EXE
  468.  
  469.  
  470.         DHRFF /2 ?:\CD*.SYS        DHRFF /2 ?:\CD*.SYS        DHRFF /2 ?:\CD*.SYS
  471.  
  472.              Displays all files that begin with CD and have a file type
  473.         of SYS. The ?: will search all hard disks -
  474.  
  475.           3/30/92  12:00p       21556  -----  D:\OS2\CDROM.SYS
  476.           3/30/92  12:00p       21556  -----  I:\OS2\CDROM.SYS
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.                                         8
  489.         DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation        DHRFF Version 1.00 Documentation
  490.         Copyright (c) 1992 by Dennis H. Rosenthal
  491.         09/92
  492.  
  493.  
  494.  
  495.         OS/2 functions called by DHRFF        OS/2 functions called by DHRFF        OS/2 functions called by DHRFF        ______________________________        ______________________________        ______________________________
  496.  
  497.             Dos16FindFirst2, Dos16FindNext, Dos16FindClose
  498.                 The 32 bit DosFindFirst, DosFindNext functions do not
  499.                 find subdirectories with leading spaces. The 16 bit
  500.                 functions work properly.
  501.             DosAllocMem
  502.             DosEnumAttribute
  503.             DosFreeMem
  504.             DosGetDateTime
  505.             DosGetMessage
  506.             DosQueryCtryInfo
  507.             DosQueryCurrentDisk
  508.             DosQueryFSAttach
  509.             DosQueryFSInfo
  510.             DosQueryPathInfo
  511.             DosQuerySysInfo
  512.             DosScanEnv
  513.             KbdCharIn
  514.             KbdFlushBuffer
  515.             KbdGetStatus
  516.             KbdSetStatus
  517.             PrfQueryProfileData
  518.             VioGetMode
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.                                         9
  550.