Split INSTALL.txt into {torrent,xml}-INSTALL.txt
authorOleg Broytman <phd@phdru.name>
Fri, 9 Jan 2015 22:32:26 +0000 (01:32 +0300)
committerOleg Broytman <phd@phdru.name>
Fri, 9 Jan 2015 22:32:26 +0000 (01:32 +0300)
Convert *INSTALL.txt to proper ReST format.
Add Makefile to generate *.html.

INSTALL.html [new file with mode: 0644]
INSTALL.txt
Makefile [new file with mode: 0644]
torrent-INSTALL.html [new file with mode: 0644]
torrent-INSTALL.txt [new file with mode: 0644]
xml-INSTALL.html [new file with mode: 0644]
xml-INSTALL.txt [new file with mode: 0644]

diff --git a/INSTALL.html b/INSTALL.html
new file mode 100644 (file)
index 0000000..7dde8ec
--- /dev/null
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
+<title>How to install an external VFS script</title>
+<style type="text/css">
+
+
+</style>
+</head>
+<body>
+<div class="document" id="how-to-install-an-external-vfs-script">
+<h1 class="title">How to install an external VFS script</h1>
+
+<p>Related to extfs installation there are two major versions of <tt class="docutils literal">Midnight
+Commander</tt>. Older versions before 4.7.something use <tt class="docutils literal">extfs.ini</tt>
+configuration file. Newer versions simply allow to drop a VFS script to
+<tt class="docutils literal"><span class="pre">$HOME/.mc/extfs.d</span></tt> directory. One can distinguish these versions by
+looking up the file <tt class="docutils literal">extfs.ini</tt>; run the following command from the
+command line:</p>
+<pre class="literal-block">
+locate -b \\extfs.ini
+</pre>
+<p>(I use GNU locate conventions; adapt the command line to your system;
+the simplest variant is just <tt class="docutils literal">locate extfs.ini</tt>.)</p>
+<p>Usual places for <tt class="docutils literal">extfs.ini</tt> are <tt class="docutils literal">/etc/mc/extfs/extfs.ini</tt>,
+<tt class="docutils literal">/usr/lib/mc/extfs/extfs.ini</tt>, <tt class="docutils literal">/usr/share/mc/extfs/extfs.ini</tt> or
+<tt class="docutils literal">/usr/local/share/mc/extfs/extfs.ini</tt>.</p>
+<div class="section" id="older-versions-extfs-ini">
+<h1>Older versions - extfs.ini</h1>
+<p>On the system where there is a file extfs.ini a VFS script has to be
+installed the following way. Put the script into the system extfs
+directory - <tt class="docutils literal">/usr/share/mc/extfs/</tt> or <tt class="docutils literal">/usr/local/share/mc/extfs/</tt>.
+Make the script executable. Edit <tt class="docutils literal">extfs.ini</tt> - add a line naming the
+script; for example, if one's installing xml VFS one has to do something
+like:</p>
+<pre class="literal-block">
+cd /etc/mc/extfs
+echo xml &gt;&gt;extfs.ini
+</pre>
+<p>To use the installed VFS one also has to edit <tt class="docutils literal"><span class="pre">$HOME/.mc/mc.ext</span></tt> to assign
+the VFS to file extension(s) or type(s).</p>
+<p>To enable file types add or change the following configuration option in
+ini file in section <tt class="docutils literal"><span class="pre">[Midnight-Commander]</span></tt>:</p>
+<pre class="literal-block">
+use_file_to_guess_type=1
+</pre>
+<p>This has to be done using text editor - <tt class="docutils literal">mc</tt> doesn't allow editing the
+option in its configuration editor.</p>
+</div>
+<div class="section" id="newer-versions-home-mc-extfs-d">
+<h1>Newer versions - $HOME/.mc/extfs.d</h1>
+<p>For newer versions just drop a VFS script to <tt class="docutils literal"><span class="pre">$HOME/.mc/extfs.d</span></tt> or
+<tt class="docutils literal"><span class="pre">$HOME/.local/share/mc/extfs.d/</span></tt> directory (verify directory by running
+<tt class="docutils literal">mc <span class="pre">-F</span></tt>). Make the script executable. Edit <tt class="docutils literal">mc.ext</tt>. Enable file types
+guessing (see above).</p>
+<p>See my <a class="reference external" href="http://phdru.name/Software/dotfiles/mc/mc.ext.html">http://phdru.name/Software/dotfiles/mc/mc.ext.html</a> for examples.</p>
+</div>
+</div>
+</body>
+</html>
index 754337e..fa9d52a 100644 (file)
@@ -1,70 +1,52 @@
 How to install an external VFS script
 =====================================
 
