1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/lplc.1 Thu Feb 09 21:44:25 2017 +0100
1.3 @@ -0,0 +1,81 @@
1.4 +.TH LPLC "1" "2017-02-09" "lplc 0.1" "User Commands"
1.5 +.SH NAME
1.6 +lplc \- Lichen Python-like compiler
1.7 +.SH SYNOPSIS
1.8 +.B lplc
1.9 +.RI [ options ]
1.10 +.I file
1.11 +.br
1.12 +.B lplc
1.13 +.I --help
1.14 +.br
1.15 +.B lplc
1.16 +.I --version
1.17 +.SH DESCRIPTION
1.18 +Compile the program whose principal file is given in place of
1.19 +.IR file .
1.20 +.SH OPTIONS
1.21 +The following options may be specified:
1.22 +.PP
1.23 +.TP
1.24 +.B \-c
1.25 +Only partially compile the program; do not attempt to build or link it
1.26 +.TP
1.27 +.B \-g
1.28 +Generate debugging information for the built executable
1.29 +.TP
1.30 +.B \-q
1.31 +Silence messages produced when building an executable
1.32 +.TP
1.33 +.B \-r
1.34 +Reset (discard) cached program information; inspect the whole program again
1.35 +.TP
1.36 +.B \-t
1.37 +Silence timing messages
1.38 +.TP
1.39 +.B \-tb
1.40 +Provide a traceback for any internal errors (development only)
1.41 +.TP
1.42 +.B \-v
1.43 +Report compiler activities in a verbose fashion (development only)
1.44 +.PP
1.45 +Some options may be followed by values, either immediately after the option
1.46 +(without any space between) or in the arguments that follow them:
1.47 +.PP
1.48 +.TP
1.49 +.B \-o
1.50 +Indicate the output executable name
1.51 +.TP
1.52 +.B \-W
1.53 +Show warnings on the topics indicated
1.54 +.PP
1.55 +Currently, the following warnings are supported:
1.56 +.TP
1.57 +.B all
1.58 +Show all possible warnings
1.59 +.TP
1.60 +.B args
1.61 +Show invocations where a callable may be involved that cannot accept
1.62 +the arguments provided
1.63 +.PP
1.64 +The following informational options can be specified to produce output instead
1.65 +of compiling a program:
1.66 +.PP
1.67 +.TP
1.68 +.B \-\-help
1.69 +Show a summary of the command syntax and options
1.70 +.TP
1.71 +.B \-\-version
1.72 +Show version information for this tool
1.73 +.SH COPYRIGHT
1.74 +Copyright \(co 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013,
1.75 +2014, 2015, 2016, 2017 Paul Boddie <paul@boddie.org.uk>
1.76 +.PP
1.77 +This program is free software; you may redistribute it under the terms of
1.78 +the GNU General Public License version 3 or (at your option) a later version.
1.79 +This program has absolutely no warranty.
1.80 +.SH SEE ALSO
1.81 +.BR cc (1),
1.82 +.BR make (1).
1.83 +.SH RESOURCES
1.84 +The project Web site: http://projects.boddie.org.uk/Lichen