[SCM] Lisaac documentation branch, master, updated. 61d02b84e40fb3a8a09a36a99fc1b1385a1dd846

Benoit Sonntag sonntag at icps.u-strasbg.fr
Thu Nov 12 00:44:03 UTC 2009


The following commit has been merged in the master branch:
commit 61d02b84e40fb3a8a09a36a99fc1b1385a1dd846
Author: Benoit Sonntag <sonntag at icps.u-strasbg.fr>
Date:   Thu Nov 12 01:44:02 2009 +0100

    Add manpage

diff --git a/manpage/lisaac.1 b/manpage/lisaac.1
new file mode 100644
index 0000000..5e3358c
--- /dev/null
+++ b/manpage/lisaac.1
@@ -0,0 +1,79 @@
+.TH "LISAAC" "1" "January 2008" "Xavier Oswald" "lisaac - programming language"
+.SH "NAME"
+lisaac \- lisaac compiler
+.SH "SYNOPSIS"
+.B lisaac <input_file[.li]> [Options]
+
+.SH "DESCRIPTION"
+This manual page documents briefly the
+.BR lisaac
+compiler. 
+.BR lisaac
+is the first compiled object\-oriented language based on prototype concepts, with system programming facilities and design by contract.
+Lisaac's developers admired both Self's flexibility and dynamic inheritance, and Eiffel's static typing and design by contract features. Seeking to combine these two apparently contradictory feature sets, lisaac was created.
+.br 
+
+The 
+.BR lisaac
+compiler produces optimized ANSI C code, which can then be compiled on every architecture with an appropriate C compiler which makes lisaac a real multi\-platform language. Compilation results show that it is possible to obtain executables from a high\-level prototype\-based language that are as fast as C programs.
+.SH "OPTIONS"
+.SS 
+.TP 
+.B  \-o <output_file>
+Output file (default:`input_file.c')
+.TP 
+.B  \-t <machine>
+Target code (see path.li)
+.TP 
+.B  \-s
+Statistic information
+.TP 
+.B  \-[d|D]([+|\-]|[1\-20])
+Debug mode (default: `debug_level' = 0)
+.br 
+`d'   : Without source code.
+.br 
+`D'   : With source code.
+.br 
+[d|D]\-: `debug_level' = 5
+.br 
+        (Require library only)
+.br 
+[d|D] : `debug_level' = 10
+.br 
+        (Append user assertion)
+.br 
+[d|D]+: `debug_level' = 15
+.br 
+        (Append Ensure library)
+.br 
+[d|D]n: `debug_level' = n (with 0<n<21)
+.TP 
+.B  \-w
+Warning error stop compiler
+.TP 
+.B  \-W
+All warning (deferred detect, ...)
+.TP 
+.B  \-O
+Full optimization
+.TP 
+.B  \-i[1\-5000]
+Inlining level (default : 15)
+.TP 
+.B  \-q
+Quiet operation
+
+
+
+
+.SH "SEE ALSO"
+The program is fully documented in the directory
+\fI/usr/share/doc/lisaac/html/\fR.
+.BR shorter (1)
+
+.SH "AUTHOR"
+Lisaac was developed by Benoit Sonntag <sonntag at icps.u\-strasbg.fr>.
+
+This manual page was written by Xavier Oswald <x.oswald at free.fr>.
+
diff --git a/manpage/lisaac.1.gz b/manpage/lisaac.1.gz
new file mode 100644
index 0000000..14ce7f7
Binary files /dev/null and b/manpage/lisaac.1.gz differ
diff --git a/manpage/shorter.1 b/manpage/shorter.1
new file mode 100644
index 0000000..0877bf2
--- /dev/null
+++ b/manpage/shorter.1
@@ -0,0 +1,37 @@
+.TH "SHORTER" "1" "January 2008" "Xavier Oswald" "SHORTER - lisaac documentation generation"
+.SH "NAME"
+shorter \- lisaac documentation generation
+.SH "SYNOPSIS"
+.B shorter <input_file[.li]> [Options]
+.SH "DESCRIPTION"
+This manual page documents briefly the
+.BR shorter
+program.
+
+.BR shorter
+is the lisaac documentation generator. It take as entry a lisaac file or a directory containing lisaac files and generate the appropriated html files as output. It looks like the javadoc as result.
+.SH "OPTIONS"
+.SS 
+.TP 
+.B  \-o <output_file>
+Output file or directory (default:`input_file.ext')
+.TP 
+.B  \-p 
+Include private section
+.TP 
+.B  \-c
+Include source code
+.TP 
+.B  \-r
+Recursive builder documentation
+.TP 
+.B  \-f <format_file>
+Formatting description file (see: /usr/lib/lisaac/shorter/)
+
+.SH "SEE ALSO"
+.BR lisaac (1)
+.SH "AUTHOR"
+Lisaac was developed by Benoit Sonntag <sonntag at icps.u\-strasbg.fr>.
+
+This manual page was written by Xavier Oswald <x.oswald at free.fr>.
+
diff --git a/manpage/shorter.1.gz b/manpage/shorter.1.gz
new file mode 100644
index 0000000..15901f0
Binary files /dev/null and b/manpage/shorter.1.gz differ

-- 
Lisaac documentation



More information about the Lisaac-commits mailing list