ptex2pdf (1may13)

git-svn-id: svn://tug.org/texlive/trunk@30201 c570f23f-e606-0410-a88d-b1316a301751

2 files changed, 141 insertions, 55 deletions

diff --git a/Master/texmf-dist/doc/latex/ptex2pdf/README b/Master/texmf-dist/doc/latex/ptex2pdf/README
index c19322ee230..f63acc66427 100644
--- a/Master/texmf-dist/doc/latex/ptex2pdf/README
+++ b/Master/texmf-dist/doc/latex/ptex2pdf/README
@@ -1,7 +1,4 @@
-ptex2pdf.lua
-============
-
-Convert Japanese TeX documents to pdf
+ptex2pdf[.lua]: Convert Japanese TeX documents to pdf
 
 Author: Norbert Preining <norbert@preining.info>
 
@@ -10,11 +7,10 @@ engines in TeXworks. As TeXworks typesetting setup does not allow
 for multistep processing, this script runs one of the ptex based
 programs (ptex, uptex, eptex, platex, uplatex) followed by dvipdfmx.
 
-Usage
------
-[texlua] ptex2pdf[.lua] { option | basename[.tex] } ... 
+Usage:  [texlua] ptex2pdf[.lua] { option | basename[.tex] } ... 
 options: -v  version
          -h  help
+         --help print full help (installation, TeXworks setup)
          -e  use eptex class of programs
          -u  use uptex class of programs
          -l  use latex based formats
@@ -23,10 +19,8 @@ options: -v  version
          -ot '<opts>' extra options for TeX
          -od '<opts>' extra options for dvipdfmx
 
-
 Installation
 ------------
-
 Copy the file ptex2pdf.lua into a directory where scripts are found,
 that is for example
   TLROOT/texmf-dist/scripts/ptex2pdf/
@@ -41,8 +35,6 @@ Windows:
 create a copy of runscript.exe as ptex2pdf.exe, in the TeX Live case:
   copy TLROOT/bin/win32/runscript.exe TLROOT/bin/win32/ptex2pdf.exe
 
-
-
 TeXworks setup
 --------------
 Under Preferences > Typesetting add new entries, for example:
@@ -79,15 +71,12 @@ for uplatex files:
                 $synctexoption
                 $fullname
 
-
-Original development place
---------------------------
+Development place
+-----------------
 https://git.gitorious.org/tlptexlive/ptex2pdf.git
 
-
-License and copyright
+Copyright and License
 ---------------------
-
 Originally based on musixtex.lua from Bob Tennent.
 
 (c) Copyright 2012 Bob Tennent rdt@cs.queensu.ca
@@ -107,5 +96,3 @@ You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
-
-
diff --git a/Master/texmf-dist/scripts/ptex2pdf/ptex2pdf.lua b/Master/texmf-dist/scripts/ptex2pdf/ptex2pdf.lua
index 1922084e031..618a4ec713e 100755
--- a/Master/texmf-dist/scripts/ptex2pdf/ptex2pdf.lua
+++ b/Master/texmf-dist/scripts/ptex2pdf/ptex2pdf.lua
@@ -1,62 +1,150 @@
 #!/usr/bin/env texlua  
 
-VERSION = "0.2"
+NAME = "ptex2pdf[.lua]"
+VERSION = "0.3"
+AUTHOR = "Norbert Preining <norbert@preining.info>"
+SHORTDESC = NAME .. ": Convert Japanese TeX documents to pdf"
+LONGDESC = [[
+Main purpose of the script is easy support of Japanese typesetting
+engines in TeXworks. As TeXworks typesetting setup does not allow
+for multistep processing, this script runs one of the ptex based
+programs (ptex, uptex, eptex, platex, uplatex) followed by dvipdfmx.
+]]
+USAGE = [[
+Usage:  [texlua] ptex2pdf[.lua] { option | basename[.tex] } ... 
+options: -v  version
+         -h  help
+         --help print full help (installation, TeXworks setup)
+         -e  use eptex class of programs
+         -u  use uptex class of programs
+         -l  use latex based formats
+         -s  stop at dvi
+         -i  retain intermediate files
+         -ot '<opts>' extra options for TeX
+         -od '<opts>' extra options for dvipdfmx
+]]
 
