Initial repo
[fsviewer.git] / man / fsviewer.1x
blob0d11083067e62becd715e67204cd80689902d1cd
1 .\" Man page for fsviewer
2 .\"
3 .\" Hacked from the:
4 .\" Man page for fsviewer
5 .\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
6 .\"
7 .\" You may distribute under the terms of the GNU General Public
8 .\" License 
9 .\"
10 .TH fsviewer 1x "July 1st, 1999" "NeXT fileviewer lookalike"
11 .SH NAME
12 fsviewer \- a NeXT fileviewer lookalike
13 .SH SYNOPSIS
14 .\" The general command line
15 .B fsviewer 
16 .SH DESCRIPTION
17 .B fsviewer 
18 is a NeXT fileviewer lookalike designed to work with
19 the Window Maker window manager. It features 
20 Browser mode, DND and file operations.
22 .SH "THE INTERFACE"
24 The interface is split into 3 sections. 
25 The shelf is an area to place frequently accessed directories 
26 or files. The pathview section depicts the current selected path and the 
27 browser columns lists the directory contents of the current selected path. 
28 Icons/Actions/Events can be set in the Inspector Panel.
30 .SH "KEY BINDINGS"
31 All keys bindings can only be accessed in combination with the Meta key.
32 In systems without a Meta key, this should be the Alt key.
34 .SH "MOUSE CLICKS"
35 Clicking on an entry in a browser column will update the scroll view with the
36 new selection and if the selection is a directory, it will fill the next 
37 column. It will then scroll the browser/pathview accordingly.
39 Double-clicking on an entry in the pathview/browser will execute it if it is 
40 executable or launch the associated editor/viewer. 
42 Ctrl-MouseClick over an icon in the shelf will remove it from the shelf.
44 .SH INSPECTOR
45 The inspector contains 6 different panels:
47 .Bl -bullet
48 .It Attributes
49 The attributes panel displays the file permissions, the last changed date,
50 file size, owner and group. The link section is not working.
52 .Bl -bullet
53 .It Icon
54 The icon panel allows an icon to be selected for the current extension.  If 
55 the file does not have an extension it will be associated with the full
56 filename. The paths used are read from the Window Maker defaults domain. To add
57 paths either edit the Window Maker defaults file or use WPrefs.app. 
58 Click 'OK' to set the new icon. 
60 .Bl -bullet
61 .It Viewer
62 The viewer panel allows for the selection of the default viewer to be 
63 associated with the file extension. The list all the executables registered 
64 with FSViewer.
66 .Bl -bullet
67 Editor
68 4) The editor is the same as the Viewer. This becomes useful when a
69 file requires a separate editor e.g. HTML files.
71 .Bl -bullet 
72 .It Executable
73 The executable panel allows a command to be associated with the file. 
74 This panel is only accessible when the file is executable. Three shortcuts 
75 have been provided. %p for the current path, %f for the current filename and 
76 %s for the filename to be passed as an arg to the program. For example if 
77 /usr/bin/xemacs was selected:
79        %p = /usr/bin/
80        %f = xemacs
82 And a possible command could be:
84        %p%f %s
86 which translates to
88        /usr/bin/xemacs %s
90 Any file that has xemacs as it's default viewer/editor will use this command
91 where %s is replaced with the full path and filename.
93 .Bl -bullet
94 .It File Extensions
95 The file extension panel provides a method for associating file extensions
96 with an app. An extension MUST start with a '.'. If a new extension 
97 is entered its icon may be set from this panel.
99 .SH "Magic Files"
100 Rudimentary magic file support is available -- the app will try to 
101 figure out what type the file is if it is unknown. It will then do something
102 based on the file type. There are 3 cases:
105 If it is ascii, xedit is started.
107 If it is an image, xv is started.
109 If it is a ps file, ghostview is started.
111 To change these settings, edit the defaults file in 
112 .I ~/GNUstep/Defaults.
115 .SH DnD
116 A port of the OffiX DnD library is being used in this app. The port has been 
117 undertaken by Igor Roboul. OffiX DnD is supported by Window Maker so you can
118 drop things on the dock/clip. Also icons can be dragged from the pathview to a 
119 folder or to the shelf, dragging to a folder causes the item to be moved into
120 that folder. Presing the Shift key while dragging will cause the item to be
121 copied.
124 .SH "Mounting Devices"
126 The app provides rudimentary support for mounting, unmounting and ejecting 
127 file systems. A sample defaults file entry is provided below.
129   DISKS = {
130     devices = ((CDROM, "/cdrom", "/dev/hdc"), \\
131     (Zip, "/dosz", "/dev/sda4"));
132     mount = "mount %s";
133     umount = "umount %s";
134     eject = "eject %s";
135   };
137 At the moment any errors from the commands are not detected.
140 .SH "File Settings"
141 When an unknown file type is encountered a window will pop up prompting you
142 for a command. For example if the file is a jpeg the command may be:
144        xv %s
146 where %s will be replaced with the filename when the app comes across a jpeg 
147 type file. To pass something as one arguement, just wrap it in double quotes
150        app "-p foo"
152 The "-p foo" will be passed as one arguement.
155 .SH Preferences
156 Sometimes it may be easier to edit the defaults file 
158 .I ~/GNUstep/Defaults/FSViewer
159 ) than to work with the app. Also there are some 
160 options that the currently sparse Preferences Dialog does not know about. 
161 It is worth looking at the file to see what can be changed. A more 
162 comprehensive Preferences Dialog Box, that will allow access to most if not all
163 of the defaults file, is planned for the next version.
164 Make sure to backup the defaults file if you plan to edit it by hand!
166 .SH FILES
168 .I /etc/GNUstep/Defaults/FSViewer
169 the systemwide configuration file.
171 .I ~/GNUstep/Defaults/FSViewer
172 a user's personal configuration file.
174 .SH BUGS
175 The link section under Attributes doesn't work.
177 Many features remain unimplemented.  A list of these from the 
178 .B fsviewer
179 README file:
181 Revert in the Inspector Panel (partially supported).
182 .TP 
183 Recycler Support.
185 Implement a locate/find dialog. Done but it needs to be customizable.
187 Improve the feel of the app.
189 Add a panel to allow for 'quick' registering of apps.
191 Change cursor during busy periods.
193 Add in support for file completion for navigating the columns.
195 Provide an interface to PGP to allow for file encryption via FSViewer.
197 Implement other viewing modes.
199 Implement a full preferences dialog.
201 Revert in the Inspector Panel (partially supported).
203 Send comments and bug reports to <clernong@tinet.ie>.
205 .SH "SEE ALSO"
206 .BR wmaker (1x), 
207 .SH AUTHORS
208 .B fsviewer 
209 is Copyright 1998/1999 George Clernon <clernong@tinet.ie>
210 and was written by George Clernon.
212 This manpage was adapted from the 
213 .B fsviewer
214 README file by Will Lowe <lowe@debian.org> for the Debian GNU/Linux distribution.