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 About the 'rox' script
  54 ~~~~~~~~~~~~~~~~~~~~~~
  55 This is a little PERL script for opening files. It will guess the type of
  56 the file and then find a program to open it with. It is intended to be used
  57 as part of the ROX Desktop:
  58         <http://www.ecs.soton.ac.uk/~tal197/rox.php3>
  59
  60 Note that it requires a little setting up, but after that you can say, eg:
  61
  62         $ rox Picture.gif
  63         (to display the picture)
  64
  65         $ rox /tmp
  66         (shows the /tmp directory in a filer)
  67
  68         $ rox
  69         (opens the current directory)
  70
  71         $ rox -h
  72         (shows the help text)
  73
  74 To install the script, simply put it into a directory in your PATH variable.
  75 '/usr/local/bin' is a good choice, if you have permission to write there.
  76 The install script will do this for you.
  77
  78
  79 Files
  80 ~~~~~
  81
  82 Two places are used for configuration files:
  83
  84 <Choices>/MIME-info/*
  85         Contains the rules for guessing a file's type from its name.
  86         Many programs come with files called '<prog>.mime' which contain
  87         additional rules. Put these files in the MIME-info directory too.
  88
  89 <Choices>/MIME-types/*
  90         Contains programs or symlinks which will be run.
  91         For example:
  92
  93         $ rox picture.gif
  94         is like doing
  95         $ <Choices>/MIME-types/image_gif picture.gif
  96         or, if that isn't found,
  97         $ <Choices>/MIME-types/image picture.gif
  98
  99 In both cases, <Choices> is all the directories in your CHOICESPATH
 100 environment variable, which defaults to:
 101
 102         ~/Choices:/usr/local/share/Choices:/usr/share/Choices
 103
 104 The leftmost directory listed is searched first, followed by the others in
 105 order. If the string starts with a `:' then saving is disabled and no program
 106 will attempt to save any configuration into it. For more details, see:
 107
 108         <http://www.ecs.soton.ac.uk/~tal197/choices.php3>
 109
 110
 111 Conditions
 112 ~~~~~~~~~~
 113 This program is free software; you can redistribute it and/or modify
 114 it under the terms of the GNU General Public License as published by
 115 the Free Software Foundation; either version 2 of the License, or
 116 (at your option) any later version.
 117
 118 This program is distributed in the hope that it will be useful,
 119 but WITHOUT ANY WARRANTY; without even the implied warranty of
 120 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 121 GNU General Public License for more details.
 122
 123 You should have received a copy of the GNU General Public License
 124 along with this program; if not, write to the Free Software
 125 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 126
 127 Please report any bugs to me, <tal197@ecs.soton.ac.uk>.