---[[
-     ptex2pdf.lua: convert pTeX (and friends) based files to pdf
+LICENSECOPYRIGHT = [[
+Originally based on musixtex.lua from Bob Tennent.
 
-     Originally based on musixtex.lua from Bob Tennent.
+(c) Copyright 2012 Bob Tennent rdt@cs.queensu.ca
+(c) Copyright 2013 Norbert Preining norbert@preining.info
 
-     (c) Copyright 2012 Bob Tennent rdt@cs.queensu.ca
-     (c) Copyright 2013 Norbert Preining norbert@preining.info
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version.
 
-     This program is free software; you can redistribute it and/or modify it
-     under the terms of the GNU General Public License as published by the
-     Free Software Foundation; either version 2 of the License, or (at your
-     option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+Public License for more details.
 
-     This program is distributed in the hope that it will be useful,
-     but WITHOUT ANY WARRANTY; without even the implied warranty of
-     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
-     Public License for more details.
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+]]
 
-     You should have received a copy of the GNU General Public License along
-     with this program; if not, write to the Free Software Foundation, Inc.,
-     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+INSTALLATION = [[
+Copy the file ptex2pdf.lua into a directory where scripts are found,
+that is for example
+  TLROOT/texmf-dist/scripts/ptex2pdf/
+(where TLROOT is for example the root of your TeX Live installation)
 
---]]
+Unix:
+create a link in one of the bin dirs to the above file, in the
+TeX Live case:
+  TLROOT/bin/ARCH/ptex2pdf -> ../../texmf-dist/scripts/ptex2pdf/ptex2pdf.lua
 
---[[
+Windows:
+create a copy of runscript.exe as ptex2pdf.exe, in the TeX Live case:
+  copy TLROOT/bin/win32/runscript.exe TLROOT/bin/win32/ptex2pdf.exe
+]]
+TEXWORKS = [[
+Under Preferences > Typesetting add new entries, for example:
 
-  ChangeLog:
+for ptex files:
+  Name:         pTeX to pdf
+  Program:      ptex2pdf
+  Arguments:    -ot
+                $synctexoption
+                $fullname
 
+for platex files:
+  Name:         pLaTeX to pdf
+  Program:      ptex2pdf
+  Arguments:    -l
+                -ot
+                $synctexoption
+                $fullname
+
+for uptex files:
+  Name:         upTeX to pdf
+  Program:      ptex2pdf
+  Arguments:    -u
+                -ot
+                $synctexoption
+                $fullname
+
+for uplatex files:
+  Name:         upLaTeX to pdf
+  Program:      ptex2pdf
+  Arguments:    -l
+                -u
+                -ot
+                $synctexoption
+                $fullname
+]]
+DEVELPLACE = "https://git.gitorious.org/tlptexlive/ptex2pdf.git"
+
+
+CHANGELOG = [[
      version 0.1  2013-03-08 NP
        Initial release on blog
      version 0.2  2013-03-10 NP
        import into git repository
        support passing options on to tex and dvipdfm
        add README with TeXworks config options
+     version 0.3  2013-05-01 NP
+       include the readme in the lua code
+       fix program name for -e -u
+]]
 
---]]
 
 function usage()
-  print("Usage:  [texlua] ptex2pdf[.lua] { option | basename[.tex] } ... ")
-  print("options: -v  version")
-  print("         -h  help")
-  print("         -e  use eptex class of programs")
-  print("         -u  use uptex class of programs")
-  print("         -l  use latex based formats")
-  print("         -s  stop at dvi")
-  print("         -i  retain intermediate files")
-  print("         -ot '<opts>' extra options for TeX")
-  print("         -od '<opts>' extra options for dvipdfmx")
+  print(USAGE)
+end
+
+function help()
+  print(SHORTDESC)
+  print()
+  print("Author: " .. AUTHOR)
+  print()
+  print(LONGDESC)
+  print(USAGE)
+end
+
+function fullhelp()
+  help()
+  print("Installation")
+  print("------------")
+  print(INSTALLATION)
+  print("TeXworks setup")
+  print("--------------")
+  print(TEXWORKS)
+  print("Development place")
+  print("-----------------")
+  print(DEVELPLACE)
+  print()
+  print("Copyright and License")
+  print("---------------------")
+  print(LICENSECOPYRIGHT)
 end
 
 function whoami ()
-  print("This is ptex2pdf.lua version ".. VERSION .. ".")
+  print("This is " .. NAME .. " version ".. VERSION .. ".")
 end
 
-whoami()
 if #arg == 0 then
   usage()
   os.exit(0)
@@ -78,9 +166,16 @@ narg = 1
 repeat
   this_arg = arg[narg]
   if this_arg == "-v" then
+    whoami()
+    os.exit(0)
+  elseif this_arg == "--print-version" then
+    print(VERSION)
     os.exit(0)
   elseif this_arg == "-h" then
-    usage()
+    help()
+    os.exit(0)
+  elseif this_arg == "--help" then
+    fullhelp()
     os.exit(0)
   elseif this_arg == "-e" then
     use_eptex = 1
@@ -104,12 +199,14 @@ repeat
   narg = narg+1
 until narg > #arg 
 
+whoami()
+
 if use_eptex == 1 then
   if use_uptex == 1 then
     if use_latex == 1 then
-      tex = "uplatex"	-- uptex already as etex extension
+      tex = "uplatex"	-- uplatex already as etex extension
     else
-      tex = "uptex"
+      tex = "euptex"
     end
   else
     if use_latex == 1 then
@@ -165,6 +262,8 @@ end --if not io.open ...
 
 os.exit( exit_code )
 
+
+
 -- Local Variables:
 -- lua-indent-level: 2
 -- tab-width: 2