README

   1 FSViewer.app
   2 Copyright (c) 1998/1999 George Clernon <clernong@tinet.ie>
   3
   4
   5 Description
   6 ===========
   7 FSViewer is a NeXT FileViewer lookalike for Window Maker. Viewing is
   8 currently supported via browser mode and list mode. It has been written
   9 in C using the WINGs library.
  10
  11 Features
  12 ========
  13 Browser and list modes, DND and file operations. All other features need
  14 to be implemented.
  15
  16
  17 Requirements
  18 ============
  19 o Window Maker v0.60.0 If you use an older version of Window Maker
  20   FSViewer is broken :(
  21 o libProplist. If you have installed Window Maker, you should have it.
  22 o GCC.
  23 0 Version >= 0.2.3b requires WindowMaker >= 0.70.0 but no libProplist
  24
  25
  26 Platforms
  27 =========
  28 Version 0.1.1 compiled on Redhat 5.2 on Intel and Amiga (RH 5.1), SuSE
  29 (unknown version) and Slackware 3.6
  30 Version 0.2.1 compiled on Redhat 5.2 for Intel and Amiga (RH 5.1).
  31 Version 0.2.3b compiled on SuSE 6.4/7.3, Mandrake 8.1 for Intel (with
  32 WindowMaker 0.80.0)
  33
  34
  35 Installation
  36 ============
  37 gunzip and untar FSViewer.app-x.y.z.tar.gz
  38 [prompt]$> tar zxvf FSViewer.app-x.y.z.tar.gz
  39 or
  40 [prompt]$> gunzip FSViewer.app-x.y.z.tar.gz
  41 [prompt]$> tar -xvf FSViewer.app-x.y.z.tar
  42 or
  43 [prompt]$> bunzip2 FSViewer.app-x.y.z.bz2
  44 [prompt]$> tar -xvf FSViewer.app-x.y.z.tar
  45 then
  46 [prompt]$> cd FSViewer.app-x.y.z
  47 [prompt]$> ./configure
  48 [prompt]$> make
  49 if the make goes ok su to root and
  50 [prompt]$> make install
  51 or
  52 [prompt]$> make install-strip
  53 return to normal user mode.
  54
  55 The FSViewer binary (FSViewer) is now in /usr/local/GNUstep/Apps/FSViewer.app
  56
  57
  58 Now copy icons.tar.gz into the install directory, the default is
  59 /usr/local/GNUstep/Apps/FSViewer.app and
  60
  61 [prompt]$> tar zxvf icons.tar.gz
  62 or
  63 [prompt]$> gunzip icons.tar.gz
  64 [prompt]$> tar -xvf icons.tar
  65
  66 Remark: Separate installation of icons is not necessary in
  67 versions >= 0.2.3d, because they have been integrated into the standard
  68 distribution.
  69
  70 If you want to access icons already installed and you want to use the short
  71 naming scheme i.e. no path or extension, the ICONDIR defaults file entry needs
  72 to be set and the files need to have their own directories. So for xpms the
  73 structure is /a/path/specified/in/ICONDIR/xpm and similarly for tiffs
  74 /a/path/specified/in/ICONDIR/tiff.
  75
  76
  77 If you are using LinuxPPC/R4 you will need to use the --with-extralibs option
  78 e.g.
  79
  80 ./configure --with-extralibs="-lXt -lICE -lSM"
  81
  82 Slackware may require something like this:
  83
  84 ./configure --with-extralibs="-lwraster -lgif"
  85
  86 (Could someone confirm that the above examples work?)
  87
  88 For those running on 8bits displays e.g. the Amiga, there is a compile
  89 option --enable-clk when set to no (--enable-clk=no) will disable the
  90 time stamp in the attributes inspector.
  91
  92 If you can't su to root, then use --prefix=/a/dir/you/can/write/to in the
  93 args to ./configure. For example:
  94
  95 [prompt]$> ./configure --prefix=/home/users/clernong/local
  96 [prompt]$> make
  97 [prompt]$> make install
  98 or
  99 [prompt]$> make install-strip
 100
 101 The FSViewer binary (FSViewer) is now in
 102 /home/users/clernong/local/GNUstep/Apps/FSViewer.app
 103
 104 If this is a first time install, just run the app from the prompt. A defaults
 105 file will be automatically created.
 106
 107 If this is an UPGRADE (from FSViewer < 0.2.0), backup your FSViewer defaults file in ~/GNUstep/Defaults and from the compilation directory cd into defs and run chdef. This is required to update the defaults file. Then go and run the app.
 108
 109
 110 Documentation
 111 =============
 112 Documentation is included in the archive (english and french).
 113 Once everything has been installed, start FSViewer.
 114 You should be able to traverse the directory tree. The interface is split in
 115 to 3 sections. The shelf is an area to place frequently accessed directories
 116 or files. The pathview section depicts the current selected path and the
 117 browser columns lists the directory contents of the current selected path.
 118 Icons/Actions/Events can be set in the Inspector Panel.
 119
 120
 121 TODO
 122 ====
 123 There are many things to do. The following is a condensed version of the TODO
 124 list from my scratch pad.
 125
 126 o Revert in the Inspector Panel (partially supported).
 127 o Recycler Support.
 128 o Implement a locate/find dialog. Done but it needs to be customisable.
 129 o Improve the feel of the app.
 130 o Add a panel to allow for 'quick' registering of apps.
 131 o Change cursor during busy periods.
 132 o Add in support for file completion for navigating the columns.
 133 o Provide an interface to PGP to allow for file encryption via FSViewer.
 134 o Implement other viewing modes.
 135 o Implement a full preferences dialog.
 136
 137
 138 Copyright
 139 =========
 140 FSViewer is copyrighted by George Clernon 1998/1999 and is licensed through the
 141 GNU General Public License. Read the COPYING file for the complete license.
 142
 143 The Panel code, libProplist code, browser and lots more are based on
 144 WPrefs.app and the WINGs library which is Copyright (c) 1998 Alfredo K. Kojima
 145 <kojima@windowmaker.org> and licensed through the GNU General Public License.
 146
 147 A lot of the X related code and general structure is based on code copyrighted
 148 by Redback Development Pty Ltd licensed through the GNU General Public License.
 149 Many Thanks to Warp for this.
 150
 151 The file operation and magic files code is based on and taken from Files-2.4f
 152 licensed through the GNU General Public License.
 153
 154 The regexp library included in the distribution for use with the magicfiles
 155 code is copyrighted by University of Toronto. See the README in src/regexp
 156 for more details on the licensing agreement.
 157
 158 The timestampWidget code is available from the widget bazaar at
 159 http://rive.boxybutgood.com. Author is Charles Gamble
 160 <gambcl@cogamble.demon.co.uk> and the original code is by Michael J. Mitchell
 161 <mitch@gw2.redback.com.au>. Further modifications to make it compile under Window Maker v0.60 made by George Clernon.
 162
 163 The original artwork created for FSViewer.app is licensed through the Open
 164 Content License. The artwork includes the folders, my-computer icon and the
 165 FSViewer.app icon. Many thanks to Marco van Hylckama Vlieg
 166 <fatal@global.uibk.ac.at> for providing FSViewer.app with the original artwork.
 167
 168 The french documentation is by Georges Tarbouriech <gete@wanadoo.fr>
 169 Many Thanks to Georges for all the work on the various docs.
 170
 171 Contact
 172 =======
 173 Send comments and bug reports to clernong@tinet.ie