diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 0905ee21..ae01618a 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -5398,6 +5398,41 @@ alink="#0000FF"> necessary in a different location, the index must be reset.

+

To make a long story short, here follows a script to + create a Recoll + configuration and index under a given directory (given as + single parameter). The resulting data set (files + recoll + directory) can later to be moved to a CDROM or thumb drive. + Longer explanations come after the script.

+
#!/bin/sh
+
+fatal()
+{
+    echo $*;exit 1
+}
+usage()
+{
+    fatal "Usage: init-recoll-volume.sh <top-directory>"
+}
+
+test $# = 1 || usage
+topdir=$1
+test -d "$topdir" || fatal $topdir should be a directory
+
+confdir="$topdir/recoll-config"
+test ! -d "$confdir" || fatal $confdir should not exist
+
+mkdir "$confdir"
+cd "$topdir"
+topdir=`pwd`
+cd "$confdir"
+confdir=`pwd`
+
+(echo topdirs = '"'$topdir'"'; \
+ echo orgidxconfdir = $topdir/recoll-config) > "$confdir/recoll.conf"
+
+recollindex -c "$confdir"
+

The examples below will assume that you have a dataset under /home/me/mydata/, with the index configuration and data stored inside + To make a long story short, here follows a script to create a + &RCL; configuration and index under a given directory (given as single + parameter). The resulting data set (files + recoll directory) can later + to be moved to a CDROM or thumb drive. Longer explanations come after + the script. + + #!/bin/sh + +fatal() +{ + echo $*;exit 1 +} +usage() +{ + fatal "Usage: init-recoll-volume.sh <top-directory>" +} + +test $# = 1 || usage +topdir=$1 +test -d "$topdir" || fatal $topdir should be a directory + +confdir="$topdir/recoll-config" +test ! -d "$confdir" || fatal $confdir should not exist + +mkdir "$confdir" +cd "$topdir" +topdir=`pwd` +cd "$confdir" +confdir=`pwd` + +(echo topdirs = '"'$topdir'"'; \ + echo orgidxconfdir = $topdir/recoll-config) > "$confdir/recoll.conf" + +recollindex -c "$confdir" + + The examples below will assume that you have a dataset under /home/me/mydata/, with the index configuration and data stored inside @@ -4243,7 +4279,7 @@ possible to run queries from a readonly configuration directory (with slightly reduced function of course, such as not recording the query history). - +