source: trunk/dll/ipf/config.ipf@ 1036

Last change on this file since 1036 was 994, checked in by Gregg Young, 18 years ago

Updated documentation and def/etc files for 3.10 release

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 21.8 KB
Line 
1:h1 res=92000 name=PANEL_CONFIG.Config Menu
2:i1 id=aboutConfig.Config Menu
3
4:artwork name='bitmaps\tweak.bmp' align=center.
5:p.
6FM/2 can be configured as you like it using the commands under this
7menu. It is highly recommended that you experiment with the items in
8this menu when you first begin to use FM/2, both to familiarize
9yourself with the available configuration options and to make FM/2
10work the way you like it to work.
11:p.
12This menu affects general FM/2 behavior. Each class of container has
13its own configuration menu that allows you to set the type of view,
14filtering, and so on. To get the popup menu that controls the
15container's appearance, request a :link reftype=hd res=93700.context
16menu:elink. while the pointer is over an empty area of the container, or
17select the Views pulldown submenu.
18:p.
19The :link reftype=hd res=94600.Settings notebook:elink. is accessed from
20this menu. You can use the submenu to access the specific page you want
21otherwise it opens to the last page you accessed.
22:p.
23The :link reftype=hd res=100065.Set Target directory:elink. is the next menu
24item and can also be accessed using :color fc=default bc=palegray.Ctrl:color fc=default bc=default.+:color fc=default bc=palegray.T:color fc=default bc=default..
25:p.
26Five menu items to toggle various FM/2 functions on and off are next.
27The first two :link reftype=hd res=91800.Toolbar:elink. and :hp6.Autoview:ehp6.
28have submenus.
29:p.
30The:hp6.Toolbar:ehp6. submenu default is to toggle the toolbar on and off
31The other two items allow you to make the toolbar text only or you can
32add titles under the toolbar icons. Additional functions to edit the toolbar
33can be found on the context menu obtained by clicking :color fc=default bc=cyan.B2:color fc=default bc=default. over a tool icon
34on the toolbar (see :link reftype=hd res=91800.Toolbar:elink. for more information)
35You can switch between toolbars using the dialog that appears if you click :color fc=default bc=cyan.B2:color fc=default bc=default. over
36an area of "white space" on the toolbar or by selecting load toolbox from the previously
37discussed context menu.
38:p.
39The :hp6.Autoview:ehp6. submenu controls the Autoview window. The
40default for this conditional cascade menu is the :hp6.Toggle autoview
41window:ehp6. command, which causes an autoview window to appear above
42the status line at the bottom of the screen. As you move the cursor
43from object to object, FM/2 displays the first few lines of file objects
44in this window. If the autoview window is already displayed, clicking
45this command causes it to disappear. You can also set the what is to
46be autoviewed -- either the file's .COMMENTS EA or the start of the
47file's contents (similar to the *nix HEAD program). When .COMMENTS EAs
48are being viewed, you can edit them and the changes will be saved when
49you switch the focus from the Autoview window. You can reach this
50editable Autoview window with the :color fc=default bc=palegray.Ctrl:color fc=default bc=default. + :color fc=default bc=palegray.Tab:color fc=default bc=default. hotkey if you are allergic
51to your mouse.
52:p.
53Clicking the contents Autoview window with :color fc=default bc=cyan.B1:color fc=default bc=default. causes the file to be
54viewed. Clicking with :color fc=default bc=cyan.B3:color fc=default bc=default. (or :color fc=default bc=cyan.chording:color fc=default bc=default. with :color fc=default bc=cyan.B1:color fc=default bc=default. and :color fc=default bc=cyan.B2:color fc=default bc=default. simultaneously)
55causes the extended attributes to be viewed. If viewing .COMMENTS
56rather than contents, you can pick :hp1.View file:ehp1. from the
57context menu.
58:p.
59The :hp6.:link reftype=hd res=99400.Toggle quicklists:elink.:ehp6.
60command causes a set of dropdown listboxes to appear below the toolbar
61and above other windows. The listboxes include&colon.
62.br
63A Drive Finder dropdown listbox.
64.br
65A States dropdown listbox (Fm/2 configurations you have saved with specific name).
66.br
67A Commands dropdown listbox (External command that have been added to FM/2).
68.br
69A Directory dropdown listbox (Directory names you've assigned in the
70:link reftype=hd res=91500.Walk Directories:elink. dialog).
71.br
72A Toolboxesdropdown listbox also appears if the :hp6.Toolbar:ehp6. is on.
73:p.
74The :hp6.Toggle bottom buttons:ehp6. menu item turns off and on a row of
75buttons that appear just above the status line(s). The buttons display
76the name, date, and attributes of the currently selected object, and the
77filter status of the current container. If clicked with :color fc=default bc=cyan.B1:color fc=default bc=default., a command
78is generated (rename, info, edit date/attributes and filter dialog
79respectively). If clicked with :color fc=default bc=cyan.B2:color fc=default bc=default., a context menu appears (the same one
80you get if you click :color fc=default bc=cyan.B2:color fc=default bc=default. on the first status line). If clicked with :color fc=default bc=cyan.B3:color fc=default bc=default.,
81the sort changes for the current container: filename, last write date,
82file size and reverse sort respectively.
83:p.
84The :hp6.Toggle drivebar:ehp6. menu item turns off and on a bar showing
85all available drives. You can click these drive buttons to find or
86switch to a drive (depending on the active window when the button is
87clicked), drag objects onto the buttons, request a context menu on a
88button for more commands dealing with the drive, or click :color fc=default bc=cyan.B3:color fc=default bc=default. to open a
89Directory Container for that window (or surface and activate one that
90already exists).
91:p.
92The menu also provides access to the dialogs for editing
93:link reftype=hd res=90400.Associations:elink.,
94:link reftype=hd res=90700.Commands:elink. and :hp6.Archivers:ehp6.
95(:link reftype=hd res=94200.Edit Archiver Data:elink.)
96:p.
97To change fonts and colors, FM/2 uses the WPS Font and Color Palettes.
98The Config menu contains commands to call up these objects for you.
99:p.
100
101:p.
102See also&colon.
103.br
104:link reftype=hd res=97600.FM/2 window layout:elink.
105.br
106.im notebook.ipf
107
108:h2 res=100065 name=PANEL_TARGETDIR.Set Target directory
109:i1 id=aboutTargetDir.Set Target directory
110
111You can set a default Target directory with the :hp6.Set Target
112directory:ehp6. command, which FM/2 will use whenever you use the menu
113or accelerator key commands to move or copy file system objects.
114Otherwise, FM/2 will attempt to intelligently guess what you'd like the
115target directory to be each time based on open Directory Containers or
116the currently selected directory in the Drive Tree.
117:p.
118If you have a Target directory already set and wish to clear it,
119select this command, click Cancel at the :link reftype=hd res=91500.Walk
120Directories:elink. dialog that appears, and answer Yes to the question
121subsequently asked.
122:p.
123See also the :link reftype=hd res=99950.General page:elink. of the
124internal Settings notebook.
125
126.im assoc.ipf
127
128.im command.ipf
129
130:h2 res=94200 name=PANEL_AD_FRAME.Editing Archiver Details
131:i1 id=aboutEditArc.Editing Archiver Details
132:p.
133This dialog box, which you can reach from the Config menu, allows you to
134the details of your :link reftype=hd res=100015.archiver:elink.. On the right side are a series of buttons to manage your archivers&colon.
135:p.
136:hp1.Up&colon.:ehp1. Moves the highlighted archiver up in the archive list.
137:p.
138:hp1.Down&colon.:ehp1. Moves the highlighted archiver down in the archive list.
139:p.
140:hp1.Add&colon.:ehp1. Add brings up a blank archiver details box so you can define a new archiver type.
141:p.
142:hp1.Delete&colon.:ehp1. Deletes the archiver description of the highlighted archiver.
143:p.
144:hp1.Revert&colon.:ehp1. Revert undoes all changes made during the current session. It will not undo changes once the new ARCHIVER.BB2 has been written.
145:p.
146
147To open the Archiver details box to edit an existing archiver highlight the archiver and select Okay.
148Entry boxes are present for all the twenty one fields represented in ARCHIVER.BB2
149(the text file that contains control information about your archivers,
150which FM/2 uses to interface with the archivers). It's probably as easy for most people to edit
151:link reftype=hd res=100130.ARCHIVER&period.BB2:elink. directly with a text editor.
152The Cancel button will bring up a dialog asking you if you wish to rewrite ARCHIVER.BB2
153select yes if you do. The new file will be written one generation of backup is kept it is
154named Archiver.BAK
155:p.
156:hp1.NOTE&colon.:ehp1. The simplest method to ensure that your archivers
157work properly with FM/2 is to make sure they're in a directory named in
158your PATH= statement, and check the names of the files to make sure they
159match what's on your system (i.e. UNZIP.EXE in both ARCHIVER.BB2 and on
160your hard disk, not UNZIP.EXE in one and UNZIP32.EXE in another). Alternatively, full path names can be used in ARCHIVER.BB2.
161:p.
162In the event that you attempt to list an archive and FM/2 feels you've
163probably bungled the entry in ARCHIVER.BB2, you'll be given an
164opportunity to use this dialog to fix the entry. In this case, you'll
165see the listbox at the right of the dialog filled with the listing of
166the archive that your archiver made. You can highlight a line and click
167the << button next to the Start List or End List fields to move the line
168to that entry field (these are the most common mistakes, and FM/2 cannot
169find any files if the Start List string is wrong). You can double-click
170on a listbox line to have FM/2 "parse" it into the Fld# text boxes for
171you, to make it easier to judge field positions for sizes, dates, and
172filenames. The filename field in particular is extremely important. If
173it's too high, FM/2 finds no files. If it's "in range" but wrong, FM/2 gets
174the wrong fields for filenames.
175:p.
176You may still need to refer to your archiver's documentation, or run it
177to get the help on its command syntax. FM/2 can't do everything for you,
178but it holds your hand as best it can.
179:p.
180Refer to the ARCHIVER.BB2 file that came with FM/2 for additional
181information and an example.
182:p.
183When you've completed editing the archiver's details, click Okay. FM/2
184will ask you if you want to rewrite ARCHIVER.BB2 (be sure you save the
185original copy for its complete notes; FM/2 will back it up one version to
186ARCHIVER.BAK). If you don't rewrite ARCHIVER.BB2, changes are good only
187for the current session (handy for testing).
188:p.
189You can also get to this dialog box from Select Files' Config submenu.
190:p.
191See also&colon.
192:p.
193:link reftype=hd res=94300.Archiver Details Fields:elink.
194
195:h3 res=94300 name=PANEL_ARCFLDS.Archiver Details Fields
196:i1 id=aboutArcFlds.Archiver Details Fields
197:p.
198:hp2.ID:ehp2. This field contains an ID for the archiver; something for
199human consumption. It's a good idea to include the version number of the
200archiver for reference. An example might be "LHArc 2.11".
201:p.
202:hp2.Add:ehp2. This field should contain the command that creates
203and adds files to an archive. An example might be "PKZIP.EXE -a" (NOTE:
204This example assumes the file is on your PATH (see PATH= in CONFIG.SYS).
205If it's not, you'd need to give a full pathname, like
206"C&colon.\UTILS\PKZIP.EXE -a".) Note that commands should include the
207extension so that FM/2 can check them without guessing. Above this
208field is a button labeled "See." If clicked, the program named in this
209field will be run (you'll be given the opportunity to add arguments to
210the command line) in another window. This lets you check command syntax
211and archiver version, as well as assuring that FM/2 can find your archiver
212executables.
213:p.
214:hp2.Move:ehp2. This field should contain the command that moves files
215to the archive (adds then deletes the file). An example might be
216"ARC.EXE mwn".
217:p.
218:hp2.Extension:ehp2. This field contains the extension normally
219associated with files created by this archiver. An example might be
220"ZOO" for files created by the Zoo archiver.
221:p.
222:hp2.Extract:ehp2. This field contains the command that extracts files
223from the archive. This command should not delete the files from the
224archive when it extracts them, and *must* be present for FM/2 to show you
225a member of the archive (commands other than Extract and List may be
226left blank if necessary). An example might be "PKUNZIP.EXE -o". Note
227the "-o" option given; this tells PKUNZIP to automatically overwrite any
228existing files (FM/2 will check to see if any of the files exist and warn
229you if so). It's important to always include your archiver's "don't
230stop for user input" option; some things occur as detached processes and
231you can't interact with them; the program would be hung, which is
232uncool. Above this field is a button labeled "See." If clicked, the
233program named in this field will be run (you'll be given the opportunity
234to add arguments to the command line) in another window. This lets you
235check command syntax and archiver version.
236:p.
237:hp2.Extract w/Dirs:ehp2. This field contains the command that extracts
238files from the archive and places them into directories embedded in the
239archive. An example might be "LH.EXE x /o /s".
240:p.
241:hp2.Signature:ehp2. This field contains the signature for the archive
242type. There is usually a byte or few in a particular place in any
243archive that indicates that it is, indeed, an archive of that type. FM/2
244uses these signatures to "sniff out" which archiver is used to
245manipulate the archive. Since these signatures sometimes contain
246characters which are "unprintable," you can use \x<hexnum> to represent
247any "strange" characters. A side effect of this is that two backslashes
248are required to represent a single backslash ("\\" == "\"). See
249:link reftype=hd res=99500.C-style encoding:elink. for more information.
250:p.
251To determine what an archiver's signature is, either ask the archiver's
252author or check several different archives of the type for one or more
253bytes present in each at the same location, usually near the beginning
254of the file.
255:p.
256This field must be entered and valid for FM/2 to detect this type of
257archive (see also Sig(nature) Pos(ition)).
258:p.
259:hp2.List:ehp2. This field contains the command to list the archive's
260contents. This command *must* be present and correct for FM/2 to work
261properly with this type of archive. An example might be "ZOO.EXE v".
262:p.
263:hp2.Test:ehp2. This field contains the command to test the archive's
264integrity. An example might be "PKUNZIP.EXE -t".
265:p.
266:hp2.Add with paths:ehp2. This field contains the command to add files
267to the archiver with their paths (i.e. \FM3\FM3.EXE instead of just
268FM3.EXE). This can be omitted if the archiver doesn't support the
269command. An example might be "ZIP.EXE" (Zip defaults to adding paths).
270:p.
271:hp2.Move with paths:ehp2. As above, but moves the files instead of
272just adding them. An example might be "PKZIP -m -P".
273:p.
274:hp2.Add and recurse:ehp2. Adds files to the archive, with paths, and
275recurses into subdirectories. An example might be "LH a /s".
276:p.
277:hp2.Delete:ehp2. This field contains the command to delete files from
278the archive. An example might be "LH.EXE /o /d".
279:p.
280:hp2.Sig(nature) Pos(ition):ehp2. This field contains a number
281indicating how many bytes into the file the signature is located. If
282this number is negative, FM/2 looks from the end of the file instead of
283the beginning.
284:p.
285:hp2.F(ile)Name Pos(ition):ehp2. This field tells FM/2 which field on
286the line of an archive listing is the file name.
287Archive listing fields are numbered from 0.
288The file name position item consists of 4 subfields separated by commas.
289All subfields must be present and correct for FM/2 to get the right
290file names from the archive listing.
291The first is the field number.
292The second is a flag which is set to 1 to indicate that the file
293name is the last field on the line.
294This allows unquoted archive member names to contain spaces
295The third is a flag which is set to 1 to indicate that the file name starts
296at the second character of the field.
297This allows files that are surrounded by unusual bracketing characters.
298The fourth is a flag which is set to 1 to indicate the the file name
299stands alone at the first field in the listing line and
300the file details are on the next line.
301:p.
302To understand what "field on the line of an archive listing" means,
303think of a text line as being broken up into tokens, or words, separated
304by spaces. These tokens, or words, are fields. Therefore,
305:p.
306I like Ike.
307:p.
308contains three fields. Field 0 is "I", field 1 is "like", and field 3
309is "Ike." Think of it like this&colon.
310.br
311:xmp.
312 +--------------------+
313 | 0 | 1 | 2 | Field Numbers
314 +------+------+------+
315 | I | like | Ike | Field Contents
316 +------+------+------+
317:exmp.
318:p.
319:hp2.OldS(i)z(e) Pos(ition):ehp2. This field tells FM/2 which field on
320the line of an archive listing is the old (uncompressed) size of the
321file. If this isn't available or you don't care about it, you can enter
322a -1 to disable detection of this field entirely.
323:p.
324:hp2.NewS(i)z(e) Pos(ition):ehp2. This field tells FM/2 which field on
325the line of an archive listing is the new (compressed) size of the file.
326If this isn't available or you don't care about it, you can enter a -1
327to disable detection of this field entirely.
328:p.
329:hp2.Date Pos(ition):ehp2. This field tells FM/2 which field on
330the line of an archive listing is where the time/datestring is. If this
331isn't available or you don't care about it, you can enter a -1 to
332disable detection of this field entirely. You can optionally follow this
333number with a comma and another number that indicates the type of the
334date from any of the formats in the following list&colon.
335.br
336:xmp.
337 0 = No date in data
338 1 = 02-08-96 23&colon.55&colon.32 mm-dd-yy hh&colon.mm&colon.ss
339 2 = 8 Feb 96 23&colon.55&colon.32 dd-Mmm-yy hh&colon.mm&colon.ss
340 3 = 8 Feb 96 11&colon.55p dd Mmm yy hh&colon.mmA
341 4 = 96-02-08 23&colon.55&colon.32 yy-mm-dd mm&colon.mm&colon.ss
342 5 = 31-02-98 23&colon.55 dd-mm-yy hh&colon.mm
343:exmp.
344:p.
345Dash (-) and slash (/) separators are both supported.
346:p.
347Both 2 digit and 4 digit years are supported.
348:p.
3492 digit years slide about 1980.
350:p.
351:hp2.NumDateF(ie)lds:ehp2. This field tells FM/2 how many fields comprise
352the time/datestring.
353:p.
354:hp2.Start-of-list:ehp2. The line that comes just before the list of
355files in the archiver listing (see example below). You can use the
356:hp2.<<:ehp2. button to insert a selected line directly from the listbox
357into this field.
358:p.
359:hp2.End-of-list:ehp2. The line that comes just after the list of
360files in the archiver listing (see example below). You can use the
361:hp2.<<:ehp2. button to insert a selected line directly from the listbox
362into this field.
363:p.
364Here's an example of an ARC listing (5.12mpl, command "ARC l"; you may
365need to widen the help windows for this to look right...):
366:p.
367:xmp.
368Name Length Date
369============ ======== ========= <--this line is start-of-list
370MAKEFILE 374 28 Nov 89
371QSORT.C 14279 29 Nov 89
372QSORT.EXE 24629 29 Nov 89
373STUFF.H 371 29 Nov 89
374 ==== ======== <--this line is end-of-list
375Total 4 39653
376:exmp.
377:p.
378Note the filename is in position 0, old length in position 1, and the
379date starts in position 2, with 3 parts, and there's no new length
380field (so it'd be -1). Compare that to the archiver entry for
381ARC 5.12mpl in the "stock" ARCHIVER.BB2 and you should get a feel for
382what all those fields mean.
383
384:h4 res=100130 name=PANEL_ARCBB2.ARCHIVER.BB2 Structure
385:i1 id=aboutArcBB2.ArchiverBB2 Structure
386:p.
387The first line in the file is the number of lines/definition in the archiver.bb2 file. It is very important; do not change. It allows modifications to the
388file format to be transparent to older programs.
389
390Format for this archiver.bb2 file (each entry has 21 lines)&colon.
391:p.
3921st line&colon. archiver id (i.e. ARC, LHARC, PKZIP, etc.) for human consumption
393:p.
3942nd line&colon. normal extension for archives without period (i.e ZIP, ARC, LZH)
395:p.
3963rd line&colon. offset into file to signature (leave blank if no signature)
397:p.
3984th line&colon. list command
399:p.
4005th line&colon. extract command
401:p.
4026th line&colon. extract with directories command
403:p.
4047th line&colon. test archive command
405:p.
4068th line&colon. add/create command
407:p.
4089th line&colon. add/create with paths command
409:p.
41010th line&colon. add/create and recurse command
411:p.
41211th line&colon. move command
413:p.
41412th line&colon. move with paths command
415:p.
41613th line&colon. delete command
417:p.
41814th line&colon. signature (case sensitive, leading spaces count!)
419:p.
42015th line&colon. startlist string
421:p.
42216th line&colon. endlist string
423:p.
42417th line&colon. old size position (0-based, -1 = not available)
425:p.
42618th line&colon. new size position (0-based, -1 = not available)
427:p.
42819th line&colon. file date position (0-based, -1 = not available) [,type of date (0 for none)]
429:p.
43020th line&colon. number of elements in dates (for "03 June 92" would be 3)
431:p.
43221st line&colon. file name position (absolutely required, of course; -1 = last pos)[,name is last (1 = TRUE, n/a w/ -1 pos)[name is next line (1 = TRUE)[,name is first line, then rest of data (1 = TRUE)]]]
433:p.
434see ZOO entry for example of -1 in file name position
435:p.
436see LH entry for example of name is last
437:p.
438see RAR 2.00 entry for example of name is first
439:p.
440check listings generated by these programs for clarification
441:p.
442A semicolon marks a comment. They may appear at any point *except*
443within the 21 lines of an archiver definition entry. Comments are ignored.
444Archiver definition entries that contain numeric values may have trailing comments. Archiver definition lines that contain strings do not support trailing comments.
445:p.
446Blank lines are ignored except within a 21 line archiver definition entry. A blank line with a definition entry will be treats as either an empty string or the number 0, depending on what content is expected for the definition line.
447:p.
448Note that all archiver command strings should include the archiver's parameter to
449prevent it from prompting for input! Also note that archive types are checked
450in order of their listing in this file. Finally, this file is set up for
451the archivers I had lying around. If yours are different versions, you may
452have to modify this file. All archivers are OS/2 (or FAPI) versions.
453DOS archivers may work with FM/2, but it'll be up to you to set them up.
454
Note: See TracBrowser for help on using the repository browser.