home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / mfil130a.zip / maxfile.doc < prev    next >
Text File  |  1995-09-02  |  36KB  |  980 lines
  1.  
  2. _____________________________________________________________________________
  3. |                                                                           |
  4. |               MaxFile/2, a text based files.bbs manager                   |
  5. _____________________________________________________________________________
  6.  
  7.  
  8.  
  9.  
  10.   Portions of the header files used in compilation are:
  11.  
  12.         Copyright (C) 1992, Scott Dudley
  13.         Copyright (C) 1994, Marco Maccaferri
  14.  
  15.  
  16. From the Development Team of:
  17.  
  18.       Ronald Van Iwaarden     1:104/338        MaxFile/2  Development
  19.       Craig Morrison          1:201/60         MaxFile/PM Development
  20.  
  21.  
  22.  
  23. Special Thanks go out to:
  24.  
  25.   Scott Dudley        For making Maximus the great BBS that it is!
  26.   Marco Maccaferri    For providing the Lora structures and Lora itself
  27.   Rick Ford           Keeping me up to date with the Lora-BBS information
  28.   Walter Bright       MEM.C, a package to track pointer bugs.
  29.  
  30. If I missed anyone, well...you know who you are! Thanks!
  31.  
  32.  
  33.  
  34.  
  35.  
  36. Forward:
  37. --------
  38.  
  39.  
  40.     For about 12 months, I have been getting by using (H)url to
  41. move files from one area to another and then pulling up an external
  42. editor to try and manipulate file descriptions.  Needless to say, this
  43. got very tedious and to try and get around this, I searched for an
  44. OS/2 based file manager.  As many of you know, there was none so I set
  45. out to write my own.  MaxFile/2 is the cumulation of all that effort
  46. to date.
  47.  
  48.     I originally only wanted a manager to edit descriptions, move
  49. files and change archive types (I like all ZIPs).  As time went on and
  50. as people found out about my efforts, creeping featuritis began to
  51. set in and MaxFile/2 is now IMHO, the most powerful file manager
  52. available to Max/2 sysops.  It is multi-threaded, has most every
  53. feature found in many popular DOS based file managers, and it is fully
  54. 32-bit.
  55.  
  56.     MaxFile/2 is also always in need of improvement.  If you have
  57. any suggestions or bug reports, feel free to let me know at any of the
  58. addresses at the end of this document.  The Internet address is
  59. probably the most stable of the addresses given as I hope to complete
  60. my PhD in applied mathematics in the next year (mid 95) or so and
  61. completing my degree will probably take me to another part of the
  62. country given that I find a "real" job.
  63.  
  64.     Support will always be given in the OS2Prodsupport echo, the
  65. OS2BBS echo, the MUFFIN echo and the MFilePMSUP echo which are
  66. available at the Fernwood BBS as well as many other quality OS/2
  67. Fidonet BBS's throughout the world such as my own.  Support will also
  68. be given via mail to any of the addresses that are given at the end of
  69. this document.
  70.  
  71.  
  72.  
  73. How it works: -------------
  74.  
  75.     MaxFile/2 is a menu based file manager that is similar in
  76. appearance to most file managers that you might have encountered for
  77. normal file management.  There are three main menu options: File which
  78. does many manipulations on files, Sort which will sort the files.bbs
  79. on the name, date or size field, and Description which will allow you
  80. to manipulate the description of any given file in the files.bbs.
  81. These menus are brought down by pressing the key <alt-F>, <alt-S> or
  82. <alt-D> respectively.
  83.  
  84.     The remainder of the top line is used for filling you in on
  85. the status of the threads that may be running in the background.
  86. Immediately following the word Description, file names will appear when
  87. their archive types are being changed.  At the far right of the top
  88. line is where file names are displayed when they are files (GIF, JPG,
  89. BMP, TIF, PCX, TXT) that are being displayed by the external viewer.
  90. This is  done so that you can then edit the description while you are
  91. viewing the file.
  92.  
  93. If you ever have any questions, pressing <F1> will bring up a window
  94. with a description of your present options.  This does not yet work
  95. for all situations but it does work for the areas where you have the
  96. greatest number of choices.
  97.  
  98.  
  99. Installation for OS/2:
  100. ----------------------
  101.  
  102.     First, move the file emx.dll to somewhere in your libpath and
  103. then edit the file maxfile.cfg to fit your setup. Now, just run it and
  104. you should be set.
  105.  
  106.     If you won't be running MaxFile/2 under DOS, you can delete
  107. the files rsx.exe and emx.exe.
  108.  
  109.  
  110.  
  111. Installation for DOS:
  112. ----------------------
  113.  
  114.     There are two ways to install MaxFile/2 for DOS.  The first
  115. method uses it's own 32-bit dos extender called EMX.  The second
  116. requires you to have a DPMI server installed such as emm386, Windows,
  117. or OS/2 (yes, you can run MaxFile/2 in an OS/2 DOS box...).
  118.  
  119.     Both methods require that you edit the file MaxFile.cfg to
  120. your settings.  Once you have done this, choose one of the following
  121. two methods for completing your installation:
  122.  
  123. Option 1:
  124.  
  125.     For the first method of installation, you must do the
  126. following.  First, make sure that you don't have a DPMI process such
  127. as emm386.exe installed (himem.sys is just fine).  Then, add the
  128. following lines to your autoexec.bat:
  129.  
  130. set emx=<path>\emx.exe
  131. set emxopt=-acm -p
  132.  
  133. where <path> is the path to emx.exe.
  134.  
  135.  
  136. Option 2:
  137.  
  138.     First you must be running some sort of DPMI memory manager
  139. such as emm386.exe as a device driver.  Second, you need to add the
  140. following lines to your autoexec.bat:
  141.  
  142. set rsx=<path>\rsx.exe
  143. set emx=<path>\rsx.exe
  144. set rsxopt=-am -Rm4096 -p
  145.  
  146. where <path> is replaced by the path to the file rsx.exe which is
  147. included in this archive.  The number 4096 represents the amount of
  148. memory (in kilobytes) that will be pre-allocated to MaxFile.  Do not
  149. set this number any higher than the amount of DPMI memory that you
  150. have in your computer.  The only time this will be significant is if
  151. you have a large number of files in one area or if you are doing a
  152. dupe search.
  153.  
  154.  
  155.  
  156.     Everything should be set up now, just type maxfile and then
  157. hit return and you should be off and running!
  158.  
  159.  
  160.  
  161.  
  162.  
  163. Config file key words:
  164. ----------------------
  165.  
  166.     MaxFile/2 uses a simple text based configuration file to set
  167. up some basic parameters.  The key words and their descriptions will
  168. follow here:
  169.  
  170.  
  171.  
  172.  
  173. BBS_TYPE xxxxx
  174.  
  175. This is the type of BBS you run.  Right now, only Maximus, Lora, and
  176. SuperBBS  are supported.  If you run a different type of bbs that uses
  177. a standard files.bbs, contact either of the authors about getting
  178. support for your type of bbs.  There is also, now, support for a
  179. "generic" type of BBS.  The only restriction is that the BBS must use
  180. a files.bbs approach to cataloging files.  See the later section
  181. "Generic BBS configuration" for more information on how to set up this
  182. type of BBS.
  183.  
  184.  
  185.  
  186.  
  187. FBP  d:\max\fbp.exe
  188.  
  189. This is the command line for your file index maintinance utility.  For
  190. Maximus sysops, this is either fbp.exe or fb.exe.  If you are a Lora
  191. sysop, this program is called fileidx.exe.  Lora sysops also need to
  192. include the index file that is to be updated.  For example, if you
  193. want to update the allfiles.idx index file, you would have the line
  194. "FBP g:\lora\fileidx.exe fileidx.idx" instead of the above line.
  195.  
  196.  
  197.  
  198.  
  199. AutoFB YES|NO
  200.  
  201. This determines whether or not FB (or FBP) as defined above will
  202. automatically be run on the changed file areas when MaxFile/2 exits.
  203.  
  204.  
  205.  
  206.  
  207. MAXDIR   d:\max
  208.  
  209. This is simply where you keep MAXP.EXE and all the related utilities.
  210. It is necessary.
  211.  
  212.  
  213.  
  214.  
  215. TEMPDIR d:\temp
  216.  
  217. This is a directory were all work can be done.  This is only used if
  218. you have not defined the TMP environment variable in which case the
  219. directory stored in TMP will be used.  If you have defined neither the
  220. TMP directory or the above TEMPDIR, MaxFile/2 will create
  221. sub-directories off of the present directory to do it's work.
  222.  
  223.  
  224.  
  225.  
  226. sysinfo d:\max\area.dat
  227.  
  228. This is the location of your file area system information.  For
  229. Maximus sysops, this is your area.dat file and for Lora sysops it is
  230. the sysfile.dat file.  Simply give the full path for this file.
  231.  
  232.  
  233.  
  234.  
  235. DATE   (YES|NO)
  236.  
  237. This config verb simply sets the default status for displaying the
  238. date.  That is, it the verb is set to NO, then the date will not be
  239. displayed in a window for each file as  default (it can be toggled
  240. back on easily enough if wanted).
  241.  
  242.  
  243.  
  244.  
  245. SIZE   (YES|NO)
  246.  
  247. This config verb simply sets the default status for displaying the
  248. file size.  That is, it the verb is set to NO, then the file size will
  249. not be displayed in a window for each file as  default (it can be
  250. toggled back on easily enough if wanted).
  251.  
  252.  
  253.  
  254. WRAP   (YES|NO)
  255.  
  256. This config verb simply sets the default status for displaying the
  257. file description.  That is, it the verb is set to NO, then the file
  258. description  will not be wrapped as the default.  (it can be toggled
  259. back on easily enough if wanted).
  260.  
  261.  
  262.  
  263.  
  264. Window1Area 0
  265. Window2Area 1
  266.  
  267. These are the areas in which the two window will open up in.  The
  268. default is area 0 and 1 (This does not necessarily the same as in your
  269. filearea.ctl) as defined by the area change window.
  270.  
  271.  
  272.  
  273.  
  274. GIF joeview
  275. JPG joeview
  276. BMP joeview
  277. TIF joeview
  278. PCX joeview
  279. TXT e
  280.  
  281. These are the commands for viewing GIF, JPG, BMP, TIF, PCX, or TXT files
  282. respectively. They do not have to be the same and the default is for
  283. them to not be installed and they do not have to be the same command.
  284. It is assumed that it will take a file name on the command line.  For
  285. example, if I type "joeview os2.bmp", Joeview will come up with
  286. os2.bmp as the image.
  287.  
  288.  
  289.  
  290.  
  291. LowPriRearchive (YES|NO)
  292.  
  293. This sets the priority level at which the file re-archiving is done.
  294. If it is set to YES, the priority level of the re-archiving is set to
  295. Idle, delta 1.  If it is set to NO, then the re-archiving is done at
  296. the level at which MaxFile/2 is running.  The default is YES
  297.  
  298.  
  299.  
  300.  
  301. DefDescription xxxxxxxxxxxxxxx
  302.  
  303. This is the description given to files that are adopted and do not
  304. have a file_id.diz or desc.sdi in the archive.  It can be up to 60
  305. characters long and can have any ascii symbols you want.
  306.  
  307.  
  308.  
  309.  
  310. VirusCheck os2scan.exe /nopause /report c:\cprog\maxfile\virscan.log
  311.  
  312. An External virus scanner can be used.  The expected format for this
  313. command is that the scanner is run, taking a directory on the
  314. command line and all files in that directory will be scanned.  The
  315. return code is expected to be 0 if no virii are found and non-zero
  316. otherwise.  The example here is for Ann Mcafee's oscan.exe.  The
  317. scanner is run in a separate session so you can watch it's progress.
  318.  
  319.  
  320.  
  321.  
  322. zip_extract   unzip -x -o -U
  323. zip_add       zip -9 -r
  324. zip_list      unzip -v
  325. zip_test      unzip -t
  326.  
  327. These describe the command line for dealing with .zip files.  It is
  328. assumed that the archive is taken as argument 1 (after the above
  329. string) and, for extraction, the files to be extracted are taken as
  330. further arguments.  The example given should work for most Max/2 sysops
  331.  
  332.  
  333.  
  334. arj_extract   unarj e
  335. arj_add
  336. arj_list      unarj l
  337. arj_test      unarj t
  338.  
  339. These describe the command line for dealing with .arj files.  It is
  340. assumed that the archive is taken as argument 1 (after the above
  341. string) and, for extraction, the files to be extracted are taken as
  342. further arguments.  The example given should work for most Max/2 sysops
  343.  
  344.  
  345.  
  346.  
  347. lh_extract         lh x
  348. lh_add             lh a
  349. lh_list            lh l
  350. lh_test            lh t
  351.  
  352. These describe the command line for dealing with .lzh files.  It is
  353. assumed that the archive is taken as argument 1 (after the above
  354. string) and, for extraction, the files to be extracted are taken as
  355. further arguments.  The example given should work for most Max/2 sysops
  356.  
  357.  
  358.  
  359.  
  360. arc_extract   arc x
  361. arc_add       arc a
  362. arc_list      arc l
  363. arc_test      arc v
  364.  
  365. These describe the command line for dealing with .arc files.  It is
  366. assumed that the archive is taken as argument 1 (after the above
  367. string) and, for extraction, the files to be extracted are taken as
  368. further arguments.  The example given should work for most Max/2 sysops
  369.  
  370.  
  371.  
  372.  
  373. WrapComents (YES|NO)
  374.  
  375. Since many times, you just want to see that the comments are there so
  376. that you can see the spacing, this keyword will prevent the
  377. descriptions of the comments from being wrapped, no matter what is
  378. done with the rest of the window.
  379.  
  380.  
  381.  
  382.  
  383. Touch_Adoptee (YES|NO)
  384.  
  385. This determines whether or not a file is to be "touched" (file date
  386. brought up to the current date) when you adopt it.  The default is YES
  387.  
  388.  
  389.  
  390.  
  391. AutoAdopt (YES|NO)
  392.  
  393. This determines whether or not to automatically adopt the orphan files
  394. in a file area when you enter a new file area.
  395.  
  396.  
  397.  
  398.  
  399. adopt            zip
  400.  
  401. This keyword simply describes what sort of file extensions to look for
  402. when adopting orphaned files.  You can have up to 15 of these lines.
  403.  
  404.  
  405.  
  406.  
  407. ColourName      BLUE
  408. ColourReadOnly  CYAN
  409. ColourSize      MAGENTA
  410. ColourDate      GREEN
  411. ColourDesc      RED
  412. ColourHighlight YELLOW
  413.  
  414. This is where you can set up the colours for MaxFile/2.  They are
  415. fairly self explanatory.  The possible colours are Black (not
  416. recommended), RED, BLUE, MAGENTA, WHITE, GREEN, CYAN, BROWN, and
  417. YELLOW.
  418.  
  419.  
  420.  
  421.  
  422. DupIgnoreExtension (YES|NO)
  423.  
  424. If this keyword is set to yes, then MaxFile/2 will ignore the
  425. extensions of file names when searching for duplicates.
  426.  
  427.  
  428.  
  429.  
  430. American_date (YES|NO)
  431.  
  432. If this keyword is set to yes, then dates will be displayed in the
  433. form mm/dd/yy.  If it is set to no, then dates will be displayed in
  434. dd/mm/yy format.
  435.  
  436.  
  437.  
  438.  
  439. ExtendedDesc  ?
  440.  
  441. If your BBS supports using extended descriptions in the files.bbs,
  442. enable this keyword and replace the '?' with the special character
  443. that is used by your BBS system to identify extended descriptions. If
  444. you are a Maximus user, leave this line commented out.  For example if
  445. your files.bbs can look like the following:
  446.  
  447. myfile.zip This is a file for which I have decided to use an extra
  448. >          long description.  The special character for my BBS type is
  449. >          the '>' which indicates that the comment for the previous
  450. >          file is continued on this line.
  451.  
  452. You would replace the '?' above with a '>' to enable these long
  453. descriptions.  The extended description is edited with an external
  454. editor which is defined later with the externaledit verb. The
  455. 'e' editor works very nice for this purpose.  Also, the above special
  456. character cannot be a space, a '-', a letter, or a number.
  457.  
  458.  
  459. VerticalWindows (YES|NO)
  460.  
  461. This config verb will allow MaxFile/2 open up window windows split
  462. either vertically or horizontally.  If this variable is set to YES,
  463. then MaxFile/2 opens up with two windows side by side.  If it is set
  464. to NO, then you get one window on top and one on the bottom.
  465.  
  466.  
  467. Macro? <string>
  468.  
  469. This config verb (where ? is any number from 2 to 9) describes a macro
  470. that can be run on the selected files.  The macro can be any sort of
  471. external program, specifically, a .cmd file can be very useful.  The
  472. macro is run with the command line parameters:
  473.  
  474.  
  475. c:\file\filename.ext c: file\ filename ext
  476.       (1)            (2) (3)     (4)   (5)
  477.  
  478. (1) is the fully qualified file name
  479. (2) is the drive for the file
  480. (3) is the path with a trailing slash (or back slash)
  481. (4) is the file name (without extension)
  482. (5) is the file extension.
  483.  
  484. This could be especially useful for extracting a file to a specific
  485. directory, extracting a "read.me" file or something along that line.
  486. This is done in a separate thread (such as the picture viewer) so one
  487. can edit descriptions and perform other operations while the macro is
  488. performing it's work  The macros can be accessed by pushing function
  489. key i (that is, press <F2> for macro2 and <F6> for macro6,...).
  490.  
  491.  
  492.  
  493. externaledit <string>
  494.  
  495. This config verb allows you to define an external editor to edit the
  496. descriptions rather than using the built in editor.  If you are using
  497. extended descriptions, then this must be defined.  If you have not
  498. defined an extended description character, then all control-returns
  499. that are in the edited file will be changed to spaces.  If you want to
  500. use the built in editor, then either comment out this line or leave
  501. the string blank.
  502.  
  503.  
  504. strip_high_asci (YES|NO)
  505.  
  506. This config verb allows you to configure whether or not you want the
  507. high ascii characters stripped from the file_id.diz when it is used as
  508. the description.  Naturually, set it to YES if you want the high ascii
  509. stripped and set it to no if you want the high ascii retained.  If it
  510. is set to YES, then all high ascii characters are changed to spaces
  511. and sequences of more than three spaces are collapsed to a single space.
  512.  
  513.  
  514. 256char_descriptions (YES|NO)
  515.  
  516. If 256char_descriptions is set to YES, then the file_id.diz is
  517. truncated to 256 characters when it is extracted.  The reason for
  518. this is that for some BBS systems (like Maximus), if the line
  519. exceeds 256 characters in length, the BBS considers the line to be
  520. starting a new file and so things get really confused.  If you are
  521. running a BBS that supports extended file descriptions and have it
  522. configured as such above, set this variable to NO.
  523.  
  524.  
  525. DupeSearchStyle (number)
  526.  
  527. Set DupeSearchStyle to 0 if you want to search for duplicates in all
  528. file areas.  If it is set to 1, then it will only look for duplicates
  529. of files in the present area.  You may want to set it to 1 if you have
  530. a slow machine or if you simply want to check your unchecked uploads
  531. area against all other areas.
  532.  
  533.  
  534.  
  535. FileListMargin (number)
  536.  
  537. FileListMargin is an addition to MaxFile/2 which allows descriptions
  538. that are longer than the 256 characters that Maximus imposes.
  539. WARNING:  If you enable this, then MaxFile/2 will use a non-standard
  540. method of storing the files.bbs.  Some utilities including Maximus's
  541. own Hurl will not recognize this and your file areas may become
  542. trashed.  One important utility, Downsort, will recognize this format
  543. and works just fine if you enable it.
  544.  
  545. Now, what does it do.  If you are running Maximus, you can set this
  546. verb to the same value as you have "FileList Margin" set in your
  547. max.ctl.  For instance, if you set (number) to 30, then MaxFile/2 will
  548. take the following file and description:
  549.  
  550. 20MEMU.ZIP   [   8] New .dll's for os20memu, a program to examine the memory usage of all running processes.  Updated for OS/2 Warp 3.0
  551.  
  552. and change it into
  553.  
  554. 20MEMU.ZIP   [   8] New .dll's for os20memu, a program to examine the memory
  555.                              usage of all running processes.  Updated
  556.                              for OS/2
  557.                              Warp 3.0
  558.  
  559. This allows one to have very long descriptions (up to 1024
  560. characters).  If ExtendedDesc is set, then this verb is ignored.  One
  561. neat thing about this feature is that file_id.diz's will be extracted
  562. exactly as the author intended.
  563.  
  564. Also, when FileListMargin is set, then 256char_descriptions is also
  565. ignored as they can now be up to 1024 characters.  Finally, you also
  566. need to define an external editor.  For this, I recommend the tedit
  567. editor that is now included with OS/2 Warp 3.0 in your \os2 directory.
  568.  
  569.  
  570. ucasefnames (YES or NO)
  571.  
  572. Setting this keyword to YES will turn all filenames to upper case if
  573. it. Otherwise, it leaves the filenames as is.  Note that the upper
  574. case names will not be saved unless you otherwise modify a file area
  575. and save it.  The default is NO.
  576.  
  577.  
  578.  
  579. SortAreas (YES or NO)
  580.  
  581. If this keyword is set to YES, then the file areas are sorted on the
  582. area tag.  They are sorted alphabetically as if they were right
  583. justified so that the numerical order appears correctly.  The default
  584. is NO.  Notice that this could cause some problems with your old setup
  585. with the maxfile.exc file as well as the window1area and window2area
  586. defaults from previous versions of MaxFile/2.
  587.  
  588.  
  589. Generic BBS configuration: --------------------------
  590.  
  591. If your BBS type is not presently have built in support with MaxFile/2
  592. or MaxFile/PM, you can add a "generic" setup.  Simply change the
  593. BBS_TYPE to generic and then create a configuration file that
  594. describes your file areas as follows:
  595.  
  596. ───────────────────────────── AREAS.CFG sample ────────────────────────────────
  597. AreaCount 5
  598. 0 d:\max\file\uncheck    d:\max\file\uncheck\files.bbs    Unchecked Uploads
  599. 1 d:\max\file\max        d:\max\file\max\files.bbs        BBS Stuff
  600. 2 d:\max\file\dos\games  d:\max\file\dos\games\files.bbs  Dos Games
  601. 3 d:\max\file\os2\util   d:\max\file\os2\util\files.bbs   OS/2 Utilities
  602. 4 d:\max\file\os2\apps   d:\max\file\os2\apps\files.bbs   OS/2 Applications
  603. ───────────────────────────────────────────────────────────────────────────────
  604.  
  605. The 'AreaCount' keyword tells MaxFile/2 how many area definitions it
  606. can expect to find in the file. The AreaCount keyword must come BEFORE
  607. the area definition lines.
  608.  
  609.   The format for each area definition line is:
  610.  
  611.     <area tag> <file path> <list name> <area description>
  612.  
  613.     <area tag>          - Is a short name to identify the file area.
  614.     <file path>         - Is the path to the files.
  615.     <list name>         - Is the full drive\path and filename of the
  616.                           FILES.BBS for the area. 
  617.     <area description>  - Is a description of the area.
  618.  
  619. All four items MUST be on each line.
  620.  
  621. You can name this file what ever you wish, just make sure you specify
  622. the name of this file for the sysinfo variable in the maxfile.cfg
  623. file.
  624.  
  625. Please be aware that if we can install normal support for your BBS
  626. type, then MaxFile/2 will interact more smoothly with your BBS and
  627. there will be one less configuration file to setup.  If you have
  628. information regarding the structure for storing file area information
  629. and also have the permission of the BBS author to distribute this
  630. information, please forward it to either the author of MaxFile/2 or
  631. MaxFile/PM at one of the addresses at the end of this document.  It is
  632. usually quite easy to add support for new BBS types and we can
  633. probably have a new executable for you within a couple of days.
  634.  
  635.  
  636.  
  637.  
  638. Command Line Options:
  639. ---------------------
  640.  
  641. MaxFile/2 now supports several command line options that can be used
  642. for nightly/weekly maintinance.
  643.  
  644. -allfiles:    This command line option will force MaxFile/2 to
  645.         to create a file called maxfile.all in the present
  646.         directory.  It will be a complete list of all files
  647.         in your files.bbs with the size and dates listed with
  648.                 the filename.  MaxFIle/2 will look for the files
  649.                 allfiles.hdr and allfiles.ftr in the current directory
  650.         which will become the header and footer of the
  651.         allfiles list.
  652.  
  653.                 For customization, MaxFIle/2 will read in the files
  654.                 allfiles.hdr as the header of your allfiles list and
  655.                 allfiles.ftr as the footer for the allfiles list.
  656.                 These files must be in the present directory to work.
  657.                 If they cannot be found, then no header or footer will
  658.                 be created.
  659.  
  660.                 Finally, MaxFile/2 will look for the file maxfile.exc
  661.                 in the current directory.  This file will contain the
  662.                 numbers of the areas that will be excluded from the 
  663.                 all files list, listed one per line.  A sample
  664.                 maxfile.exc is included.  This can be used so that
  665.                 certain (hidden, passworded) file areas will not be
  666.                 listed in the allfiles list.
  667.  
  668.  
  669.  
  670. -adopt:        This option will cause MaxFile/2 to adopt all of the
  671.         orphans in all file directories that are pointed to
  672.         by a file area.  When files are adopted, MaxFile/2
  673.         will attempt to extract a file_id.diz or desc.sdi and
  674.         use that as the file description.
  675.  
  676.  
  677. -file_id:    This option will go into every file area and check
  678.         every file that is listed in the flies.bbs to see if
  679.         it has a file_id.diz or desc.sdi to be used asa file
  680.         description.  If you run Maximus, be sure to set the
  681.                 256char_descriptions verb to YES or you may end up
  682.                 with some illegible files.bbs
  683.  
  684.  
  685. -sort:        This option will open the files.bbs in every area,
  686.         sort the files.bbs according to name.
  687.  
  688.  
  689. -dupes:         This will create a file maxfile.dup that will contain
  690.                 a list of all the duplicate files that could be
  691.                 located on your BBS.
  692.  
  693.  
  694.  
  695.  
  696. The -adopt and -file_id.diz options will print a description of what
  697. they are doing on stdout which can be used as a log.  That is, you
  698. could run MaxFile/2 every night with the command line:
  699.  
  700. maxfile -adopt >> adopt.log
  701.  
  702. which will give a list of what files were adopted in which areas and
  703. the descrtiption that was used for the file.
  704.  
  705. Be aware that the -file_id option can take a VERY long time.
  706. Essentially, it needs to try to unzip file_id.diz from every file in
  707. your file list which, as you can imagine, takes quite a while.
  708.  
  709. Also, these command line options can be combined and will be run in
  710. the order that they are given.  For instance, if you wanted to adopt
  711. all files, sort the file areas and then write an all files list, you
  712. could give the command
  713.  
  714. maxfile -adopt -sort -allfiles
  715.  
  716. which would perform the three tasks in order.
  717.  
  718.  
  719.  
  720. File Menu Options:
  721. ------------------
  722.     
  723. Here is where the majority of my work is done with MaxFile/2.  This
  724. will do most of your normal file manipulations for the files.bbs.
  725. Most of the options are fairly self-explanatory but I will go through
  726. them anyway.  Whenever I say it will operate all selected files, I mean
  727. that, if you have selected files, it will operate on those selected
  728. files and if you have not selected any, then it will operate on the
  729. presently highlighted file.
  730.  
  731.  
  732. Move:          This will move all selected files to another file area.
  733.                You will be provided with a window that gives you the
  734.                option to remove or accept the presently selected files. It
  735.                will bring up a window to select the area and then, upon
  736.                selection, will move the files. You can press <esc> to
  737.                cancel.
  738.  
  739.  
  740. Contents:      This will un archive the file and then it will display
  741.                the contents of the archive in a window.  You can scroll
  742.                through the display of this window and take a look at all
  743.                the files in the archive.
  744.  
  745.  
  746. Verify:        This will attempt to verify the selected files archive
  747.                using the command given in the MaxFile.cfg
  748.  
  749.  
  750. Re-archive:    This will attempt to change the archive type of the
  751.                selected files. It will even allow you to re-archive to
  752.                the same type (such as changing zip 2.04 to zip 1.10).
  753.                This is done in the background and, as each file is being
  754.                re-archived, the name is displayed at the top of the main
  755.                window on the same line as the word Description.
  756.  
  757.  
  758. Delete:        This will delete the selected files and remove the
  759.                description from the files.bbs.  You will be presented
  760.                with a list of the selected files and will have the
  761.                option of removing files from the list or accept it as
  762.                is.
  763.  
  764.  
  765. vieW:          If you have defined a viewer in the maxfile.cfg, then this
  766.                option will view all the selected files.  As each file
  767.                is is displayed with the external viewer, the file name
  768.                is displayed in the upper right hand corner of the window.
  769.  
  770.  
  771. Touch:         This will attempt to go to go to each file and set the
  772.                last modification date of the file to the present date.
  773.                This will make it show up on a new-files scan by Maximus
  774.  
  775.  
  776. scaN for virii:If you have defined an external virus scanner, this will
  777.                un archive the file to a temporary directory and then it
  778.            scan that directory for any virii.  It will not recurse
  779.                into archives within an archive.
  780.  
  781.  
  782. marK all:      This will mark (select) all files
  783.  
  784.  
  785. Unmark all:    This will unmark (deselect) all files.
  786.  
  787.  
  788. Save:          This will attempt to save the current state of the files.bbs
  789.                It will backup only on the first save (so you can restore 
  790.                the files.bbs to it's original state.
  791.  
  792.  
  793. Insert:        This allows you to put in a file that cannot be adopted
  794.                (not configured for it) or simply to add comments.  To add
  795.                a new comment, simply insert a file with the name "COMMENTS"
  796.  
  797.  
  798. repOsition:    This is how you can move files around within a files.bbs.
  799.                Simply mark the files you want to reposition, and then move
  800.                the highlight to where  you want it to be moved.  Once there
  801.                select <alt-F> O and then it will reposition all the files
  802.                you have selected to before the highlighted file.  You
  803.                cannot reposition files in front of a selected file.
  804.  
  805.  
  806. dupe searcH:   This will search for files that have the same file name
  807.                (up to file extension if desired).  You will be given a chance
  808.                to select a number of areas.  Once you have selected the
  809.                areas, they will be searched for duplicate file names.  Once
  810.                they have been found, you will be given the chance to operate
  811.                on the files that were found.
  812.  
  813.  
  814. Locate:        This option works similarly to Maximus's Locate.  If this
  815.                option is chosen, then you will be prompted for a string.
  816.                MaxFile/2 will then search through all the file.bbs's to 
  817.                to try and find this string as either a file name or as a
  818.                substring of a file's description.  It will then open that
  819.                file area and present the located file at the top of the
  820.                present window.  At this point you are allowed several
  821.                options which can be seen by pressing <F1>
  822.  
  823.  
  824. rEname:        This option will allow you to rename a specific file.  Note
  825.                that MaxFile/2 will allow you to rename a file archive to
  826.                have a name (rename foo.zip to foo.arc) that seems to
  827.                indicate an incorrect archive type
  828.  
  829.  
  830. Exit:          Exit MaxFile/2.  If files are being re-archived, you will
  831.                need to wait for this to complete.  You will be prompted
  832.                to save any changes to the files.bbs.
  833.  
  834.  
  835.  
  836.  
  837. Sort Menu Options:
  838. ------------------
  839.  
  840. This will sort the files.bbs based on Name (increasing/decreasing),
  841. date (increasing/decreasing), or on size (increasing/decreasing).  It
  842. will attempt to leave the comments where they.  If you have selected a
  843. range of files, only that range of files will be sorted.  If, on the
  844. other hand, you have not selected any files, the entire list will be
  845. sorted.
  846.  
  847.  
  848.  
  849.  
  850.  
  851.  
  852. Description Menu Options:
  853. -------------------------
  854.  
  855. This is the other most used area.  It allows you to modify the
  856. description or the comments in the files.bbs.
  857.  
  858.  
  859. Remove:        This will remove the description and the files name.  It
  860.                is useful for "hiding" files from the user but leaving
  861.                them in the directory for later insertion.
  862.  
  863. Edit:          This will bring up a window with the file description
  864.                wrapped for each selected file.  The maximum length is 910
  865.                characters which should be more than enough.  You can
  866.                insert new characters, delete or paste into the window
  867.                (when pasting, the carriage return is interpreted as a space).
  868.                Pressing <F10> accepts the new description and pressing
  869.                <esc> will abort the changes
  870.  
  871. New:           This will bring up a window with an empty file description
  872.                wrapped for each selected file.  The maximum length is 910
  873.                characters which should be more than enough.  You can
  874.                insert new characters, delete or paste into the window
  875.                (when pasting, the carriage return is interpreted as a space).
  876.                Pressing <F10> accepts the new description and pressing
  877.                <esc> will abort the changes
  878.  
  879. Use FILE_ID:   This will attempt to extract the file file_id.diz,
  880.                FILE_ID.DIZ, desc.sdi, or DESC.SDI from the file archive.
  881.                If found, it will use this as the file description with
  882.                all high ascii chars changed to blank space.  If you are
  883.                using Info-ZIP for your unzip-per, the case sensitivity may
  884.                cause it to ignore an enclosed file description if it does
  885.                not fit one of the above formats.  The reason is that
  886.                Info-ZIP came from the UNIX world where case sensitivity
  887.                is much more important.
  888.  
  889. Insert Comment:This will insert a comment line before the current line.
  890.                You can then edit the description field so that the comment
  891.                appears as you wish.
  892.  
  893.  
  894.  
  895.  
  896. dupe searcH and Locate options:
  897. --------------------
  898.  
  899. For the following options, only the 'a' and, of course, <F1> work when
  900. it is presently scanning for files.  Once a duplicate pair has been
  901. found, all of the other options are available.
  902.  
  903. z:         Toggles display of the file size
  904. t:         Toggles the display of the date
  905. w:         Toggles the wrapping of the descriptions
  906. v:         Verifies the archive
  907. c:         Shows the contents of the selected files
  908. e:         Edit the selected description
  909. SPACE:     (de)selects the present file.
  910. d,<alt-d>: Deletes the selected files
  911. r:            Removes the selected descriptions
  912. <esc>:     Exit dupe search mode
  913.  
  914.  
  915.  
  916.  
  917. Main Menu options:
  918. ------------------
  919.  
  920. Many of the keystrokes at the main menu will allow you to perform many
  921. of the above menu options with a single keystroke.  These can be seen
  922. by pressing <F1> which brings up the on-line help.
  923.  
  924.  
  925. "A":         Change area
  926. "]":         Go to next area
  927. "[":         go to previous area
  928. "R":         Re-scan files.bbs from the disk.
  929. "W":         Toggle the wrapping of file descriptions
  930. "D":         Toggle the display of file dates
  931. "Z":         Toggle the display of file size
  932. "TAB":       Switch between file windows
  933. Up, Down:    scroll file list up, Down
  934. Right, Left: grow window rt, left
  935. HOME, END:   go to top, end of list
  936. pgup,pgdown: file list up, down 1 page
  937. "space":     Select or de-select file
  938. ctrl Right:  shrink right side of window
  939. ctrl Left:   shrink left side of window
  940. ctrl PGUP:   Maximize window
  941. ctrl PGUP:   Restore window
  942. <alt-X>:     Exit MaxFIle/2
  943. <alt-E>:     Edit file description(s)
  944. <alt-R>:     remove (delete) file(s)
  945. <alt-N>:     Scan file(s) for virii
  946. <alt-P>:     View picture files
  947. <alt-A>:     Adopt orphans
  948. <alt-C>:     Contents of archive(s)
  949. <alt-V>:     Verify archive(s)
  950. <alt-I>:     use file_Id.diz
  951. <alt-O>:     Reposition file(s)
  952. <alt-UP>:    Grow top of window
  953. <alt-DOWN>:  Grow bottom of window
  954. <ctrl-UP>:   Shrink top of window
  955. <ctrl-DOWN>: Shrink bottom of window
  956. <F2>-<F9>:   Execute the given macro.
  957.  
  958.  
  959.  
  960. So ends the documentation.  If you have any questions that are not
  961. answered by this or the on-line help (press <f1>).  If you have any
  962. further questions or want to make suggestions for improvements to
  963. MaxFIle/2, feel free to contact me at any of the following addresses:
  964.  
  965. Fidonet:  Ronald Van Iwaarden 1:104/338@fidonet.org
  966. Internet: rvaniwaa@carbon.denver.colorado.edu
  967. OS2NET:   Ronald Van Iwaarden 81:313/1@os2net.ftn
  968.  
  969. The internet address is probably most stable but feel free to give all
  970. of them a try.
  971.  
  972. If you have any comments as to MaxFile/2 or the above documentation,
  973. feel free to let me know and I will see what I can do to fix the
  974. problem.  Thanks for using MaxFile/2.
  975.  
  976.  
  977. If you have any questions regarding the PM version of MaxFile, contact
  978. myself or Craig Morrison at the following:
  979.  
  980. Fidonet:  Craig Morrison, 1:201/60@fidonet.org