summaryrefslogtreecommitdiff
path: root/manual/xmlformat/INSTALL
diff options
context:
space:
mode:
authorTim Mayberry <mojofunk@gmail.com>2007-02-15 03:49:43 +0000
committerTim Mayberry <mojofunk@gmail.com>2007-02-15 03:49:43 +0000
commitb8a6f94325c46a4129922ad3dbb61ca30761299b (patch)
treef6e688825a494d98ba9dd55157fe695f3d721985 /manual/xmlformat/INSTALL
parent7f0f19597ae605c10d37a9f6e749c49c254d2700 (diff)
Add a help target(the default target) and format target to the manual
Makefile Reformat the docs, I explained in a prior commit why this modifies every file git-svn-id: svn://localhost/ardour2/trunk@1463 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'manual/xmlformat/INSTALL')
-rw-r--r--manual/xmlformat/INSTALL29
1 files changed, 29 insertions, 0 deletions
diff --git a/manual/xmlformat/INSTALL b/manual/xmlformat/INSTALL
new file mode 100644
index 0000000000..59017c8abd
--- /dev/null
+++ b/manual/xmlformat/INSTALL
@@ -0,0 +1,29 @@
+There are two versions of xmlformat:
+
+- xmlformat.rb, written in Ruby
+- xmlformat.pl, written in Perl
+
+Both should produce identical results.
+
+To install xmlformat, copy the version you want to use to some public
+directory that is listed in your PATH variable. You may wish to rename
+the script to xmlformat so that you don't have to type the .rb or .pl
+extension each time you invoke it.
+
+Example:
+
+ cp xmlformat.rb /usr/local/bin/xmlformat
+(or)
+ cp xmlformat.pl /usr/local/bin/xmlformat
+
+If you want to install both versions, do not rename them:
+
+ cp xmlformat.rb /usr/local/bin/xmlformat.rb
+ cp xmlformat.pl /usr/local/bin/xmlformat.pl
+
+In this case you will need to specify the extension when invoking the program
+to indicate which version you want.
+
+If your Ruby or Perl programs are not at the location listed in the
+first line of the installed script, you'll need to edit that line
+to have the correct location.