README

   1                         ROX-Filer
   2                         A RISC OS-like filer for X
   3                         by Thomas Leonard
   4
   5
   6
   7 Quick start
   8 ~~~~~~~~~~~
   9 Type this ($ is the shell prompt):
  10
  11         $ ./install.sh
  12
  13 and follow the on-screen instructions. If you want to compile as a normal
  14 user and install as root then you should do this instead:
  15
  16         $ ROX-Filer/AppRun --compile
  17         $ su
  18         [ enter root password ]
  19         $ ./install.sh
  20
  21
  22 CVS notes
  23 ~~~~~~~~~
  24 If you got this from CVS then you'll need to run 'autoconf' before you can
  25 compile:
  26
  27         $ cd ROX-Filer/src
  28         $ autoconf
  29
  30 You will also need to create the postscript manual from the Lyx file and
  31 run 'dist' in 'ROX-Filer/src/po' to get the translations.
  32
  33 Instructions on getting rox via CVS can be found at:
  34
  35         http://sourceforge.net/cvs/?group_id=7023
  36
  37 Once you have a version of rox from CVS you can update it by simply doing
  38
  39         $ cvs -z3 update
  40
  41 from inside the 'rox' directory.
  42
  43 Finally, remember that the CVS version is the very latest developer code. It
  44 has not been well tested. It may have bugs. It may not even compile. You
  45 have been warned!
  46
  47
  48 ROX-Filer
  49 ~~~~~~~~~
  50 Help for ROX-Filer can be found in the directory ROX-Filer/Help.
  51
  52
  53 Files
  54 ~~~~~
  55
  56 Two places are used for configuration files:
  57
  58 <Choices>/MIME-info/*
  59         Contains the rules for guessing a file's type from its name.
  60         Many programs come with files called '<prog>.mime' which contain
  61         additional rules. Put these files in the MIME-info directory too.
  62
  63 <Choices>/MIME-types/*
  64         Contains programs or symlinks which will be run.
  65         For example:
  66
  67         $ rox picture.gif
  68         is like doing
  69         $ <Choices>/MIME-types/image_gif picture.gif
  70         or, if that isn't found,
  71         $ <Choices>/MIME-types/image picture.gif
  72
  73 In both cases, <Choices> is all the directories in your CHOICESPATH
  74 environment variable, which defaults to:
  75
  76         ~/Choices:/usr/local/share/Choices:/usr/share/Choices
  77
  78 The leftmost directory listed is searched first, followed by the others in
  79 order. If the string starts with a `:' then saving is disabled and no program
  80 will attempt to save any configuration into it. For more details, see:
  81
  82         <http://rox.sourceforge.net/choices.php3>
  83
  84
  85 Conditions
  86 ~~~~~~~~~~
  87 This program is free software; you can redistribute it and/or modify
  88 it under the terms of the GNU General Public License as published by
  89 the Free Software Foundation; either version 2 of the License, or
  90 (at your option) any later version.
  91
  92 This program is distributed in the hope that it will be useful,
  93 but WITHOUT ANY WARRANTY; without even the implied warranty of
  94 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  95 GNU General Public License for more details.
  96
  97 You should have received a copy of the GNU General Public License
  98 along with this program; if not, write to the Free Software
  99 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 100
 101 Please report any bugs to me, <tal197@users.sourceforge.net>.