madlang-3.1.1.21: man/madlang.1

.\" Automatically generated by Pandoc 2.0.2
.\"
.TH "madlang (1)" "" "" "" ""
.hy
.SH NAME
.PP
madlang \- a text templating language for generative literature
.SH SYNOPSIS
.PP
madlang run <file>
.PP
madlang tree <file>
.PP
madlang check <file>
.PP
madlang get <repo>
.PP
madlang sample <repo>
.SH DESCRIPTION
.PP
\f[B]madlang\f[] is an interpreted language for generative literature
and computational creativity.
.SH OPTIONS
.TP
.B \f[B]\-h\f[] \f[B]\-\-help\f[]
Display help
.RS
.RE
.TP
.B \f[B]\-r\f[] \f[B]\-\-rep\f[]
Generate output more than once
.RS
.RE
.TP
.B \f[B]\-i\f[]
Set an input to the template
.RS
.RE
.SH CONFIGURATION
.PP
Place files in $HOME/.madlang for them to be available globally as
libraries.
You can also download prebundled packages using
.IP
.nf
\f[C]
madlang\ install
\f[]
.fi
.SH EDITOR INTEGRATION
.PP
You can install a vim plugin for Madlang using
.IP
.nf
\f[C]
madlang\ vim
\f[]
.fi
.PP
Alternately, it is available from
.PP
https://github.com/vmchale/madlang\-vim
.SH LIBRARIES
.PP
You can install third\-party libraries with
.IP
.nf
\f[C]
madlang\ get\ user/repo
\f[]
.fi
.PP
The library will then be installed to $HOME/.madlang/repo
.SH MODIFIERS
.PP
Strings in madlang can be followed by modifiers, for instance
.IP
.nf
\f[C]
1.0\ "evil".oulipo
\f[]
.fi
.PP
Currently supported modifiers are:
.IP \[bu] 2
to_lower
.IP \[bu] 2
to_upper
.IP \[bu] 2
capitalize
.IP \[bu] 2
reverse
.IP \[bu] 2
oulipo (removes all instances of the letter `e')
.SH DISPLAYING TREES
.PP
You may wish to use the command
.IP
.nf
\f[C]
madlang\ tree\ file.mad\ |\ less
\f[]
.fi
.PP
for larger trees.
.SH EXAMPLES
.PP
You can examine an example using the bundled libraries at
https://hub.darcs.net/vmchale/madlang\-insults.
.SH COPYRIGHT
.PP
Copyright 2017.
Vanessa McHale.
All Rights Reserved.
.SH AUTHORS
Vanessa McHale<vanessa.mchale@reconfigure.io>.