home *** CD-ROM | disk | FTP | other *** search
/ Phoenix CD 2.0 / Phoenix_CD.cdr / 24b / headers.zip / HEADERS.DOC next >
Text File  |  1986-04-28  |  9KB  |  258 lines
  1.           Version 4.01 HEADERS - Operating Instructions
  2.  
  3.  
  4. HEADERS.EXE  is a compiled Modular BASIC program and runs  on  an 
  5. IBM PC/XT/AT under PC-DOS 2.10,  3.00, 3.10, or 3.20.  Unless you 
  6. have  a large amount of memory dedicated to resident software  or 
  7. RAM disks, you should be able to run this program in 128K of RAM.
  8.  
  9. The program prints ASCII text files in a variety of formats.  The 
  10. printer  must  be  an  IBM Personal Computer  Matrix  Printer  or 
  11. Graphics Printer.   The Graphics Printer is required only for the 
  12. high-density formats (lines per page > 88). 
  13.  
  14. The intended use of HEADERS is to produce listings of source code 
  15. files (programs) and other ASCII data files.   It is not intended 
  16. to  support the printing of files which have embedded form  feeds 
  17. or existing headers.
  18.  
  19. The  program  was  called HEADERS because  it  allows  customized 
  20. headers  to be placed at the top of each page.   As you will  see 
  21. below, many other options are also available.
  22.  
  23.  
  24.                        Header Line Format
  25.  
  26. HEADERS  will produce a header at the top of each page if you use 
  27. the  DOS  "SET" command to assign strings to HEADER1  or  HEADER2 
  28. before  running  the program.   The string  assigned  to  HEADER1 
  29. determines what will appear on the left-hand side of the heading, 
  30. and  HEADER2 the middle part of the heading.   If you set  either 
  31. HEADER1 or HEADER2 (or both),  the right-hand side of the heading 
  32. will contain the name of the file being printed and a pagenumber.
  33.  
  34. No  heading  is  produced if both HEADER1 and HEADER2  are  empty 
  35. strings.
  36.  
  37. Typical use of the SET command might be:
  38.  
  39.   SET HEADER1=April 28, 1986
  40.   SET HEADER2=(C) Copyright 1986 by John & Mary Doe
  41.  
  42. You  can also use special strings to set HEADER1 so that  HEADERS 
  43. will supply the current date or time (or both).   The formats are 
  44. shown below:
  45.  
  46.   SET HEADER1=DATE
  47.   SET HEADER1=TIME
  48.   SET HEADER1=DATE,TIME
  49.   SET HEADER1=TIME,DATE
  50.  
  51. Note  that  the values you set for HEADER1 and HEADER2 remain  in 
  52. effect until you change them (or reboot).
  53.  
  54.  
  55.                          COMMAND LINE FORMAT
  56.  
  57. HEADERS FileSpec [/ Option [,Option]...] 
  58.  
  59. FileSpec is used to specify the input file.  FileSpec may contain 
  60. a drive specification and path specification.  Output always goes 
  61. to the printer named "LPT1:".
  62.  
  63. If  you type simply "HEADERS" (with no arguments) you will get  a 
  64. command summary displayed on your screen.
  65.  
  66. Option may assume any of the formats below.
  67.  
  68.    W=www       Width of page (characters per line) 
  69.    L=lll       Left margin size
  70.    R=rrr       Right margin size
  71.    H=hhh       Height of page (lines per page)
  72.    G=ggg       Gap between pages
  73.    S=sss       Spacing of lines
  74.    B=bbb       Beginning page
  75.    E=eee       Ending page
  76.    D           Double strike
  77.  
  78.  
  79.                           WIDTH OF PAGE 
  80.  
  81. Page width is specified with the option "W=www".   The "www" must 
  82. be one of the numbers 40,  66, 80, or 132.  If this option is not 
  83. used, HEADERS assumes a default of W=80.
  84.  
  85.  
  86.                         LEFT MARGIN SIZE
  87.  
  88. Margin size is specified with the option "L=lll".  The "lll" must 
  89. be  a non-negative number smaller than the page width.   If  this 
  90. option is not used, HEADERS assumes a default of L=0.
  91.  
  92. Note that a non-zero value must be specified to take advantage of 
  93. HEADERS's capability to handle input lines which are longer  than 
  94. the  selected  page width.   If left margin size  is  0,  HEADERS 
  95. simply truncates long lines to the page width.   If a margin size 
  96. greater  than 0 exists,  HEADERS will print "continuation"  lines 
  97. which  are  recogized by the occurrence of a vertical bar "|"  in 
  98. the left margin.
  99.  
  100.  
  101.                         RIGHT MARGIN SIZE
  102.  
  103. The  size  of the right-hand margin is specified with the  option 
  104. "R=rrr".   The  "rrr" must be a non-negative number smaller  than 
  105. the page width.   If this option is not used,  HEADERS assumes  a 
  106. default of R=0.
  107.  
  108. NOTE:  For  obvious reasons,  the sum of the left-hand and right-
  109. hand margins must be less than the page width.  
  110.  
  111.  
  112.                          HEIGHT OF PAGE
  113.  
  114. Page height is specified with the option "H=hhh".  The "hhh" must 
  115. be one of the numbers 11,  22,  33,  44, 66, 88, 99, 108, 132, or 
  116. 165.   A  graphics printer is required for page heights 99,  108, 
  117. 132,  or  165.   If this option is not used,  HEADERS  assumes  a 
  118. default of H=66.
  119.  
  120.  
  121.                         GAP BETWEEN PAGES
  122.  
  123. Interpage  gap is specified with the option "G=ggg".   The  "ggg" 
  124. must  be a non-negative number smaller than the page height.   If 
  125. this  option is not used,  HEADERS sets the page gap to the  page 
  126. height divided by 11 (discarding any remainder).
  127.  
  128.  
  129.                              SPACING 
  130.  
  131. Spacing (of lines) is specified with the option  "S=sss".  Single 
  132. spacing  is obtained if sss = 1,  double spacing if sss= 2,  etc.  
  133. If this option is not used, HEADERS assumes a default of S=1.
  134.  
  135.  
  136.                          BEGINNING PAGE
  137.  
  138. The page number of the first page to be printed is specified with 
  139. the  option "B=bbb",  where "bbb" is a non-negative  number.   If 
  140. this option is not used, HEADERS assumes a default of B=1.
  141.  
  142.  
  143.                            ENDING PAGE
  144.  
  145. The page number of the last page to be printed is specified  with 
  146. the  option "E=eee",  where "eee" is a non-negative  number.   If 
  147. this option is not used, HEADERS assumes a default of E=32767.
  148.  
  149.  
  150.                           DOUBLE STRIKE
  151.  
  152. Double strike is specified with the option "D".  Double strike is 
  153. used  automatically for page heights of 99,  108,  132,  or  165.  
  154. Otherwise, double strike is used only if you use the "D" option.
  155.  
  156.  
  157.                        Other Documentation
  158.  
  159. Detailed  information on this program can be obtained by  reading 
  160. the Modular BASIC source code (HEADERS.MB).
  161.  
  162.  
  163.  
  164.                       Sample Command Lines
  165.  
  166. HEADERS SAMPLE.TXT
  167.  
  168.    Prints SAMPLE.TXT using all of HEADER's defaults.  This is the 
  169.    same as the command:
  170.  
  171.    HEADERS SAMPLE.TXT/W=80,L=0,R=0,H=66,G=6,S=1,B=1,E=32767
  172.  
  173.    Lines longer that 80 characters are truncated.  Left and right 
  174.    margins  are not used.   60 lines of text are printed per page 
  175.    with  an interpage gap of 6 lines.   Lines are  printed  using 
  176.    single-spacing   (no  blank  lines  between  lines  of  text).   
  177.    Double-strike is not used.
  178.  
  179.  
  180. HEADERS SAMPLE.TXT/L=4,R=4,D
  181.  
  182.    This is the same as the command:
  183.  
  184.    HEADERS SAMPLE.TXT/W=80,L=4,R=4,H=66,G=6,S=1,B=1,E=32767,D
  185.  
  186.    Lines   longer   than   72  (80-4-4)  characters   result   in 
  187.    continuation lines being printed.   The left and right  margin 
  188.    are  each 4 columns wide.   60 lines of text are  printed  per 
  189.    page with an interpage gap of 6 lines.   The lines are single-
  190.    spaced and printed using double-strike.  
  191.  
  192.  
  193. HEADERS SAMPLE.TXT/L=4,R=4,D,B=4,E=7
  194.  
  195.    This is the same as the command above,  except that only pages 
  196.    4, 5, 6, and 7 will be printed. 
  197.  
  198.  
  199. HEADERS SAMPLE.TXT/W=132,L=20,R=32,H=88,S=2
  200.  
  201.    This is the same as the command:
  202.      
  203.    HEADERS SAMPLE.TXT/W=132,L=20,R=32,H=88,G=8,S=2,B=1,E=32767
  204.  
  205.    Lines   longer  than  80  (132-20-32)  characters  result   in 
  206.    continuation  lines being printed.  The left margin will be 20 
  207.    columns,  and the right margin will be 32 columns.  There will 
  208.    be 80 (88-8) printed lines per page with an interpage gap of 8 
  209.    lines.  40  of the lines printed will be blank because double-
  210.    spacing is requested (one blank line between lines of text).  
  211.  
  212.                         
  213. HEADERS SAMPLE.TXT /W=132,L=4,R=8,H=165,G=15
  214.  
  215.    This  command will generate 150 (165-15) lines per  page  with 
  216.    120 (132-4-8) characters printed per line.  The left margin is 
  217.    4  columns wide and the right margin 8 columns.   Continuation 
  218.    lines are used for lines containing more than 120 characters.
  219.  
  220.  
  221. Suggestion:   Unless  you have already printed this document  and 
  222. HEADERS.MB,  use  HEADERS  to do so.   This can be done with  the 
  223. following commands:
  224.  
  225.     SET HEADER1=DATE,TIME
  226.     SET HEADER2=Public Domain Software
  227.     HEADERS HEADERS.DOC/L=5,R=10
  228.     HEADERS HEADERS.MB/W=132,L=16,R=36,H=88
  229.  
  230. If your printer ribbon is getting used up, you can append ",D" to 
  231. the  end  of  each  HEADERS command to  get  a  better  printout.  
  232. Remember,  though, double-strike printing takes twice as long, so 
  233. use it only if a high-quality listing is required.
  234.  
  235.    NOTE: Double-strike is automatically used is you select a page 
  236.    height  greater  than 88 lines per page (assuming you  have  a 
  237.    Graphics  Printer).   The double-strike is done by the printer 
  238.    itself and not by the HEADERS program.
  239.  
  240.  
  241. It  is relatively easy to set up batch files which contain  fixed 
  242. options you use frequently.
  243.  
  244.  
  245.                              Payment
  246.  
  247. There is no fee or license associated with this program.   It  is 
  248. being placed in the Public Domain to be used as you see fit.
  249.  
  250.  
  251. If you have problems with this program, contact:
  252.  
  253.                          software, etc.
  254.                          P.O. Box 25469
  255.                          Rochester NY 14625
  256.  
  257.                          (716) 671-8311
  258.