-Related to extfs installation there are two major versions of Midnight
-Commander. Older versions before 4.7.something use extfs.ini
+Related to extfs installation there are two major versions of ``Midnight
+Commander``. Older versions before 4.7.something use ``extfs.ini``
 configuration file. Newer versions simply allow to drop a VFS script to
-$HOME/.mc/extfs.d directory. One can distinguish these versions by
-looking up the file extfs.ini; run the following command from the
-command line:
+``$HOME/.mc/extfs.d`` directory. One can distinguish these versions by
+looking up the file ``extfs.ini``; run the following command from the
+command line::
 
-locate -b \\extfs.ini
+  locate -b \\extfs.ini
 
 (I use GNU locate conventions; adapt the command line to your system;
-the simplest variant is just "locate extfs.ini".)
+the simplest variant is just ``locate extfs.ini``.)
 
-Usual places for extfs.ini are /etc/mc/extfs/extfs.ini,
-/usr/lib/mc/extfs/extfs.ini, /usr/share/mc/extfs/extfs.ini or
-/usr/local/share/mc/extfs/extfs.ini.
+Usual places for ``extfs.ini`` are ``/etc/mc/extfs/extfs.ini``,
+``/usr/lib/mc/extfs/extfs.ini``, ``/usr/share/mc/extfs/extfs.ini`` or
+``/usr/local/share/mc/extfs/extfs.ini``.
 
 Older versions - extfs.ini
 --------------------------
 
 On the system where there is a file extfs.ini a VFS script has to be
 installed the following way. Put the script into the system extfs
-directory - /usr/share/mc/extfs/ or /usr/local/share/mc/extfs/. Make the
-script executable. Edit extfs.ini - add a line naming the script; for
-example, if one's installing xml VFS one has to do something like
+directory - ``/usr/share/mc/extfs/`` or ``/usr/local/share/mc/extfs/``.
+Make the script executable. Edit ``extfs.ini`` - add a line naming the
+script; for example, if one's installing xml VFS one has to do something
+like::
 
-cd /etc/mc/extfs
-echo xml >>extfs.ini
+  cd /etc/mc/extfs
+  echo xml >>extfs.ini
 
-To use the installed VFS one also has to edit $HOME/.mc/mc.ext to assign
-the VFS to file extension(s) or type(s). For example to assign xml VFS
-to *.xml files (ignore case) and to XML file type add the following to
-mc.ext:
-
-regex/\.([xX][mM][lL])$
-    Open=%cd %p#xml
-
-type/^XML *(1\.0 *)?document text
-    Open=%cd %p#xml
+To use the installed VFS one also has to edit ``$HOME/.mc/mc.ext`` to assign
+the VFS to file extension(s) or type(s).
 
 To enable file types add or change the following configuration option in
-ini file in section [Midnight-Commander]:
+ini file in section ``[Midnight-Commander]``::
 
-use_file_to_guess_type=1
+  use_file_to_guess_type=1
 
-This has to be done using text editor - mc doesn't allow editing the
+This has to be done using text editor - ``mc`` doesn't allow editing the
 option in its configuration editor.
 
-Newer versions $HOME/.mc/extfs.d
---------------------------------
-
-For newer versions just drop a VFS script to $HOME/.mc/extfs.d or
-$HOME/.local/share/mc/extfs.d/ directory (verify directory by running
-"mc -F"). Make the script executable. Edit mc.ext; the syntax is
-slightly different:
-
-regex/\.([xX][mM][lL])$
-    Include=xml
-
-type/^XML *(1\.0 *)?document text
-    Include=xml
-
-include/xml
-    Open=%cd %p/xml://
+Newer versions - \$HOME/.mc/extfs.d
+-----------------------------------
 
