From bd5dec52db80d52a95a475cd20e299d8a7677dce Mon Sep 17 00:00:00 2001 From: Mathieu Blondel Date: Mon, 4 Sep 2006 12:20:52 +0000 Subject: Added man page. git-svn-id: http://svn.code.sf.net/p/wikipediafs/code/trunk@10 59acd704-e115-0410-a914-e735a229ed7c --- doc/mount.wikipediafs.sgml | 268 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 268 insertions(+) create mode 100644 doc/mount.wikipediafs.sgml (limited to 'doc') diff --git a/doc/mount.wikipediafs.sgml b/doc/mount.wikipediafs.sgml new file mode 100644 index 0000000..b9519f4 --- /dev/null +++ b/doc/mount.wikipediafs.sgml @@ -0,0 +1,268 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Mathieu"> + Blondel"> + + Thu, 20 Jun 2006 13:16:17 -0700"> + + 8"> + mblondel@users.sourceforge.net"> + + MOUNT.WIKIPEDIAFS"> + +]> + + + +
+ &manemail; +
+ + &manfirstname; + &mansurname; + + + 2004 + &manusername; + + &mandate; + + + &manucpackage; + + &mansection; + + + &manpackage; + + A program to mount WikipediaFS, a filesystem that allows to view +and edit Wikipedia articles as if they were real files + + + + &manpackage; + mountpoint + + + + DESCRIPTION + This manual page documents the &manpackage; + command and general usage of WikipediaFS. + + WikipediaFS allows to view and edit Wikipedia articles as if +they were real files. &manpackage; mounts a WikipediaFS +filesystem. + + + To connect through an HTTP proxy, you can use the $http_proxy +environment variable. + + + + + CONFIGURATION + + 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: + + + <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. + + + + + + + + MOUNT + mount.wikipediafs mountpoint/ + + 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 mountpoint/ + + + + + 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. + +Then, traditional mount and unmount can be used with WikipediaFS. + + + + 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. + + + + + AUTHOR + + This manual page was written by &manfirstname; + &mansurname;. + + This manual page is (c) 2006 of &manfirstname; +&mansurname; and licensed under the terms of the GPLv2 or higher + + + + + SEE ALSO + + mount8 + , + fstab5 + + + + + + -- cgit