Ignore:
Timestamp:
Dec 8, 2005, 7:15:10 AM (20 years ago)
Author:
root
Message:

Update help text, bitmaps and icons

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/dll/ipf/arclist.ipf

    r108 r268  
    1515:i1 id=aboutArchiveListing.Archive Container
    1616Archive Container windows presents you with a list of an archive's
    17 contents.  The menus available here present you with commands which you
     17contents. The menus available here present you with commands which you
    1818can perform on selected files and the archive as a whole, as well as the
    19 usual configuration of the window's appearance.  You get here by double-
     19usual configuration of the window's appearance. You get here by double-
    2020clicking an archive file in an FM/2 Directory Container window.
    2121:p.
     
    2525Besides the container showing the archive contents and a couple of
    2626informational fields above that, there's an entry field at the bottom of
    27 the window that shows the current :hp1.extract directory:ehp1..  This is
    28 the directory in which any extracted files will be placed.  (Extraction
     27the window that shows the current :hp1.extract directory:ehp1.. This is
     28the directory in which any extracted files will be placed. (Extraction
    2929refers to copying files from the archive onto your disk as normal
    3030files.)  To change the extract directory, enter a new directory into the
     
    3535You can drag files onto the Archive Container's listing to add them to
    3636the archive, and you can drag files from the archive to an FM/2
    37 directory window.  OS/2's drag and drop "rendering" mechanism would make
     37directory window. OS/2's drag and drop "rendering" mechanism would make
    3838this painfully slow for any other application's window, as each file is
    3939processed individually (imagine extracting each file in an archive by
    4040typing a separate command line for each to get an idea how slow it would
    41 be).  The menu extract items allow optimizing extraction so that only
     41be). The menu extract items allows optimizing extraction so that only
    4242one "pass" needs to be done (note that :hp1.Files->Extract:ehp1. must
    4343also deal with the OS/2 command line length restriction of 1024 bytes,
     
    4747around it.
    4848:p.
    49 You can get a popup menu in the container by pressing B2.
     49You can get a context menu in the container by pressing B2.
    5050:p.
    5151Following is a discussion of the pull-down menus:
     
    5454:p.
    5555:hp1.View:ehp1. causes FM/2 to extract the file(s) to a temporary
    56 directory and display it/them.  If, for some reason, the files don't
     56directory and display it/them. If, for some reason, the files don't
    5757appear when you attempt to view them, try :hp1.Test:ehp1.ing the archive.
    5858:p.
    5959:hp1.Edit:ehp1. works as above but the file(s) are loaded into the
    60 configured editor instead of being viewed.  File(s) can then be
    61 :hp1.Refreshed:ehp1. back into the archive.  :hp2.Note&colon.:ehp2.
     60configured editor instead of being viewed. File(s) can then be
     61:hp1.Refreshed:ehp1. back into the archive. :hp2.Note&colon.:ehp2.
    6262Do not attempt to Refresh files that were stored with pathnames.
    6363The pathname will either be lost or an additional file without
     
    7676:p.
    7777:hp1.Exec:ehp1. causes FM/2 to extract all selected files to a temporary
    78 directory and then runs the cursored file.  If you pick this from a
     78directory and then runs the cursored file. If you pick this from a
    7979popup menu, that would be the file under the mouse pointer when you
    80 requested the popup.  This allows you to select DLLs, help files, data
     80requested the popup. This allows you to select DLLs, help files, data
    8181files, etc. required to get the application to run correctly as well as
    8282the executable file.
    8383:p.
    84 :hp1.Print:ehp1. causes FM/2 to extract and print selected files.  This
     84:hp1.Print:ehp1. causes FM/2 to extract and print selected files. This
    8585uses the FM/2 printing method, not the OS/2 printer objects (see
    8686Config->Printer in an FM/2 main window's pulldown menu).
     
    9191:p.
    9292:hp1.Virus Scan:ehp1. causes FM/2 to extract the selected files and then
    93 run the configured virus checker.  See the :hp1.:link reftype=hd
     93run the configured virus checker. See the :hp1.:link reftype=hd
    9494res=92200.internal Settings notebook's Files/Dirs page:elink.:ehp1..
    9595:p.
    9696:hp1.Extract All:ehp1. extracts all files from the archive to the
    97 extract directory.  :hp1.Extract All &amp. Exit:ehp1. does the
     97extract directory. :hp1.Extract All &amp. Exit:ehp1. does the
    9898same thing but closes the archive listing window after starting the
    9999extraction.
     
    104104directory). :hp1.Extract All w/ Dirs &amp. Exit:ehp1. does the same
    105105thing but closes the archive listing window after starting the
    106 extraction.  (:hp2.Note:ehp2. that if all you want to do to an archive
     106extraction. (:hp2.Note:ehp2. that if all you want to do to an archive
    107107is extract from it, you can do so without ever opening a contents box;
    108108just pull up a context menu on the archive in an FM/2 main window and
    109 select :hp1.Extract:ehp1..  This is the fastest and most efficient
     109select :hp1.Extract:ehp1.. This is the fastest and most efficient
    110110method of extracting files from an archive.)
    111111:p.
     
    121121:hp2.Archivers:ehp2. are programs that create files composed of
    122122(usually) compressed data that represents, and allows recreation of,
    123 normal (uncompressed) files.  These archiver programs are widely used to
    124 create archive files for downloading from BBSs, information services and
     123normal (uncompressed) files. These archiver programs are widely used to
     124create archive files for downloading from
    125125the Internet, and to extract from those archive files once downloaded.
    126126They're also used to create archives locally for backup purposes, as the
     
    148148:pt.&period.ARC
    149149:pd.Arc
     150:pt.&period.TAR
     151:pd.Tar
    150152:eparml.
    151153:p.
     
    153155where the * will be a number indicating the version of the program.
    154156These are self-extracting archives (archives that extract themselves
    155 when you run the .EXE) so you don't get a chicken-or-egg scenario.  You
    156 can find them on BBSs, information services and the Internet -- in other
     157when you run the .EXE) so you don't get a chicken-or-egg scenario. You
     158can find them on the Internet (Hobbes) -- in other
    157159words, you can find them the same places where archive files are most
    158 often used.
     160often found.
    159161:p.
    160 FM/2 can work with DOS archivers, but they aren't supported.  If you
     162FM/2 can work with DOS archivers, but they aren't supported. If you
    161163decide you want to use your DOS archivers rather than OS/2 native
    162164archive programs, you'll have to figure it out on your own (see
     
    164166the ARCHIVER.BB2 datafile that came with FM/2).
    165167
    166 :h2 res=94200 name=PANEL_AD_FRAME.Editing Archiver Details
    167 :i1 id=aboutEditArc.Editing Archiver Details
    168 :p.
    169 This dialog box, which you can reach from the Config menu, allows you to
    170 edit the details of an :link reftype=hd res=10015.archiver:elink.. Entry
    171 boxes are present for all the twenty one fields represented in
    172 ARCHIVER.BB2 (the text file that contains control information about your
    173 archivers which FM/2 uses to interface with the archivers).  It's
    174 probably easier for most people to edit ARCHIVER.BB2 directly with a
    175 text editor.
    176 :p.
    177 :hp1.NOTE&colon.:ehp1.  The simplest method to ensure that your archivers
    178 work properly with FM/2 is to make sure they're in a directory named in
    179 your PATH= statement, and check the names of the files to make sure they
    180 match what's on your system (i.e. UNZIP.EXE in both ARCHIVER.BB2 and on
    181 your hard disk, not UNZIP.EXE in one and UNZIP32.EXE in another).
    182 :p.
    183 In the event that you attempt to list an archive and FM/2 feels you've
    184 probably bungled the entry in ARCHIVER.BB2, you'll be given an
    185 opportunity to use this dialog to fix the entry.  In this case, you'll
    186 see the listbox at the right of the dialog filled with the listing of
    187 the archive that your archiver made.  You can highlight a line and click
    188 the << button next to the Start List or End List fields to move the line
    189 to that entry field (these are the most common mistakes, and FM/2 cannot
    190 find any files if the Start List string is wrong).  You can double-click
    191 on a listbox line to have FM/2 "parse" it into the Fld# text boxes for
    192 you, to make it easier to judge field positions for sizes, dates, and
    193 filenames.  The filename field in particular is extremely important.  If
    194 it's too high, FM/2 finds no files.  If it's "in range" but wrong, FM/2 gets
    195 the wrong fields for filenames.
    196 :p.
    197 You may still need to refer to your archiver's documentation, or run it
    198 to get the help on its command syntax.  FM/2 can't do everything for you,
    199 but it holds your hand as best it can.
    200 :p.
    201 Refer to the ARCHIVER.BB2 file that came with FM/2 for additional
    202 information and an example.
    203 :p.
    204 When you've completed editing the archiver's details, click Okay.  FM/2
    205 will ask you if you want to rewrite ARCHIVER.BB2 (be sure you save the
    206 original copy for its complete notes; FM/2 will back it up one version to
    207 ARCHIVER.BAK).  If you don't rewrite ARCHIVER.BB2, changes are good only
    208 for the current session (handy for testing).
    209 :p.
    210 You can also get to this dialog box from Select Files' Config submenu.
    211 :p.
    212 See also&colon.
    213 :p.
    214 :link reftype=hd res=94300.Archiver Details Fields:elink.
    215 
    216 :h3 res=94300 name=PANEL_ARCFLDS.Archiver Details Fields
    217 :i1 id=aboutArcFlds.Archiver Details Fields
    218 :p.
    219 :hp2.ID:ehp2.  This field contains an ID for the archiver; something for
    220 human consumption.  It's a good idea to include the version number of the
    221 archiver for reference.  An example might be "LHArc 2.11".
    222 :p.
    223 :hp2.Add:ehp2.  This field should contain the command that creates
    224 and adds files to an archive.  An example might be "PKZIP.EXE -a" (NOTE:
    225 This example assumes the file is on your PATH (see PATH= in CONFIG.SYS).
    226 If it's not, you'd need to give a full pathname, like
    227 "C&colon.\UTILS\PKZIP.EXE -a".) Note that commands should include the
    228 extension so that FM/2 can check them without guessing.  Above this
    229 field is a button labeled "See." If clicked, the program named in this
    230 field will be run (you'll be given the opportunity to add arguments to
    231 the command line) in another window. This lets you check command syntax
    232 and archiver version, as well as assuring that FM/2 can find your archiver
    233 executables.
    234 :p.
    235 :hp2.Move:ehp2.  This field should contain the command that moves files
    236 to the archive (adds then deletes the file).  An example might be
    237 "ARC.EXE mwn".
    238 :p.
    239 :hp2.Extension:ehp2.  This field contains the extension normally
    240 associated with files created by this archiver.  An example might be
    241 "ZOO" for files created by the Zoo archiver.
    242 :p.
    243 :hp2.Extract:ehp2.  This field contains the command that extracts files
    244 from the archive.  This command should not delete the files from the
    245 archive when it extracts them, and *must* be present for FM/2 to show you
    246 a member of the archive (commands other than Extract and List may be
    247 left blank if necessary).  An example might be "PKUNZIP.EXE -o".  Note
    248 the "-o" option given; this tells PKUNZIP to automatically overwrite any
    249 existing files (FM/2 will check to see if any of the files exist and warn
    250 you if so).  It's important to always include your archiver's "don't
    251 stop for user input" option; some things occur as detached processes and
    252 you can't interact with them; the program would be hung, which is
    253 uncool. Above this field is a button labeled "See." If clicked, the
    254 program named in this field will be run (you'll be given the opportunity
    255 to add arguments to the command line) in another window. This lets you
    256 check command syntax and archiver version.
    257 :p.
    258 :hp2.Extract w/Dirs:ehp2.  This field contains the command that extracts
    259 files from the archive and places them into directories embedded in the
    260 archive.  An example might be "LH.EXE x /o /s".
    261 :p.
    262 :hp2.Signature:ehp2.  This field contains the signature for the archive
    263 type.  There is usually a byte or few in a particular place in any
    264 archive that indicates that it is, indeed, an archive of that type.  FM/2
    265 uses these signatures to "sniff out" which archiver is used to
    266 manipulate the archive.  Since these signatures sometimes contain
    267 characters which are "unprintable," you can use \x<hexnum> to represent
    268 any "strange" characters.  A side effect of this is that two backslashes
    269 are required to represent a single backslash ("\\" == "\").  See
    270 :link reftype=hd res=99500.C-style encoding:elink. for more information.
    271 :p.
    272 To determine what an archiver's signature is, either ask the archiver's
    273 author or check several different archives of the type for one or more
    274 bytes present in each at the same location, usually near the beginning
    275 of the file.
    276 :p.
    277 This field must be entered and valid for FM/2 to detect this type of
    278 archive (see also Sig(nature) Pos(ition)).
    279 :p.
    280 :hp2.List:ehp2.  This field contains the command to list the archive's
    281 contents.  This command *must* be present and correct for FM/2 to work
    282 properly with this type of archive.  An example might be "ZOO.EXE v".
    283 :p.
    284 :hp2.Test:ehp2.  This field contains the command to test the archive's
    285 integrity.  An example might be "PKUNZIP.EXE -t".
    286 :p.
    287 :hp2.Add with paths:ehp2.  This field contains the command to add files
    288 to the archiver with their paths (i.e. \FM3\FM3.EXE instead of just
    289 FM3.EXE).  This can be omitted if the archiver doesn't support the
    290 command.  An example might be "ZIP.EXE" (Zip defaults to adding paths).
    291 :p.
    292 :hp2.Move with paths:ehp2.  As above, but moves the files instead of
    293 just adding them.  An example might be "PKZIP -m -P".
    294 :p.
    295 :hp2.Add and recurse:ehp2.  Adds files to the archive, with paths, and
    296 recurses into subdirectories.  An example might be "LH a /s".
    297 :p.
    298 :hp2.Delete:ehp2.  This field contains the command to delete files from
    299 the archive.  An example might be "LH.EXE /o /d".
    300 :p.
    301 :hp2.Sig(nature) Pos(ition):ehp2.  This field contains a number
    302 indicating how many bytes into the file the signature is located.  If
    303 this number is negative, FM/2 looks from the end of the file instead of
    304 the beginning.
    305 :p.
    306 :hp2.F(ile)Name Pos(ition):ehp2.  This field tells FM/2 which field on
    307 the line of an archive listing is the file name.
    308 Archive listing fields are numbered from 0.
    309 The file name position item consists of 4 subfields separated by commas.
    310 All subfields must be present and correct for FM/2 to get the right
    311 file names from the archive listing.
    312 The first is the field number.
    313 The second is a flag which is set to 1 to indicate that the file
    314 name is the last field on the line.
    315 This allows unquoted archive member names to contain spaces
    316 The third is a flag which is set to 1 to indicate that the file name starts
    317 at the second character of the field.
    318 This allows files that are surrounded by unusual bracketing characters.
    319 The fourth is a flag which is set to 1 to indicate the the file name
    320 stands alone at the first field in the listing line and
    321 the file details are on the next line.
    322 :p.
    323 To understand what "field on the line of an archive listing" means,
    324 think of a text line as being broken up into tokens, or words, separated
    325 by spaces.  These tokens, or words, are fields.  Therefore,
    326 :p.
    327 I like Ike.
    328 :p.
    329 contains three fields.  Field 0 is "I", field 1 is "like", and field 3
    330 is "Ike."  Think of it like this&colon.
    331 .br
    332 :xmp.
    333  +--------------------+
    334  |  0   |  1   |  2   | Field Numbers
    335  +------+------+------+
    336  |  I   | like | Ike  | Field Contents
    337  +------+------+------+
    338 :exmp.
    339 :p.
    340 :hp2.OldS(i)z(e) Pos(ition):ehp2.  This field tells FM/2 which field on
    341 the line of an archive listing is the old (uncompressed) size of the
    342 file.  If this isn't available or you don't care about it, you can enter
    343 a -1 to disable detection of this field entirely.
    344 :p.
    345 :hp2.NewS(i)z(e) Pos(ition):ehp2.  This field tells FM/2 which field on
    346 the line of an archive listing is the new (compressed) size of the file.
    347 If this isn't available or you don't care about it, you can enter a -1
    348 to disable detection of this field entirely.
    349 :p.
    350 :hp2.Date Pos(ition):ehp2.  This field tells FM/2 which field on
    351 the line of an archive listing is where the time/datestring is.  If this
    352 isn't available or you don't care about it, you can enter a -1 to
    353 disable detection of this field entirely.  You can optionally follow this
    354 number with a comma and another number that indicates the type of the
    355 date from any of the formats in the following list&colon.
    356 .br
    357 :xmp.
    358  1.  02-08-96  23&colon.55&colon.32
    359  2.   8 Feb 96 23&colon.55&colon.32
    360  3.   8 Feb 96  11&colon.55p
    361  4.  96-02-08 23&colon.55&colon.32
    362 :exmp.
    363 :p.
    364 :hp2.NumDateF(ie)lds:ehp2.  This field tells FM/2 how many fields comprise
    365 the time/datestring.
    366 :p.
    367 :hp2.Start-of-list:ehp2.  The line that comes just before the list of
    368 files in the archiver listing (see example below).  You can use the
    369 :hp2.<<:ehp2. button to insert a selected line directly from the listbox
    370 into this field.
    371 :p.
    372 :hp2.End-of-list:ehp2.  The line that comes just after the list of
    373 files in the archiver listing (see example below).  You can use the
    374 :hp2.<<:ehp2. button to insert a selected line directly from the listbox
    375 into this field.
    376 :p.
    377 Here's an example of an ARC listing (5.12mpl, command "ARC l"; you may
    378 need to widen the help windows for this to look right...):
    379 :p.
    380 :xmp.
    381 Name          Length    Date
    382 ============  ========  =========    <--this line is start-of-list
    383 MAKEFILE           374  28 Nov 89
    384 QSORT.C          14279  29 Nov 89
    385 QSORT.EXE        24629  29 Nov 89
    386 STUFF.H            371  29 Nov 89
    387         ====  ========               <--this line is end-of-list
    388 Total      4     39653
    389 :exmp.
    390 :p.
    391 Note the filename is in position 0, old length in position 1, and the
    392 date starts in position 2, with 3 parts, and there's no new length
    393 field (so it'd be -1).  Compare that to the archiver entry for
    394 ARC 5.12mpl in the "stock" ARCHIVER.BB2 and you should get a feel for
    395 what all those fields mean.
    396168
    397169:h2 res=98300 name=PANEL_ARCERR.Archive Errors
    398170:i1 id=aboutArchiveErrors.Archive Errors
    399171Sometimes FM/2 can't get information from the archiver about an archive.
    400 There are a couple of reasons this could happen&colon.  The information
     172There are a couple of reasons this could happen&colon. The information
    401173in ARCHIVER.BB2 may be incorrect for the archive type, or the archive may
    402 be damaged.  Possibly the file "smelled" like an archive but wasn't.
     174be damaged. Possibly the file "smelled" like an archive but wasn't.
    403175Perhaps you selected :hp1.View->As archive:ehp1. on a file that wasn't
    404176actually an archive.
    405177:p.
    406 When this happens, this dialog appears.  You'll be given as much
     178When this happens, this dialog appears. You'll be given as much
    407179information as possible, including the text of what the archiver had to
    408180say about the archive when it was asked to list its contents, presented
    409 in an MLE, and allowed four choices&colon.  :link reftype=hd
     181in an MLE, and allowed four choices&colon. :link reftype=hd
    410182res=94200.Edit the archiver details:elink., Test the archive (if you
    411183have told FM/2 how to test archives with this archiver in ARCHIVER.BB2),
    412184View the archive, or Cancel the whole thing.
    413185:p.
    414 Generally speaking, first Test the archive.  If the archive is okay or
     186Generally speaking, first Test the archive. If the archive is okay or
    415187if the test won't run at all, the problem is most likely in your archive
    416 information record in ARCHIVER.BB2.  You can View the archive to assure
     188information record in ARCHIVER.BB2. You can View the archive to assure
    417189yourself that it is, in fact, an archive, and perhaps hunt down the
    418190signature so you can add it to ARCHIVER.BB2 if it's not a listed archive
Note: See TracChangeset for help on using the changeset viewer.