[GNUnet-SVN] r5051 - gnunet-fuse

[gnunet]

Author: amatus
Date: 2007-06-13 22:45:41 -0600 (Wed, 13 Jun 2007)
New Revision: 5051

Modified:
   gnunet-fuse/README
Log:
Wrote some documentation, pathetic really

Modified: gnunet-fuse/README
===================================================================
--- gnunet-fuse/README  2007-06-14 00:57:30 UTC (rev 5050)
+++ gnunet-fuse/README  2007-06-14 04:45:41 UTC (rev 5051)
@@ -1,2 +1,40 @@
-gnunet-fuse is a FUSE filesystem that provides the contents of a GNUnet
-directory
+                    gnunet-fuse - FUSE filesystem for GNUnet
+
+NOTE: Currently only read-only mounting is supported.
+
+Summary
+=======
+You need the URI of a file with the mime-type of application/gnunet-directory.
+You can either publish a directory with gnunet-insert or do a search for the
+mime-type. To mount the URI use the following command.
+
+$ gnunet-fs gnunet://ecrs/chk/XXXX/YYYY.NNNN /mnt
+
+Where gnunet://ecrs/chk/XXXX/YYYY.NNNN is the URI and /mnt is the mount point.
+I suggest you store your URIs one each to a file and use `cat uri` in place of
+the URI in the example above.
+
+Usage
+=====
+gnunet-fuse [OPTIONS] <URI> <PATH>
+Arguments mandatory for long options are also mandatory for short options.
+  -h, --help                 print this help
+  -c, --config=FILENAME      use configuration file FILENAME
+  -L, --log=LOGLEVEL         configure logging to use LOGLEVEL
+  -l, --logfile=FILE         set logfile name
+  -a, --anonymity=LEVEL      set the desired LEVEL of sender-anonymity
+  -u, --uri-files            Make .uri files visible
+  -x, --Xfuse                Escape fuse option
+
+Example use of -x option:
+$ gnunet-fs -x-o -xfsname=GNUnet <URI> <path>
+Mounts <URI> at <path> and passes "-o fsname=GNUnet" as fuse options.
+
+Special Files
+=============
+Each directory contains the following special files. These files are read-only
+and aren't actually part of the directory, they are generated on-the-fly by
+gnunet-fs.
+
+ .uri        - contains the URI of the directory
+ .uri.<file> - contains the URI of the file named <file> in the directory