diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | doc/mount.wikipediafs.xml | 202 |
2 files changed, 203 insertions, 0 deletions
@@ -1,3 +1,4 @@ *.pyc *~ doc/*.1* +*-info diff --git a/doc/mount.wikipediafs.xml b/doc/mount.wikipediafs.xml new file mode 100644 index 0000000..e66b143 --- /dev/null +++ b/doc/mount.wikipediafs.xml @@ -0,0 +1,202 @@ +<?xml version="1.0"?> +<refentry> + <refentryinfo> + <address format="linespecific"> + <email>mblondel@users.sourceforge.net</email> + </address> + <author> + <firstname>Mathieu</firstname> + <surname>Blondel</surname> + </author> + <copyright> + <year>2007</year> + <holder>sdffsd</holder> + </copyright> + <date>Thu, 20 Jun 2006 13:16:17 -0700</date> + </refentryinfo> + <refmeta> + <refentrytitle>MOUNT.WIKIPEDIAFS</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + <refnamediv> + <refname>mount.wikipediafs</refname> + <refpurpose>A program to mount WikipediaFS, a filesystem that + allows to view and edit Wikipedia articles as if they were real + files.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis sepchar=""> + <command moreinfo="none">mount.wikipediafs</command> + <arg choice="opt" rep="norepeat"> + <replaceable>mountpoint</replaceable> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>DESCRIPTION</title> + <para>This manual page documents the + <command moreinfo="none">mount.wikipediafs</command>command and + general usage of WikipediaFS.</para> + <para>WikipediaFS allows to view and edit Wikipedia articles as + if they were real files. + <command moreinfo="none">mount.wikipediafs</command>mounts a + WikipediaFS filesystem.</para> + <para>To connect through an HTTP proxy, it is possible to use + the $http_proxy environment variable.</para> + </refsect1> + <refsect1> + <title>CONFIGURATION</title> + <para>The first time WikipediaFS is run, an XML configuration + file is generated in ~/.wikipediafs/config.xml. It is possible + to edit it later to add more Wikipedia or Mediawiki-based + sites. Each site entry can define the following elements. + Elements marked with an * are mandatory.</para> + <variablelist> + <varlistentry> + <term>dirname*</term> + <listitem> + <para>Is the name of the directory through which you will + access to the site.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>host*</term> + <listitem> + <para>Is the host of the site. For Wikipedia, it will be + lang.wikipedia.org</para> + </listitem> + </varlistentry> + <varlistentry> + <term>basename*</term> + <listitem> + <para>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.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>username and password</term> + <listitem> + <para>Enables to edit articles with one's login.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>httpauth_username and httpauth_password</term> + <listitem> + <para>Can be used for Mediawiki sites protected with HTTP + authentication (Apache's .htaccess).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>https</term> + <listitem> + <para>Use HTTPS instead of HTTP.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>MOUNT</title> + <para> + <command moreinfo="none"> + mount.wikipediafs</command>mountpoint/</para> + <para>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,</para> + <para># adduser your_username fuse</para> + <para># chmod 4750 /usr/bin/fusermount</para> + <para># chgrp fuse /dev/fuse /usr/bin/fusermount</para> + <para>(You may have to log out and log in again so that changes + are taken into account.)</para> + </refsect1> + <refsect1> + <title>UNMOUNT</title> + <para> + <command moreinfo="none">fusermount</command>-u + mountpoint/</para> + <para>or simply</para> + <para> + <command moreinfo="none">umount</command>mountpoint/</para> + </refsect1> + <refsect1> + <title>FSTAB</title> + <para>Alternatively, you can mount WikipediaFS through + fstab.</para> + <para>To do so, add this line to /etc/fstab:</para> + <para>none /mnt/wfs/ wikipediafs noauto,nouser</para> + <para>Replace noauto by auto if you want WikipediaFS to be + mounted at boot.</para> + <para>Replace nouser by user if you want to allow simple users + to use WikipediaFS.</para> + <para>A symbolic link from /usr/bin/mount.wikipediafs to + /sbin/mount.wikipediafs is needed if WikipediaFS is mounted + through fstab.</para> + <para>Then, traditional mount and unmount commands can be used + with WikipediaFS.</para> + </refsect1> + <refsect1> + <title>SAMPLE USAGE</title> + <para>This section demonstrates possible usage of WikipediaFS + via the command line, though it is also possible to use + WikipediaFS with a graphical file explorer.</para> + <para>$ mount /mnt/wfs/ WikipediaFS is now mounted in + /mnt/wfs/</para> + <para>$ cd /mnt/wfs/ We are now at the WikipediaFS root.</para> + <para>$ ls mblondel.org/ This directory has been defined in the + configuration file.</para> + <para>$ mkdir wikipedia-en/ WikipediaFS recognizes the + "site-lang" pattern for the sites from the Wikimedia + Foundation.</para> + <para>$ ls mblondel.org/ wikipedia-en/</para> + <para>$ ls wikipedia-en/ Nothing is listed because we have not + used any file yet.</para> + <para>$ cat wikipedia-en/Japan.mw | less The Japan article is + fetched on en.wikipedia.org and displayed. Note that the .mw + extension is required.</para> + <para>$ ls wikipedia-en/ Japan.mw Japan.mw is now listed + because it has been accessed once.</para> + <para>$ vi mblondel.org/Test.mw 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.</para> + <para>$ cp wikipedia-en/Japan.mw ~/Desktop/ This backups the + online article to the local disk.</para> + <para>$ cp wikipedia-en/Japan.mw mblondel.org/ This copies the + wikipedia-en article to the mblondel.org entry.</para> + <para>$ rm mblondel.org/Test.mw This only removes the article + from the directory, not from the site, hopefully.</para> + <para>$ mkdir -p mblondel.org/Foo/Bar/</para> + <para>$ vi mblondel.org/Foo/Bar/Code.mw Subpages are supported. + You need to create the directories first.</para> + </refsect1> + <refsect1> + <title>AUTHOR</title> + <para>This manual page was written by + <author> + <firstname>Mathieu</firstname> + <surname>Blondel</surname> + </author>.</para> + <para>This manual page is (c) 2006-2007 of + <author> + <firstname>Mathieu</firstname> + <surname>Blondel</surname> + </author>and licensed under the terms of the GPLv2 or + higher</para> + </refsect1> + <refsect1> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>mount</refentrytitle> + <manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>fstab</refentrytitle> + <manvolnum>5</manvolnum> + </citerefentry></para> + </refsect1> +</refentry> |