paul@563 | 1 | .TH LPLC "1" "2017-02-09" "lplc 0.1" "User Commands" |
paul@563 | 2 | .SH NAME |
paul@563 | 3 | lplc \- Lichen Python-like compiler |
paul@563 | 4 | .SH SYNOPSIS |
paul@563 | 5 | .B lplc |
paul@563 | 6 | .RI [ options ] |
paul@563 | 7 | .I file |
paul@563 | 8 | .br |
paul@563 | 9 | .B lplc |
paul@563 | 10 | .I --help |
paul@563 | 11 | .br |
paul@563 | 12 | .B lplc |
paul@563 | 13 | .I --version |
paul@563 | 14 | .SH DESCRIPTION |
paul@563 | 15 | Compile the program whose principal file is given in place of |
paul@563 | 16 | .IR file . |
paul@563 | 17 | .SH OPTIONS |
paul@563 | 18 | The following options may be specified: |
paul@563 | 19 | .PP |
paul@563 | 20 | .TP |
paul@563 | 21 | .B \-c |
paul@563 | 22 | Only partially compile the program; do not attempt to build or link it |
paul@563 | 23 | .TP |
paul@563 | 24 | .B \-g |
paul@563 | 25 | Generate debugging information for the built executable |
paul@563 | 26 | .TP |
paul@563 | 27 | .B \-q |
paul@563 | 28 | Silence messages produced when building an executable |
paul@563 | 29 | .TP |
paul@563 | 30 | .B \-r |
paul@563 | 31 | Reset (discard) cached program information; inspect the whole program again |
paul@563 | 32 | .TP |
paul@563 | 33 | .B \-t |
paul@563 | 34 | Silence timing messages |
paul@563 | 35 | .TP |
paul@563 | 36 | .B \-tb |
paul@563 | 37 | Provide a traceback for any internal errors (development only) |
paul@563 | 38 | .TP |
paul@563 | 39 | .B \-v |
paul@563 | 40 | Report compiler activities in a verbose fashion (development only) |
paul@563 | 41 | .PP |
paul@563 | 42 | Some options may be followed by values, either immediately after the option |
paul@563 | 43 | (without any space between) or in the arguments that follow them: |
paul@563 | 44 | .PP |
paul@563 | 45 | .TP |
paul@563 | 46 | .B \-o |
paul@563 | 47 | Indicate the output executable name |
paul@563 | 48 | .TP |
paul@563 | 49 | .B \-W |
paul@563 | 50 | Show warnings on the topics indicated |
paul@563 | 51 | .PP |
paul@563 | 52 | Currently, the following warnings are supported: |
paul@563 | 53 | .TP |
paul@563 | 54 | .B all |
paul@563 | 55 | Show all possible warnings |
paul@563 | 56 | .TP |
paul@563 | 57 | .B args |
paul@563 | 58 | Show invocations where a callable may be involved that cannot accept |
paul@563 | 59 | the arguments provided |
paul@563 | 60 | .PP |
paul@563 | 61 | The following informational options can be specified to produce output instead |
paul@563 | 62 | of compiling a program: |
paul@563 | 63 | .PP |
paul@563 | 64 | .TP |
paul@563 | 65 | .B \-\-help |
paul@563 | 66 | Show a summary of the command syntax and options |
paul@563 | 67 | .TP |
paul@563 | 68 | .B \-\-version |
paul@563 | 69 | Show version information for this tool |
paul@563 | 70 | .SH COPYRIGHT |
paul@563 | 71 | Copyright \(co 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, |
paul@563 | 72 | 2014, 2015, 2016, 2017 Paul Boddie <paul@boddie.org.uk> |
paul@563 | 73 | .PP |
paul@563 | 74 | This program is free software; you may redistribute it under the terms of |
paul@563 | 75 | the GNU General Public License version 3 or (at your option) a later version. |
paul@563 | 76 | This program has absolutely no warranty. |
paul@563 | 77 | .SH SEE ALSO |
paul@563 | 78 | .BR cc (1), |
paul@563 | 79 | .BR make (1). |
paul@563 | 80 | .SH RESOURCES |
paul@563 | 81 | The project Web site: http://projects.boddie.org.uk/Lichen |