From b25e47028fb040848df6a8d2d63c14ad442b8384 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sat, 10 Jan 2015 01:32:26 +0300 Subject: [PATCH] Split INSTALL.txt into {torrent,xml}-INSTALL.txt Convert *INSTALL.txt to proper ReST format. Add Makefile to generate *.html. --- INSTALL.html | 63 ++++++++++++++++++++++++++++++++++++++ INSTALL.txt | 72 +++++++++++++++++--------------------------- Makefile | 17 +++++++++++ torrent-INSTALL.html | 36 ++++++++++++++++++++++ torrent-INSTALL.txt | 20 ++++++++++++ xml-INSTALL.html | 48 +++++++++++++++++++++++++++++ xml-INSTALL.txt | 34 +++++++++++++++++++++ 7 files changed, 245 insertions(+), 45 deletions(-) create mode 100644 INSTALL.html create mode 100644 Makefile create mode 100644 torrent-INSTALL.html create mode 100644 torrent-INSTALL.txt create mode 100644 xml-INSTALL.html create mode 100644 xml-INSTALL.txt diff --git a/INSTALL.html b/INSTALL.html new file mode 100644 index 0000000..7dde8ec --- /dev/null +++ b/INSTALL.html @@ -0,0 +1,63 @@ + + + + + + +How to install an external VFS script + + + +
+

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 +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:

+
+locate -b \\extfs.ini
+
+

(I use GNU locate conventions; adapt the command line to your system; +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.

+
+

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:

+
+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).

+

To enable file types add or change the following configuration option in +ini file in section [Midnight-Commander]:

+
+use_file_to_guess_type=1
+
+

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. Enable file types +guessing (see above).

+

See my http://phdru.name/Software/dotfiles/mc/mc.ext.html for examples.

+
+
+ + diff --git a/INSTALL.txt b/INSTALL.txt index 754337e..fa9d52a 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -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 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 index 0000000..8d9eb7a --- /dev/null +++ b/torrent-INSTALL.html @@ -0,0 +1,36 @@ + + + + + + +How to install torrent VFS script + + + +
+

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/torrent-INSTALL.txt b/torrent-INSTALL.txt new file mode 100644 index 0000000..e0f6b2d --- /dev/null +++ b/torrent-INSTALL.txt @@ -0,0 +1,20 @@ +How to install torrent VFS script +================================= + +First, see the general instruction at ``_. + +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 index 0000000..ad57a2e --- /dev/null +++ b/xml-INSTALL.html @@ -0,0 +1,48 @@ + + + + + + +How to install XML VFS script + + + +
+

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.

+
+
+ + diff --git a/xml-INSTALL.txt b/xml-INSTALL.txt new file mode 100644 index 0000000..3a3439a --- /dev/null +++ b/xml-INSTALL.txt @@ -0,0 +1,34 @@ +How to install XML VFS script +============================= + +First, see the general instruction at ``_. + +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. -- 2.39.5