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 have 'autoconf' installed
  25 before you can compile (the snapshots on the FTP site don't require this).
  26
  27 You will also need to run 'make' in the 'ROX-Filer/src/Docs' directory
  28 to get the manual created in 'ROX-Filer/Help', and also run 'dist' in
  29 'ROX-Filer/src/po' to get the translations.
  30
  31 Instructions on getting rox via CVS can be found at:
  32
  33         http://sourceforge.net/cvs/?group_id=7023
  34
  35 Once you have a version of rox from CVS you can update it by simply doing
  36
  37         $ cvs -z3 update
  38
  39 from inside the 'rox' directory.
  40
  41 Finally, remember that the CVS version is the very latest developer code. It
  42 has not been well tested. It may have bugs. It may not even compile. You
  43 have been warned! (but please report any bugs you find)
  44
  45
  46 ROX-Filer
  47 ~~~~~~~~~
  48 Help for ROX-Filer can be found in the directory ROX-Filer/Help.
  49
  50
  51 Files
  52 ~~~~~
  53
  54 Two places are used for MIME-handling configuration files:
  55
  56 <Choices>/MIME-info/*
  57         Contains the rules for guessing a file's type from its name.
  58         Many programs come with files called '<prog>.mime' which contain
  59         additional rules. Put these files in the MIME-info directory too.
  60
  61 <Choices>/MIME-types/*
  62         Contains programs or symlinks which will be run.
  63         For example:
  64
  65         $ rox picture.gif
  66         is like doing
  67         $ <Choices>/MIME-types/image_gif picture.gif
  68         or, if that isn't found,
  69         $ <Choices>/MIME-types/image picture.gif
  70
  71 In both cases, <Choices> is all the directories in your CHOICESPATH
  72 environment variable, which defaults to:
  73
  74         ~/Choices:/usr/local/share/Choices:/usr/share/Choices
  75
  76 The leftmost directory listed is searched first, followed by the others in
  77 order. If the string starts with a `:' then saving is disabled and no program
  78 will attempt to save any configuration into it. For more details, see:
  79
  80         <http://rox.sourceforge.net/choices.php3>
  81
  82
  83 Conditions
  84 ~~~~~~~~~~
  85 This program is free software; you can redistribute it and/or modify
  86 it under the terms of the GNU General Public License as published by
  87 the Free Software Foundation; either version 2 of the License, or
  88 (at your option) any later version.
  89
  90 This program is distributed in the hope that it will be useful,
  91 but WITHOUT ANY WARRANTY; without even the implied warranty of
  92 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  93 GNU General Public License for more details.
  94
  95 You should have received a copy of the GNU General Public License
  96 along with this program; if not, write to the Free Software
  97 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  98
  99
 100 Please report any bugs to the mailing list:
 101
 102         http://rox.sourceforge.net/contact.php3