-Enable file types guessing (see above).
+For newer versions just drop a VFS script to ``$HOME/.mc/extfs.d`` or
+``$HOME/.local/share/mc/extfs.d/`` directory (verify directory by running
+``mc -F``). Make the script executable. Edit ``mc.ext``. Enable file types
+guessing (see above).
 
 See my http://phdru.name/Software/dotfiles/mc/mc.ext.html for examples.
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..c50423f
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,17 @@
+%.html: %.txt
+       rst2html --stylesheet=/dev/null -- $< >$@
+
+
+.PHONY: all
+all: docs
+
+
+.PHONY: docs
+docs: INSTALL.html torrent-INSTALL.html xml-INSTALL.html
+
+
+CLEANFILES = *.py[co]
+
+.PHONY: clean
+clean:
+       rm -f $(CLEANFILES)
diff --git a/torrent-INSTALL.html b/torrent-INSTALL.html
new file mode 100644 (file)
index 0000000..8d9eb7a
--- /dev/null
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
+<title>How to install torrent VFS script</title>
+<style type="text/css">
+
+
+</style>
+</head>
+<body>
+<div class="document" id="how-to-install-torrent-vfs-script">
+<h1 class="title">How to install torrent VFS script</h1>
+
+<p>First, see the general instruction at <a class="reference external" href="INSTALL.html">INSTALL.html</a>.</p>
+<div class="section" id="older-versions-of-mc">
+<h1>Older versions of mc</h1>
+<p>To assign torrent VFS to <tt class="docutils literal">*.torrent</tt> files add the following to mc.ext:</p>
+<pre class="literal-block">
+shell/.torrent
+  Open=%cd %p#torrent
+</pre>
+</div>
+<div class="section" id="newer-versions">
+<h1>Newer versions</h1>
+<p>Edit <tt class="docutils literal">mc.ext</tt>; the syntax is slightly different:</p>
+<pre class="literal-block">
+shell/.torrent
+  Open=%cd %p/torrent://
+</pre>
+</div>
+</div>
+</body>
+</html>
diff --git a/torrent-INSTALL.txt b/torrent-INSTALL.txt
new file mode 100644 (file)
index 0000000..e0f6b2d
--- /dev/null
@@ -0,0 +1,20 @@
+How to install torrent VFS script
+=================================
+
+First, see the general instruction at `<INSTALL.html>`_.
+
+Older versions of mc
+--------------------
+
+To assign torrent VFS to ``*.torrent`` files add the following to mc.ext::
+
+  shell/.torrent
+    Open=%cd %p#torrent
+
+Newer versions
+--------------
+
+Edit ``mc.ext``; the syntax is slightly different::
+
+  shell/.torrent
+    Open=%cd %p/torrent://
diff --git a/xml-INSTALL.html b/xml-INSTALL.html
new file mode 100644 (file)
index 0000000..ad57a2e
--- /dev/null
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
+<title>How to install XML VFS script</title>
+<style type="text/css">
+
+
+</style>
+</head>
+<body>
+<div class="document" id="how-to-install-xml-vfs-script">
+<h1 class="title">How to install XML VFS script</h1>
+
+<p>First, see the general instruction at <a class="reference external" href="INSTALL.html">INSTALL.html</a>.</p>
+<div class="section" id="older-versions-of-mc">
+<h1>Older versions of mc</h1>
+<p>To assign xml VFS to <tt class="docutils literal">*.xml</tt> files (ignore case) and to XML file type add
+the following to <tt class="docutils literal">mc.ext</tt>:</p>
+<pre class="literal-block">
+regex/\.([xX][mM][lL])$
+  Open=%cd %p#xml
+
+type/^XML *(1\.0 *)?document text
+  Open=%cd %p#xml
+</pre>
+<p>Enable file types guessing.</p>
+</div>
+<div class="section" id="newer-versions">
+<h1>Newer versions</h1>
+<p>Edit <tt class="docutils literal">mc.ext</tt>; the syntax is slightly different:</p>
+<pre class="literal-block">
+regex/\.([xX][mM][lL])$
+  Include=xml
+
+type/^XML *(1\.0 *)?document text
+  Include=xml
+
+include/xml
+  Open=%cd %p/xml://
+</pre>
+<p>Enable file types guessing.</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/xml-INSTALL.txt b/xml-INSTALL.txt
new file mode 100644 (file)
index 0000000..3a3439a
--- /dev/null
@@ -0,0 +1,34 @@
+How to install XML VFS script
+=============================
+
+First, see the general instruction at `<INSTALL.html>`_.
+
+Older versions of mc
+--------------------
+
+To assign xml VFS to ``*.xml`` files (ignore case) and to XML file type add
+the following to ``mc.ext``::
+
+  regex/\.([xX][mM][lL])$
+    Open=%cd %p#xml
+
+  type/^XML *(1\.0 *)?document text
+    Open=%cd %p#xml
+
+Enable file types guessing.
+
+Newer versions
+--------------
+
+Edit ``mc.ext``; the syntax is slightly different::
+
+  regex/\.([xX][mM][lL])$
+    Include=xml
+
+  type/^XML *(1\.0 *)?document text
+    Include=xml
+
+  include/xml
+    Open=%cd %p/xml://
+
+Enable file types guessing.