]> git.phdru.name Git - extfs.d.git/blobdiff - INSTALL.txt
Replace ~ -> $HOME
[extfs.d.git] / INSTALL.txt
index 66dcf7e4e1d209bea6b88d0ae45cbc20a0dd5f41..cd9991f41ac28e5c3c2acc6207f9e87cd9be9bee 100644 (file)
@@ -4,8 +4,9 @@ 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
-~/.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
 
@@ -21,16 +22,16 @@ 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/. 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
 
-To use the installed VFS one also has to edit ~/.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
+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])$
@@ -40,19 +41,20 @@ type/^XML *(1\.0 *)?document text
     Open=%cd %p#xml
 
 To enable file types add or change the following configuration option in
-ini file:
+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 ~/.mc/extfs.d
-----------------------------
+Newer versions $HOME/.mc/extfs.d
+--------------------------------
 
-For newer versions just drop a VFS script to ~/.mc/extfs.d or
-~/.local/share/mc/extfs.d/ directory (verify directory by running "mc -F").
-Edit mc.ext; the syntax is slightly different:
+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
@@ -62,3 +64,5 @@ type/^XML *(1\.0 *)?document text
 
 include/xml
     Open=%cd %p/xml://
+
+Enable file types guessing (see above).