summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/gmverb/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-12-19 01:01:29 +0000
committerKarl Berry <karl@freefriends.org>2006-12-19 01:01:29 +0000
commitdf7778c48becf35354216fce0df5a04f4538912e (patch)
treef4486d017dd2ac7619df1b147bb8cff2f155c32a /Master/texmf-dist/doc/latex/gmverb/README
parent8d7729dececc6e5d1fd0d56383ee996069c6a47c (diff)
new package gmverb (18dec06)
git-svn-id: svn://tug.org/texlive/trunk@2800 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/gmverb/README')
-rw-r--r--Master/texmf-dist/doc/latex/gmverb/README67
1 files changed, 67 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/gmverb/README b/Master/texmf-dist/doc/latex/gmverb/README
new file mode 100644
index 00000000000..e930f6fca1b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/gmverb/README
@@ -0,0 +1,67 @@
+The gmverb package
+is a work of Grzegorz `Natror' Murzynowski,
+<natror at o2 dot pl>
+
+
+1. Copyright 2006 by Grzegorz `Natror' Murzynowski
+
+This program is subject to the LaTeX Project Public License.
+See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
+for the details of that license.
+
+
+2. Introduction
+
+The gmverb.sty package redefines the \verb command and the {verbatim}
+environment so that the verbatim text can break into lines, with % as
+a `hyphen'. Moreover, it allows the user to define his/her own
+{verbatim}-like environments provided their contents would be not
+horribly long (as long as a macro's argument may be at most).
+
+This package also allows the user to declare a chosen char(s) as
+a `short verb' e.g., to write |\a\verbatim\example| instead of
+\verb|\a\verbatim\example|.
+
+
+3. Installation
+
+Just put the gmverb.sty somewhere in the texmf/tex/latex
+branch. Creating a /texmf/tex/latex/gm directory may be advisable if
+you consider using other packages written by me.
+
+Then you should refresh your TeX distribution's files'
+database most probably.
+
+
+4. Contents
+
+The distribution of this package consists of the following four files.
+
+gmverb.sty
+README
+gmverbDoc.tex
+gmverbDoc.pdf
+
+
+5. Documentation
+
+The last of the above files (the .pdf) is a documentation compiled
+from the .sty file by running LaTeX on the gmverbDoc.tex file twice,
+then MakeIndex on the gmverb.idx file, and then LaTeX
+on gmverbDoc.tex once more.
+
+MakeIndex shell command:
+ makeindex -r gmverbDoc
+The -r switch is to forbid MakeIndex make implicit ranges since the
+(code line) numbers will be hyperlinks
+
+Compiling of the documentation requires the packages: gmdoc
+(gmdoc.sty and gmdocc.cls), gmverb.sty, gmutils.sty and also some
+standard packages: hyperref.sty, color.sty, geometry.sty,
+multicol.sty, lmodern.sty, fontenc.sty that should have been installed
+on your computer by default.
+
+If you have not installed the mwart.cls class (available on CTAN in
+mwcls package), the result of your compilation may differ a bit from
+the .pdf provided in this .zip archive in formattings: If you have not
+installed mwart.cls, the standard article.cls will be used.