home *** CD-ROM | disk | FTP | other *** search
/ POINT Software Programming / PPROG1.ISO / misc / inter41 / int2whlp / i2w-opt.txt < prev    next >
Text File  |  1994-05-28  |  3KB  |  70 lines
  1. INT2WHLP Interrupt List  -> WinHelp converter. 
  2.  
  3. Syntax is:
  4.     INT2WHLP [options] [InPath [options] [OutPath [options]]]
  5.  
  6. InPpath is the source file directory. The program will use INTERRUP.LST
  7. as the input file if it exists, or else it will use INTERRUP.A and consecutive
  8. INTERRUP.B, ..., . The files CATEGORY.KEY and OVERVIEW.LST should also be in
  9. the InPath directory. See also I2W-CFG.TXT's [WINDOWS] section.
  10.  
  11. OutPath is the output directory where the INTWIN.HPJ and *.RTF files will go.
  12. The program will request InPath and OutPath if they are not specified as
  13. parameters or in a configuration file.
  14.  
  15. Options are introduced by "-" or "/", and they are not case sensitive.
  16. On switch options of the form "-E+" or "-E-", actually only the "-" in
  17. position 3 is significant to turn the option off, "-E" alone or any other
  18. string after "E" turns the option on.
  19. Options taking an argument can optionally have a ":" after the option
  20. character, e.g. "-C:medium" or "-Cmedium".
  21. Implemented options are:
  22.     -1[+|-]        Single-entry interrupt numbers are listed directly
  23.             in the Interrupt Functions index instead of a
  24.             reference "INT nn List" if this option is enabled.
  25.             Default is disabled, for a filtered list with many
  26.             single-entry interrupts enabling is preferable.
  27.     -2[+|-]        The program can maintain two indexes, "Interrupt
  28.             Index" (all entries) and "Interrupt Functions"
  29.             (index with subindexes). -2- disables Interrupt Index.
  30.             Default is enabled.
  31.     -B[:]<build>    Inserts 'BUILD=<build>' in the HPJ file's [OPTIONS]
  32.             section if <build> is not the empty string. Don't
  33.             use any spaces in the <build> expression. Note
  34.                         that the OR operator "|" cannot be passed in an
  35.                         option because DOS interprets it as a pipe redirection.
  36.                         Use the configuration file if the OR operator is
  37.                         needed.
  38.     -C[:][arg]    Controls HCxx's Compression ratio. If no -C option
  39.             is used, compression is set to NO. If -C or -C: is
  40.             used alone, compression is set to YES. Any argument
  41.             is passed to HCxx, legal arguments are: 0, NO, OFF
  42.             for no compression, MEDIUM for medium compression,
  43.             or 1, YES, HIGH for high compression.
  44.     -E[+|-]        Controls opening of a HCxx error log file INTWIN.ERR.
  45.             Default is no error log.
  46.     -F[:]<filter>    Specifies the name of the Filter file for a partial
  47.             compilation of the Interrupt List. The filter file
  48.             must be in the InPath directory, or the path must
  49.             be given.
  50.             NOTE! It is recommended not to perform a partial
  51.             compilation because references to tables may be
  52.             missing.
  53.     -H[+|-]        Controls Headers in the Interrupt Index. If disabled,
  54.             only the entries are listed in the index. If enabled,
  55.             each new interrupt number gets a heading "INT nn".
  56.             Default is enabled. -H is ignored if -2- is
  57.             specified.
  58.     -I[:]<columns>    Specifies the number of columns in the compressed
  59.             Index. Legal values are 1, 4, 8, or 16. Default is
  60.             1.
  61.     -Q[+|-]        Controls blanks around the eQual sign in search
  62.             strings "INT nn AH = ff" or "INT nn AH=ff". Default
  63.             is blanks enabled.
  64.     -S[+|-]        Controls the Scrolling of index headers. Indexes
  65.             have a main header describing the Interrupt List,
  66.             and an individual title. If scrolling is enabled,
  67.             the title will scroll with the rest of the index,
  68.             if disabled, the title will be part of the non-
  69.             scrolling header. Scrolling is enabled by default.
  70.