home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / snap312.zip / SNAP.HLP < prev    next >
Text File  |  1988-07-01  |  33KB  |  699 lines

  1. 1.1    General Help
  2. This is some general help.
  3. !
  4. 2.1    System Name
  5. Enter the name of the system you wish to document.  This name is used
  6. in the program file heading and on the source code listings. If you do
  7. not choose to write file headings or print source code, you may omit
  8. this field.
  9. !
  10. 2.2    Author
  11. Enter the name of the system author.  This name is used in the program
  12. file heading and on the source code listings.  If you do not choose
  13. to write file headings or print source code, you may omit this field.
  14. !
  15. 2.3    Copyright Holder
  16. Enter the name of the copyright holder, or leave blank if the author 
  17. holds the copyright.  This name is used in the program file heading
  18. and on the source code listings.  If you do not choose to write file
  19. headings or print source code, you may omit this field.
  20. !
  21. 2.4    Copyright Date
  22. Enter the copyright date.  This date is used in the program file
  23. heading and the source code listing.  If you choose not to write file
  24. headings or print source code, you may omit this field.
  25. !
  26. 2.5    Top File Name
  27. Input the first filename you wish to document.  Do not enter a drive
  28. designation or a path.  File extensions are optional (.PRG assumed if
  29. no extension entered).  If you wish to document an entire dBASE
  30. system, this file should be the "top" file in the system.
  31.  
  32. If this field is blank or if the filename you enter does not exist,
  33. in the source directory, SNAP! will reposition the cursor on this field.
  34. You cannot begin documentation until this file is found.
  35. !
  36. 2.6   Path for Source Code Files
  37. Enter the path for your system's source code files.   Your entry
  38. should begin with a backslash ('\') but should not end with one.  For
  39. example, if your programs are in a directory called DBASE\SOURCE, you
  40. would enter the following:
  41.    Path to source code files: \DBASE\SOURCE
  42. Snap! will execute a CHDIR command to make this directory the default
  43. directory.  All files except databases and indexes MUST be in this
  44. subdirectory for SNAP! to find them.
  45. !
  46. 2.7   Path for Data Files
  47. Enter the path for your system's database and index files.   Your entry
  48. should begin with a backslash ('\') but should not end with one.  For
  49. example, if your data files are in a directory called DBASE\SOURCE, you
  50. would enter the following:
  51.    Path to data files: \DBASE\SOURCE
  52. SNAP! also searches the program directory for these files if they are
  53. not in the data directory.
  54. !
  55. 2.8   Path for Output Files
  56. Enter the path for SNAP! documentation.   Your entry should begin
  57. with a backslash ('\') but should not end with one.  For example, if
  58. you want output routed to a directory called C:\DBASE\OUTPUT, you would
  59. enter the following:
  60.  
  61.    Path for output files: C:\DBASE\OUTPUT
  62. !
  63. 2.9   Path for SNAP! Files 
  64. Enter the path for SNAP! help files and keywords.  If SNAP! is in the
  65. current directory, simply press the enter key.  Otherwise, enter the
  66. path to the directory in which SNAP! resides.  Your entry should
  67. begin with a backslash ('\') but should not end with one.  For
  68. example, if SNAP! is in a directory called DBASE\SNAP, you would
  69. enter the following:
  70.  
  71.    Path to SNAP! Files: \DBASE\SNAP
  72. !
  73. 3.1    Write Program Tree Structure?
  74. Choose "Y" to display and echo to a file a diagram of the system tree
  75. structure, showing which programs call which other programs, and
  76. which programs use which databases.  The diagram also indicates which
  77. "programs" are dBASE III procedures.
  78. !
  79. 3.2    Write List of Files Used in System
  80. Choose "Y" to display and echo to a file a list of all files used in
  81. the system.  This report shows programs, databases, index files,
  82. report forms, format files, memory files, and procedures.  You might
  83. use such a report to identify all the files in a subdirectory that
  84. your application uses.
  85. !
  86. 3.3    Write Index File Summary?
  87. Choose "Y" to display and echo to a file a summary of index files
  88. used in the system.  SNAP! watches for references to indexes
  89. within your programs and will prepare a report showing the index file
  90. name, the fields on which it is indexed, and the program files that
  91. use it.
  92. !
  93. 3.4    Write Database Summary and Data Dictionary?
  94. Choose "Y" to display and echo to a file a database summary and data
  95. dictionary, showing each field in the system and the databases
  96. containing it.  The data dictionary also highlights the links among
  97. your databases.  In addition to the data dictionary, this option
  98. displays a list of each database used in the system, the database
  99. structure, and a list of program files which use the database.
  100. !
  101. 3.5    Write Format File Summary?
  102. Choose "Y" to display and echo to a file a summary of format files
  103. used in the system.  SNAP! watches for references to format files
  104. within your programs and will prepare a report showing the format
  105. file name and the program files that use it.
  106. !
  107. 3.6    Write Report Form Summary?
  108. Choose "Y" to display and echo to a file a summary of report forms
  109. used in the system.  SNAP! watches for references to report forms
  110. within your programs and will prepare a report showing the report
  111. form name and the program files that use it.
  112. !
  113. 3.7   Write Procedure Summary?
  114. Choose "Y" to display and echo to a file a summary of procedures used
  115. in the system.  SNAP! watches for references to procedures within
  116. your programs and will prepare a report showing the procedure name,
  117. the individual procedures it contains and the program files that use
  118. it.  This report does not show procedures within program files, as is
  119. allowed by Clipper.
  120. !
  121. 3.8   Write Label Summary?
  122. Choose "Y" to display and echo to a file a summary of label forms
  123. used in the system.  SNAP! watches for references to label forms
  124. within your programs and will prepare a report showing the label
  125. form name and the program files that use it.
  126. !
  127. 3.9   Write Binary Summary?
  128. Choose "Y" to display and echo to a file a summary of binary files
  129. used in the system.  SNAP! watches for references to binary files
  130. within your programs and will prepare a report showing the binary
  131. file name and the program files that use it.
  132. !
  133. 3.10    Write Variable Cross Reference?
  134. Choose "Y" to display and echo to a file a cross reference of all
  135. words in the system that are not key words, quoted strings or numeric
  136. constants.  This report provides system-wide documentation of each
  137. program and program line that references a memory variable, file
  138. name, field, and so forth.  You can also 1) include selected key
  139. words in this report by prefacing them with an at sign (@) in the key
  140. word file, or 2) exclude memory variables by adding them temporarily
  141. to the key word file.  SNAP! is limited to 1000 individual variables.
  142. !
  143. 3.11    Write a PLINK86 LNK File for Clipper Applications
  144. Choose "Y" to create a LNK file for Clipper applications.  The
  145. PLINK86 linker can use a "filename.LNK" file for indirect input of
  146. commands. This option will create a LNK file to link separate object
  147. files (OBJ) for each program (PRG) file.  The following MAKE option
  148. provides an easy way to create object files for each program file
  149. and to link the full system. If a file named LINK.SNP is in the
  150. source code directory, it will be added to the top of the LNK file
  151. made by this option.  This feature allows you to have a set of
  152. standard link commands, perhaps specifying libraries to be searched.
  153. !
  154. 3.12    Write a Turbo C Link File for Clipper Applications
  155. Choose "Y" to create a Turbo C link file for Clipper applications. 
  156. The TLINK linker can use a file for indirect input of commands.
  157. This option will create a link file to link separate object files
  158. (OBJ) for each program (PRG) file.  The following MAKE option
  159. provides an easy way to create object files for each program file
  160. and to link the full system.  This feature allows you to have a set
  161. of standard link commands, perhaps specifying libraries to be
  162. searched.
  163. !
  164. 3.13    Write a Microsoft Link File for Clipper Applications
  165. Choose "Y" to create a MLK file for Clipper applications.  The
  166. Microsoft linker can use a "filename.MLK" file for indirect input
  167. of commands. This option will create a link file to link separate
  168. object files (OBJ) for each program (PRG) file.  The following MAKE
  169. option provides an easy way to create object files for each program
  170. file and to link the full system. If a file named LINK.SNP is in
  171. the source code directory, it will be added to the top of the link
  172. file made by this option.  This feature allows you to have a set of
  173. standard link commands, perhaps specifying libraries to be
  174. searched.
  175. !
  176. 3.14    Write a NDMAKE MAKE File for Clipper Applications
  177. NDMAKE is an MS-DOS version of the UNIX (tm) MAKE utility and is 
  178. available on many bulletin boards.  See the full documentation for a 
  179. description of what MAKE does.  This option allows you to create a 
  180. MAKE file specifying the dependencies within your system to speed
  181. the compilation-link-run-edit process.
  182. !
  183. 3.15        Prepare batch files?
  184. Choose "Y" to prepare three batch files for backing up programs,
  185. databases and other files.  If you select this option, the following
  186. files will be created in the output directory:
  187.    UPDATE.BAT  -- Copies the new output files to the source directory
  188.    BACKDBF.BAT -- Copies databases and index and memory files
  189.    BACKPRG.BAT -- Copies programs, format files and report forms
  190. If you choose "N" these files will not be created.  Note that UPDATE
  191. will write over your original source code files.  Use it only after
  192. you have backed them up and verified that the output files are good.
  193. !
  194. 3.16    Tree Structure File Name
  195. Input the filename for the tree diagram to be written to.  If you
  196. choose not to display the tree, this field is ignored.
  197. !
  198. 3.17    File List File Name
  199. Input the filename for the file list to be written to.  If you
  200. choose not to display the file list, this field is ignored.
  201. !
  202. 3.18    Index Summary File Name
  203. Input the filename for the index summary to be written to.  If you
  204. choose not to display the index summary, this field is ignored.  
  205.  
  206. Do not enter a path here.  The output path you entered on the previous
  207. screen determines the subdirectory in which this file will be written.
  208. !
  209. 3.19    Data Dictionary File Name
  210. Input the filename for the data dictionary to be written to.  If you
  211. choose not to display the data dictionary, this field is ignored.
  212.  
  213. Do not enter a path here.  The output path you entered on the previous
  214. screen determines the subdirectory in which this file will be written.
  215. !
  216. 3.20    Format Summary File Name
  217. Input the filename for the format file summary to be written to.  If
  218. you choose not to display the format file summary, this field is
  219. ignored.
  220.  
  221. Do not enter a path here.  The output path you entered on the previous
  222. screen determines the subdirectory in which this file will be written.
  223. !
  224. 3.21    Report Form Summary File Name
  225. Input the filename for the report form summary to be written to.  If
  226. you choose not to display the report form summary, this field is
  227. ignored.
  228.  
  229. Do not enter a path here.  The output path you entered on the previous
  230. screen determines the subdirectory in which this file will be written.
  231. !
  232. 3.22    Procedure Summary File Name
  233. Input the filename for the procedure summary to be written to.  If
  234. you choose not to display the procedure summary, this field is
  235. ignored.
  236.  
  237. Do not enter a path here.  The output path you entered on the previous
  238. screen determines the subdirectory in which this file will be written.
  239. !
  240. 3.23    Label Summary File Name
  241. Input the filename for the label summary to be written to.  If
  242. you choose not to display the label summary, this field is
  243. ignored.
  244.  
  245. Do not enter a path here.  The output path you entered on the previous
  246. screen determines the subdirectory in which this file will be written.
  247. !
  248. 3.24    Binary Summary File Name
  249. Input the filename for the binary summary to be written to.  If
  250. you choose not to display the binary summary, this field is
  251. ignored.
  252.  
  253. Do not enter a path here.  The output path you entered on the previous
  254. screen determines the subdirectory in which this file will be written.
  255. !
  256. 3.25    Cross Reference File Name
  257. Input the filename for the cross reference to be written to.  If you
  258. choose not to display the cross reference, this field is ignored.
  259.  
  260. Do not enter a path here.  The output path you entered on the previous
  261. screen determines the subdirectory in which this file will be written.
  262. !
  263. 3.26   PLINK86 Link File Name
  264. Input the filename for the LNK file to be written to.  If you
  265. choose not to create a LNK file, this field is ignored.
  266.  
  267. Do not enter a path here.  The output path you entered on the previous
  268. screen determines the subdirectory in which this file will be written.
  269. !
  270. 3.27   Turbo C Link File Name
  271. Input the filename for the link file to be written to.  If you
  272. choose not to create a link file, this field is ignored.
  273.  
  274. Do not enter a path here.  The output path you entered on the previous
  275. screen determines the subdirectory in which this file will be written.
  276. !
  277. 3.28   Microsoft Link File Name
  278. Input the filename for the link file to be written to.  If you
  279. choose not to create a link file, this field is ignored.
  280.  
  281. Do not enter a path here.  The output path you entered on the previous
  282. screen determines the subdirectory in which this file will be written.
  283. !
  284. 3.29   MAKE File Name
  285. Input the filename for the MAKE file to be written to.  If you
  286. choose not to create a MAKE file, this field is ignored.
  287.  
  288. Do not enter a path here.  The output path you entered on the previous
  289. screen determines the subdirectory in which this file will be written.
  290. !
  291. 4.1    Create Formatted Source Code Files?
  292. Answer "Y" if you would like SNAP! to produce output formatted source
  293. code files.  Since this is the main purpose of SNAP!, you will
  294. usually want to have this option in effect.  If you choose this
  295. option, SNAP! will output a copy of each of your source code
  296. files formatted as you specify below. 
  297. !
  298. 4.2    Preserve Original Date and Time
  299. When SNAP! formats source code files and produces new output files,
  300. the new files will have the same date and time as the original input
  301. files if this option is 'Y'.  Otherwise, the new files will have the
  302. current DOS date and time.  You might want to preserve the original
  303. date for MAKE reasons or simply to have the file date represent the
  304. last time you (as opposed to SNAP!) changed the file.
  305. !
  306. 4.3    Write Headings for Source Code Files?
  307. Answer "Y" or "N" depending on whether you want to write file headings
  308. on each program file and action file.  The file heading is a series of
  309. comments documenting the filename, system name, and copyright notice,
  310. in addition to a list of files that call the program, files the
  311. program calls, and databases, index files, format files, report forms
  312. and memory files used.  SNAP! writes the file heading directly onto
  313. your program file (but backs up your original file if your source and
  314. output paths are the same). 
  315. !
  316. 4.4   Echo Headings to a File?
  317. Enter 'Y' to echo headings to a separate file.  This file will just
  318. contain copies of all of the headings written to source code files. 
  319. SNAP! puts a formfeed character between each pair of headings.
  320. !
  321. 4.5   Heading File Name
  322. Enter the filename to contain a copy of the headings that are written
  323. to each source code file.  If you do not choose to echo headings to a
  324. file, this field is ignored.
  325. !
  326. 4.6   Capitalize Tokens (Upper/Lower/First/None)?
  327. Choose "U" to capitalize all occurrences of tokens--words not found in
  328. the DB3WORDS.SNP or DB2WORDS.SNP file, the original version of which
  329. contains all dBASE key words.  Choose "L" to convert all of them to
  330. lower case (default).  Choose "F" to capitalize only the first letter
  331. of the token.  Also, SNAP! will recognize valid 4-character
  332. abbreviations of key words (e.g., PICT will be recognized as an
  333. abbreviation of PICTURE and treated as a key word).   Choose "N" to
  334. leave the case unchanged.
  335. !
  336. 4.7   Capitalize Dbase Key Words (Upper/Lower/First/None)?
  337. Choose "U" to capitalize all occurrences of key words found in the
  338. DB3WORDS.SNP or DB2WORDS.SNP file, the original version of which
  339. contains all Dbase key words.  Choose "L" to convert all keywords to
  340. lower case.  Choose "F" to capitalize only the first letter of the
  341. token.  You may add extra words to be capitalized to this file, or
  342. temporarily "comment out" key words from the file by prefacing them
  343. with an asterisk.  Also, SNAP! will recognize valid 4-character
  344. abbreviations of key words (e.g., PICT will be recognized as an
  345. abbreviation of PICTURE).  Choose "N" to leave the case unchanged.
  346. !
  347. 4.8   Key Word File Name
  348. Input the filename containing a list of keywords to be capitalized
  349. (and not included in the cross-reference listing).  This file should
  350. contain one keyword per line.  This file allows you to customize the
  351. words that will be capitalized, cross-referenced, expanded, etc.  
  352. There are many options--see the manual for details.
  353. !
  354. 4.9   Tabs, spaces or no indenting?
  355. Choose "T" (for tabs) or "S" (for spaces) to indent code underneath
  356. control structures (DO WHILE, IF, CASE, FOR etc.). If you choose to
  357. indent your code, one tab character (or the number of spaces you
  358. specify) will be inserted for each control statement nesting level. 
  359. Choose "N" for no indentation.
  360.  
  361. This option also scans your source code for unmatched control
  362. structures (e.g., IFs not matched with ENDIFs) and reports any
  363. discrepancies.
  364. !
  365. 4.10   No. of Spaces
  366. Enter the number of spaces to be used for each level of indentation. 
  367. This field is ignored if you choose tabs or no indenting.
  368. !
  369. 4.11   Eliminate blank lines?
  370. Choose 'Y' to eliminate blank lines in the input file from the output
  371. file.  Doing so makes dBASE run marginally faster, but has no effect
  372. on compilers such as Clipper.  Please only choose this option if you
  373. have a backup of your source code.  Also, it is an exceptionally 
  374. good idea to send output to a directory other than the input
  375. directory if you choose this option.
  376.  
  377. This is a one-way street--you can't put the blank lines back in again.
  378. !
  379. 4.12    Eliminate comments?
  380. Choose 'Y' to eliminate comments in the input file from the output
  381. file.  Doing so makes dBASE run marginally faster, but has no effect
  382. on compilers such as Clipper.  Please only choose this option if you
  383. have a backup of your source code.  Also, it is an extraordinarily
  384. good idea to send output to a directory other than the input
  385. directory if you choose this option.
  386.  
  387. This is a one-way street--you can't put the comments back in again.
  388. !
  389. 4.13    Keyword Conversion?
  390. Use with caution!  See the manual for some examples of how this option
  391. can screw up your code.  Choose "E" to expand keywords to their full
  392. length.  Dbase allows four character abbreviations, which makes the
  393. code faster but harder to read.  This option expands them back. 
  394. Choose "C" to compress them to four characters.  Choose "N" to do
  395. nothing. Note that a "keyword" is anything in the keyword file.  If
  396. you put variables, etc. there,  SNAP! will not be able to tell the
  397. difference. Also, if you use key words as variable names, they will be
  398. changed along with all other key words.  
  399. !
  400. 4.14    Create Action Diagrams?
  401. Choose "Y" to prepare action diagram files.  Action diagrams are just
  402. like program files, except that they use the IBM extended ASCII
  403. characters to diagram the structure of a program like this:
  404.                    ┌─IF foo
  405.                    │    DO bar
  406.                    └─ENDIF
  407. These files are useful for documentation purposes but are not
  408. directly executable or compilable. If you choose to generate action
  409. diagrams, they will be written to the output directory.
  410. !
  411. 4.15    File Extension for Action Diagrams
  412. Input the extension for the files containing the action diagrams. If
  413. the output directory and the input directory are the same, these files
  414. will be written to the input directory and will overwrite any existing
  415. files with the same name.  The extension may contain the ? character
  416. as a wildcard meaning, "the character in the same position in the
  417. original program file extension."  Thus, if you specify "??T" as the
  418. action file extension and one of your input files is named "FOO.BAR",
  419. the final action file will be named "FOO.BAT".  The default extension
  420. is "ACT".  Extensions of 'PRG' and '???' are invalid.
  421. !
  422. 4.16  Add Line Numbers to Action Diagrams?
  423. Respond "Y" to put line numbers at the beginning of each line in the
  424. action diagrams.  If you answer "N", no line numbers will be
  425. inserted.
  426. !
  427. 4.17   Graphics, ASCII, or Other Characters?
  428. Respond "G" to use the IBM line-drawing characters in the action
  429. diagrams.  These resulting diagrams are visually appealing but may
  430. not print well on some printers.  Choose "A" to use only standard
  431. ASCII characters.  Alternatively, you can define your own set of
  432. action diagram characters by replying "O" here.  The field below
  433. (User-defined Characters) is where you specify which characters to
  434. use.
  435. !
  436. 4.18   User-defined Characters
  437. If you are happy with the predefined graphics or ASCII characters for
  438. action diagrams, you can ignore this field.  It is only used if you
  439. answer "O" to the question immediately above this one.
  440.  
  441. Enter the characters to use for the action diagram.  Read the manual
  442. or you will spoil the whole wretched mess.  Note:  I said it was
  443. possible--I didn't say it was easy.  If you think it is hard to ENTER
  444. user-defined characters, you should see what it was like to PROGRAM
  445. them.
  446. 5.1   Cross-reference Public Variables
  447. Your response here determines whether dBASE III public variables will
  448. be included in the cross-reference report.  If you answer this
  449. question 'Y' and the other questions 'N', then only public variables
  450. will appear on the cross-reference report.
  451. !
  452. 5.2   Cross-reference Other Variables and Tokens
  453. The cross-reference report normally includes all "things" in your
  454. source code that are not either:
  455.    Comments                     Numeric constants
  456.    Key words                    Punctuation
  457.    Quoted strings
  458. Accordingly, file names, field names, and so on will appear in the
  459. cross-reference listing.  If you wish to restrict the report to
  460. public variables only, you can respond 'N' to this and subsequent
  461. questions.
  462. !
  463. 5.3   Cross-reference dBASE Key Words
  464. Your response determines whether key words will be included in the
  465. cross-reference report.  If you respond 'Y' then all words in the key
  466. words file will be referenced on the report.  For example, you might
  467. select this option to see where you used the REPLACE verb. For large
  468. dBASE systems, you will probably exceed the number of allowable
  469. references to such commonly-used key words as SAY, STORE, TO, and
  470. perhaps others. If so, SNAP! will display a warning message ("Too many
  471. references to SAY") and continue processing your files.  Any excess
  472. references are discarded and do not appear on the report. 
  473. !
  474. 5.4   Cross-reference Numeric Constants
  475. Your response determines whether numbers used in your system will
  476. appear on the cross-reference report.  Under normal circumstances,
  477. they will probably only get in the way, but you may occasionally want
  478. to see where you used a particular constant, especially if you later
  479. need to change it.
  480. !
  481. 6.1    Write Program Tree Structure?
  482. Choose "Y" to display and echo to a file a diagram of the system tree
  483. structure, showing which programs call which other programs, and
  484. which programs use which databases.  The diagram also indicates which
  485. "programs" are dBASE III procedures.
  486. !
  487. 6.2    Tree Structure File Name
  488. Input the filename for the tree diagram to be written to.  If you
  489. choose not to display the tree, this field is ignored.
  490. !
  491. 6.3    Include Procedures in the Tree Diagram?
  492. Type 'N' to exclude procedure files from the tree diagram.  While you
  493. would ordinarily not want to do this, you might want to exclude
  494. procedure files if you had a lot of procedures that just cluttered up
  495. the diagram.  If you exclude procedures, you cannot use graphics or
  496. ASCII characters to depict the tree hierarchy (I couldn't figure out
  497. how to make it all work).
  498. !
  499. 6.4    Include Functions in the Tree Diagram?
  500. Type 'N' to exclude functions from the tree diagram.  While you would
  501. ordinarily not want to do this, you might want to exclude functions if
  502. you had a lot of functions that just cluttered up the diagram.  If you
  503. exclude functions, you cannot use graphics or ASCII characters to
  504. depict the tree hierarchy (I couldn't figure out how to make it all
  505. work).
  506. !
  507. 6.5    Include Format Files in the Tree Diagram?
  508. Type 'N' to exclude format files from the tree diagram.  While you
  509. would ordinarily not want to do this, you might want to exclude format
  510. files if you had a lot of format files that just cluttered up the
  511. diagram.  If you exclude format files, you cannot use graphics or
  512. ASCII characters to depict the tree hierarchy (I couldn't figure out
  513. how to make it all work).
  514. !
  515. 6.6    Include Databases in the Tree Diagram?
  516. Type 'Y' to include databases in the tree diagram underneath the
  517. program that USEs them.  Alias names are also shown. 
  518. !
  519. 6.7    Include Index Files in the Tree Diagram?
  520. Type 'Y' to include indexes in the tree diagram underneath the program
  521. that references them.
  522. !
  523. 6.8    Include Report Forms in the Tree Diagram?
  524. Type 'Y' to include report forms in the tree diagram underneath the
  525. program that references them.
  526. !
  527. 6.9    Include Label Forms in the Tree Diagram?
  528. Type 'Y' to include label forms in the tree diagram underneath the
  529. program that references them.
  530. !
  531. 6.10   Include Memory Files in the Tree Diagram?
  532. Type 'Y' to include memory files in the tree diagram underneath the
  533. program that references them.
  534. !
  535. 6.11   Characters for Tree Diagram
  536. Enter 'G' for IBM box-graphics characters, such as the following:
  537.             TopFile
  538.             ├────OneFile   
  539.             │    └────YetAnotherFile
  540.             └────AnotherFile
  541. Enter 'A' for ASCII characters only--no graphics characters used. The
  542. plus character is used for joining lines, while hyphens and pipe
  543. symbols are used for horizontal and vertical lines. Some printers
  544. cannot print the graphics characters.  Select 'N' to omit the
  545. characters entirely.  
  546. !
  547. 7.1    Print Source Code Files?
  548. Answer 'Y' to print the new source code files you just created. 
  549. SNAP! expects to see these files in the output directory you
  550. specified before you began documentation.
  551. !
  552. 7.2    Print Action Diagrams?
  553. Answer 'Y' to print the new action diagrams you just created. 
  554. SNAP! expects to see these files in the output directory you
  555. specified before you began documentation.  
  556.  
  557. If you are printing from a file, the ACT files must be listed in the
  558. file for SNAP! to find them.  Note that FILELIST.DOC does not list
  559. action diagram files.
  560. !
  561. 7.3   Line Width
  562. Input a line width between 40 and 255.  The standard line width of 
  563. most printers using 8.5 x 11 inch paper is 80, but you can change it
  564. by using wide paper and entering the appropriate setup codes for your
  565. printer.  The line width you enter should be the total number of
  566. characters your printer can print across a line.  The actual length
  567. of printed source code lines will be reduced by the left and right
  568. margins you set below.  Source code lines longer than the line width
  569. you specify will be wrapped to the next line.
  570. !
  571. 7.4   Page Length
  572. Input a page length greater than or equal to 0.  If you enter 0, the
  573. program assumes continuous form paper and will not write page
  574. headings except on the first page.  Page length must also be larger
  575. than your top and bottom margins.
  576. !
  577. 7.5   Top Margin
  578. Enter a number greater than 3 and smaller than your page length.
  579. The first three lines are used to print a heading on each page.
  580. !
  581. 7.6   Bottom Margin
  582. Enter a number greater than or equal to 0.  This many lines will be
  583. left blank at the bottom of each page.
  584. !
  585. 7.7   Left Margin
  586. Enter a number greater than 0 and less than your line width.  Line
  587. numbers (or source code if you elect not to print line numbers) will
  588. begin this many spaces from the left edge of the paper.  A left
  589. margin of 12 usually leaves room for 3-hole binder punches.
  590. !
  591. 7.8   Right Margin
  592. Enter a number greater than 0 and less than your line width.  This
  593. many spaces will remain between your source code and the right
  594. edge of the paper.
  595. !
  596. 7.9   Spaces per Tab
  597. Enter a number between 1 and 12.  Each tab character in your source
  598. code will be converted to this many spaces as the source code is 
  599. printed.  The source code file will be unaffected--the expansion is
  600. done for printing purposes only.  Tab expansions of 3 or 4 make the
  601. code easy to follow without causing it to march off the right side of
  602. the page.
  603. !
  604. 7.10   Print Line Numbers?
  605. Choose "Y" to print line numbers next to each line of source code or
  606. "N" to suppress them.  Line numbers are useful references for
  607. following up on error messages or for using the variable
  608. cross-reference report.
  609.  
  610. Line numbers are not added to action diagrams.  If you want action
  611. diagrams with line numbers on them, you must put them there when the
  612. diagrams are created.
  613. !
  614. 7.11   Form Feed Before Printing
  615. Enter a 'Y' to send a form feed before printing the first source code
  616. file.
  617. !
  618. 7.12   Form Feed After Printing
  619. Enter a 'Y' to send a form feed after printing the last source code
  620. file.
  621. !
  622. 7.13   Printer Setup Codes
  623. Enter setup codes for your printer.  The default codes shift an Epson
  624. (and many other printers) into compressed print.  The format for setup
  625. codes is three-digit decimal numbers separated by backslashes (\).  For
  626. example, the code to put an Epson-compatible printer into compressed
  627. print is \015.  This string works well on an HP LaserJet II:
  628.    \027E\027&l0o8D\027(10U\027(s16.6H
  629. If you use this string, set the line width to 132 and the page length
  630. to 80.  This field is always optional.
  631. !
  632. 7.14   Printer Reset Codes
  633. Enter reset codes for your printer.  These are sent to yor printer
  634. after SNAP! finishes printing. The default codes shift an Epson (and
  635. many other printers) into regular print.  The format for reset codes
  636. is three-digit decimal numbers separated by backslashes (\).  For
  637. example, the code to put an Epson-compatible printer into regular
  638. print is:
  639.    \018 
  640. This field is always optional.
  641. !
  642. 8.1   Ignore Drive Designations?
  643. Choose "Y" to ignore drive designations when looking for program
  644. files. This option is useful if your program tests for the existence
  645. of files on various drives and makes a decision based on the results.
  646. If you choose not to ignore drive designations, SNAP! will attempt
  647. to find the program files on the specified drive.  Depending on the
  648. equipment you have installed, DOS may prompt you to insert a disk in
  649. drive B.  This DOS message usually messes up the SNAP! screen.
  650. !
  651. 8.2    Search Tree?
  652. Enter a "Y" here to search all programs in the tree below the
  653. top filename.  If you enter a "N", SNAP! will only document the 
  654. specific file you enter.
  655. !
  656. 8.3   dBASE III Format?
  657. Enter a "Y" if your system is written in dBASE III, Clipper,
  658. Foxbase+, or another dBASE III-compatible system.  Otherwise, enter a
  659. "N".  dBASE II and dBASE III use different syntax and different
  660. formats for database and index files. 
  661. !
  662. 8.4  Associate Databases and Other Files?
  663. Enter 'Y' here if you would like SNAP! to try to figure out how your
  664. databases, indexes, report forms, etc. are related.  SNAP! cannot
  665. always tell, but it takes its best shot.
  666. !
  667. 8.5  Default Extension for Index Files?
  668. Enter the default extension for index files.  For example, you might
  669. enter NTX for a Clipper application or IDX for FoxBASE+.  SNAP!
  670. assumes that index files have this extension unless you specifically
  671. use another extension as part of the filename.
  672. !
  673. 9.1   Configuration File Name
  674. Enter the complete file name for the configuration.  You may include a
  675. drive and path designation if you wish.  If you do not specify the
  676. path, the file will be read from or written to the current directory
  677. when you invoked SNAP!
  678. !
  679. 10.1   File Containing List of Filenames
  680. Enter the name of the file that contains the filenames to print. 
  681. SNAP! will print each of the files listed in this file, except for
  682. files with the following extensions: DBF, NDX, NTX, IDX, MEM, FRM, LBL
  683. and VUE.  SNAP! will recognize a FILELIST.DOC file and appropriately
  684. eliminate blank lines and other extraneous information before printing
  685. the files.
  686. !
  687. 10.2  Path for Files to be Printed 
  688. Enter the path where the files to be printed are located.  Your entry
  689. should begin with a backslash ('\') but should not end with one.  For
  690. example, if your data files are in a directory called DBASE\SOURCE,
  691. you would enter the following:
  692.  
  693.    Path for filenames: C:\DBASE\SOURCE
  694.  
  695. If this path is not blank, SNAP! removes any paths from the filenames
  696. in the file list and adds this path instead.
  697. !
  698.