docs/README.en

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