Added man page.

git-svn-id: http://svn.code.sf.net/p/wikipediafs/code/trunk@10 59acd704-e115-0410-a914-e735a229ed7c

1 files changed, 6 insertions, 147 deletions

diff --git a/README b/README
index 3982d2f..8fb0d1a 100644
--- a/README
+++ b/README
@@ -16,149 +16,20 @@ Install
 ($ su)
 # python setup.py install
 
-Configuration
--------------
+Manual
+------
 
-The first time WikipediaFS is run, an XML configuration file is generated in
-~/.wikipediafs/config.xml. You can then edit it to add more Wikipedia or
-Mediawiki-based sites. Each site has a site entry defined as follows:
+$ man mount.wikipediafs
 
-<site>
-    <dirname>wikipedia-fr</dirname>
-    <host>fr.wikipedia.org</host>
-    <basename>/w/index.php</basename>
-    <username>Username</username>
-    <password>Password</password>
-</site>
-
-* dirname 
-
-Is the name of the directory through which you will access to the site.
-
-* host
-
-Is the host of the site.
-
-* basename
-
-Is the base of urls used by the site. Most of the time, it will be
-/dir/where/mediawiki/is/installed/index.php. For Wikipedia, it will be
-/w/index.php.
-
-* username and password
-
-Are optional and enable you to edit articles with your login.
-
-It is recommended to test WikipediaFS with a test site first. You can use
-mblondel.org, which is set with the default config, for this purpose.
-URL : http://www.mblondel.org/mediawiki/
-
-Mount
------
-
-$ mkdir ~/wfs/
-
-$ mount.wikipediafs ~/wfs/
-
-To run mount.wikipediafs without root privileges, you may have to set the right
-permissions for /usr/bin/fusermount and /dev/fuse if your distribution has not
-already done it for you. For example,
-
-# adduser your_username fuse
-# chmod 4750 /usr/bin/fusermount
-# chgrp fuse /dev/fuse /usr/bin/fusermount
-
-(You may have to log out and log in again so that changes are taken into
-account.)
-
-Unmount
--------
-
-$ fusermount -u ~/wfs/
-
-fstab
------
-
-Alternatively, you can mount WikipediaFS through fstab.
-
-To do so, add this line to /etc/fstab:
-
-none /mnt/wfs/ wikipediafs noauto,nouser,home=/home/your_username/
-
-Replace noauto by auto if you want WikipediaFS to be mounted at boot.
-Replace nouser by user if you want to allow simple users to use WikipediaFS.
-Replace /home/your_username/ by your home directory.
-
-The right permissions have to be set on the mounted directory (e.g. /mnt/wfs/).
-
-Then, you can use the following commands to mount and unmount WikipediaFS:
-
-$ mount /mnt/wfs/
-# umount /mnt/wfs/
-
-Sample usage
-------------
-
-This section demonstrates possible usage of WikipediaFS via the command
-line, though it is also possible to use WikipediaFS with a graphical file
-explorer.
-
-$ mount /mnt/wfs/
-
-WikipediaFS is now mounted in /mnt/wfs/
-
-$ cd /mnt/wfs/
-
-We are now at the WikipediaFS root.
-
-$ ls
-mblondel.org/  wikipedia-en/
-
-Those are directories which have been defined in my config file.
-
-$ ls wikipedia-en/
-
-Nothing is listed because we have not used any file yet. This is why most of
-the time you will need a terminal to run the "your_favourite_editor file_name"
-command.
-
-$ cat wikipedia-en/Japan | less
-
-The Japan article is fetched on en.wikipedia.org and displayed.
-
-$ ls wikipedia-en/
-Japan
-
-Japan is now listed because it has been accessed once.
-
-$ vi mblondel.org/Test
-
-An article can be edited with a text editor. Looking at the article with a web
-browser, the changes have been performed correctly.
-
-To give a summary to your changes, use [[Summary: a sentence summary]] in the
-body of the article. It will be removed before the article is saved.
-
-$ cp wikipedia-en/Japan ~/Desktop/
-
-This backups the online article on the local disk.
-
-$ cp wikipedia-en/Japan mblondel.org/
-
-This copies the wikipedia-en article on my personal mediawiki site.
-
-$ rm mblondel.org/Test
-
-This only removes the article from the directory, not from the site, hopefully.
+The manual page describes in details the configuration file, mount/umount and
+sample usage. It is also available as HTML in doc/.
 
 Troubleshooting
 ---------------
 
 ** I get the "fuse: reading device: Bad file descriptor" error
 
-This error can be caused by a number of reasons:
-
-1/ the fuse module is not loaded:
+The fuse module is probably not loaded:
 
 To test if it is loaded:
 # lsmod | grep fuse
@@ -168,23 +39,11 @@ To load it:
 
 Add fuse to /etc/modules if you want this module to be loaded at boot.
 
-2/ WikipediaFS may still be mounted. Unmount it first.
-# umount /mount/path/
-
-
 ** I get the "mount: unknown filesystem type 'wikipediafs'" error
 
 Try this:
 # ln -s /usr/bin/mount.wikipediafs /sbin/mount.wikipediafs
 
-** I need to connect through an HTTP proxy.
-
-Please use the $http_proxy environment variable.
-
-** I want to deal with articles with a non-ASCII file name.
-
-Set your terminal encoding to UTF-8.
-
 ** Other
 
 The FAQ available on the official Fuse website is worth reading.