summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-08-23 22:51:26 +0000
committerKarl Berry <karl@freefriends.org>2019-08-23 22:51:26 +0000
commitbbed3d7c3f9fe94ee6e609e703386eab311d94d1 (patch)
tree09de8c3b1caf63b592895acc48b10db806a60c16 /Master/texmf-dist/doc/support
parent47c569e42dbc9e097d71c904b50282d64090e336 (diff)
clojure-pamphlet (24aug19)
git-svn-id: svn://tug.org/texlive/trunk@51944 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/clojure-pamphlet/README38
-rw-r--r--Master/texmf-dist/doc/support/clojure-pamphlet/clojure-pamphlet_guide.pdfbin0 -> 189258 bytes
-rw-r--r--Master/texmf-dist/doc/support/clojure-pamphlet/pamphletangler.1204
3 files changed, 242 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/clojure-pamphlet/README b/Master/texmf-dist/doc/support/clojure-pamphlet/README
new file mode 100644
index 00000000000..00b7603d769
--- /dev/null
+++ b/Master/texmf-dist/doc/support/clojure-pamphlet/README
@@ -0,0 +1,38 @@
+CLOJURE PAMPHLET SYSTEM
+===========
+
+The clojure pamphlet system is a system based on the clojure literate
+system. In the clojure's pamphlet system you have your main LaTeX
+file, which can be compiled regularly. This file contains
+documentation and source code (just like in other forms of literate
+programming). This code snippets are wrapped in the 'chunk'
+environment, hence they can be recognized by the tangler in order to
+extract them. Chunks can be included inside each other by the
+'getchunk' command (which will be typesetted acordingly). Finally, you
+run your LaTeX file through the tangler and get your desired chunk of
+code.
+
+See the INSTALL file for detailed information about how to configure
+and install the tangler.
+ This tangler is a program that takes a pamphlet latex file (A simple
+latex file with special commands in it, see the latex clojure-pamphlet
+package manual page) and a code section and outputs the specified code
+section adding the chunks that are needed (and can be in any other
+part of the document).
+
+-----
+
+Copyright (C) 2019, Ernesto Lanchares Sanchez.
+
+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 3, 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.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
diff --git a/Master/texmf-dist/doc/support/clojure-pamphlet/clojure-pamphlet_guide.pdf b/Master/texmf-dist/doc/support/clojure-pamphlet/clojure-pamphlet_guide.pdf
new file mode 100644
index 00000000000..6ffa96f3aaf
--- /dev/null
+++ b/Master/texmf-dist/doc/support/clojure-pamphlet/clojure-pamphlet_guide.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/clojure-pamphlet/pamphletangler.1 b/Master/texmf-dist/doc/support/clojure-pamphlet/pamphletangler.1
new file mode 100644
index 00000000000..0c33bdba080
--- /dev/null
+++ b/Master/texmf-dist/doc/support/clojure-pamphlet/pamphletangler.1
@@ -0,0 +1,204 @@
+.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "PAMPHLETANGLER 1"
+.TH PAMPHLETANGLER 1 "2019-08-23" "clojure-pamphlet" "Ernesto Lanchares"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+pamphletangler \- Extract code bits from LaTeX pamphlet files.
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBpamphletangler\fR [\s-1OPTION...\s0] \fI\s-1FILE\s0\fR \fI\s-1CHUNKNAME\s0\fR
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+The clojure pamphlet system is a system based on the clojure literate
+system. In the clojure's pamphlet system you have your main LaTeX file, which
+can be compiled regularly. This file contains documentation and source code
+(just like in other forms of literate programming). This code snippets are
+wrapped in the 'chunk' environment, hence they can be recognized by the tangler
+in order to extract them. Chunks can be included inside each other by the
+\&'getchunk' command (which will be typesetted acordingly). Finally, you run your
+LaTeX file through the tangler and get your desired chunk of code.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\-L, \-\-line=linetext" 29
+.IX Item "-L, --line=linetext"
+If set, this text will be inserted after jumps of lines, changing the string
+inside \*(L"changetext\*(R" for the line number. This is used so that error report
+refers to pamphlet line number instead of output line number
+.IP "\-C, \-\-change=changetext" 29
+.IX Item "-C, --change=changetext"
+Defaults to \*(L"{}\*(R" this is the text that will be replaced with the line number if
+the linetext option is specified
+.IP "\-?, \-\-help" 29
+.IX Item "-?, --help"
+Give this help list
+.IP "\-\-usage" 29
+.IX Item "--usage"
+Give a short usage message
+.IP "\-\-man" 29
+.IX Item "--man"
+Print manual page
+.IP "\-V, \-\-version" 29
+.IX Item "-V, --version"
+Print program version
+.SH "LICENSE"
+.IX Header "LICENSE"
+Copyright (C) 2019 Ernesto Lanchares Sanchez.
+.PP
+.Vb 5
+\& The clojure\-pamphlet tagler is free software; you can redistribute
+\& it and/or modify it under the terms of the GNU Lesser General
+\& Public License as published by the Free Software Foundation;
+\& either version 3 of the License, or (at your option) any later
+\& version.
+\&
+\& The clojure\-pamphlet tangler 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 Lesser General Public License for more details.
+\&
+\& You should have received a copy of the GNU Lesser General Public
+\& License along with this program; if not, see
+\& L<http://www.gnu.org/licenses/>.
+.Ve
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Ernesto Lanchares <e.lancha98@gmail.com>
+.SH "BUGS"
+.IX Header "BUGS"
+Report bugs to e.lancha98@gmail.com