From a957d6d87d866a011c3ca9ebe9aaefcb05dded33 Mon Sep 17 00:00:00 2001 From: Stefano Zacchiroli Date: Thu, 14 Jun 2007 21:21:41 +0000 Subject: [PATCH] added manpages for camlp4 related tools --- debian/TODO.Debian | 16 +---- debian/changelog | 5 +- debian/man/camlp4.1 | 137 +++++++++++++++++++++++++++++++++++++ debian/man/camlp4boot.1 | 1 + debian/man/camlp4o.1 | 1 + debian/man/camlp4of.1 | 1 + debian/man/camlp4of.opt.1 | 1 + debian/man/camlp4oof.1 | 1 + debian/man/camlp4oof.opt.1 | 1 + debian/man/camlp4orf.1 | 1 + debian/man/camlp4orf.opt.1 | 1 + debian/man/camlp4prof.1 | 1 + debian/man/camlp4r.1 | 1 + debian/man/camlp4rf.1 | 1 + debian/man/camlp4rf.opt.1 | 1 + debian/man/mkcamlp4.1 | 1 + debian/ocaml-nox.manpages | 1 + 17 files changed, 156 insertions(+), 16 deletions(-) create mode 100644 debian/man/camlp4.1 create mode 100644 debian/man/camlp4boot.1 create mode 100644 debian/man/camlp4o.1 create mode 100644 debian/man/camlp4of.1 create mode 100644 debian/man/camlp4of.opt.1 create mode 100644 debian/man/camlp4oof.1 create mode 100644 debian/man/camlp4oof.opt.1 create mode 100644 debian/man/camlp4orf.1 create mode 100644 debian/man/camlp4orf.opt.1 create mode 100644 debian/man/camlp4prof.1 create mode 100644 debian/man/camlp4r.1 create mode 100644 debian/man/camlp4rf.1 create mode 100644 debian/man/camlp4rf.opt.1 create mode 100644 debian/man/mkcamlp4.1 create mode 100644 debian/ocaml-nox.manpages diff --git a/debian/TODO.Debian b/debian/TODO.Debian index 647d568d..9f5f1f11 100644 --- a/debian/TODO.Debian +++ b/debian/TODO.Debian @@ -4,25 +4,11 @@ TODO list for ocaml 3.10.0 (and beyond ...) W: ocaml source: substvar-source-version-is-deprecated ocaml-nox W: ocaml source: substvar-source-version-is-deprecated ocaml W: ocaml source: substvar-source-version-is-deprecated ocaml-native-compilers - W: ocaml-nox: binary-without-manpage usr/bin/camlp4 - W: ocaml-nox: binary-without-manpage usr/bin/camlp4boot - W: ocaml-nox: binary-without-manpage usr/bin/camlp4o - W: ocaml-nox: binary-without-manpage usr/bin/camlp4of - W: ocaml-nox: binary-without-manpage usr/bin/camlp4oof - W: ocaml-nox: binary-without-manpage usr/bin/camlp4orf - W: ocaml-nox: binary-without-manpage usr/bin/camlp4prof - W: ocaml-nox: binary-without-manpage usr/bin/camlp4r - W: ocaml-nox: binary-without-manpage usr/bin/camlp4rf - W: ocaml-nox: binary-without-manpage usr/bin/mkcamlp4 W: ocaml-nox: binary-without-manpage usr/bin/ocamlbuild.byte W: ocaml-nox: binary-without-manpage usr/bin/ocamlbuild.native W: ocaml-nox: script-not-executable ./usr/lib/ocaml/3.10.0/camlheader - W: ocaml-native-compilers: binary-without-manpage usr/bin/camlp4of.opt - W: ocaml-native-compilers: binary-without-manpage usr/bin/camlp4oof.opt - W: ocaml-native-compilers: binary-without-manpage usr/bin/camlp4orf.opt - W: ocaml-native-compilers: binary-without-manpage usr/bin/camlp4rf.opt W: ocaml-mode: binary-without-manpage usr/bin/ocamltags - E: ocaml-compiler-libs: copyright-should-refer-to-common-license-file-for-gpl + E: ocaml-compiler-libs: copyright-should-refer-to-common-license-file-for-gpl -->> bogus? W: ocaml-base-nox: binary-without-manpage usr/bin/ocaml-md5sums W: ocaml: binary-without-manpage usr/bin/labltk W: ocaml: binary-without-manpage usr/bin/ocamlbrowser diff --git a/debian/changelog b/debian/changelog index ce35835b..7e7ec51b 100644 --- a/debian/changelog +++ b/debian/changelog @@ -6,8 +6,11 @@ ocaml (3.10.0-2) UNRELEASED; urgency=low package (if any) and suggest the usage of ${binary:Version} * debian/copyright - added in place of copyright.in, nothing to replace there + * debian/man/camlp4*.1 + - added manpage for camlp4 related executables; content partially using + html2man, partially taken from the camlp4 wiki - -- Stefano Zacchiroli Thu, 14 Jun 2007 20:40:44 +0100 + -- Stefano Zacchiroli Thu, 14 Jun 2007 22:20:02 +0100 ocaml (3.10.0-1) experimental; urgency=low diff --git a/debian/man/camlp4.1 b/debian/man/camlp4.1 new file mode 100644 index 00000000..c1070247 --- /dev/null +++ b/debian/man/camlp4.1 @@ -0,0 +1,137 @@ +.TH CAMLP4 "1" "June 2007" "CamlP4 3.10.0" "User Commands" +.SH NAME +CamlP4 \- Pre-Processor-Pretty-Printer for Objective Caml +.SH SYNOPSIS +.B camlp4 +[\fIload-options\fR] [\fI--\fR] [\fIother-options\fR] +.SH DESCRIPTION +Camlp4 is a Pre-Processor-Pretty-Printer for Objective Caml. It offers tools +for syntax (Stream Parsers and Grammars) and the ability to modify the concrete +syntax of the language (Quotations, Syntax Extensions). + +The Objective Caml compiler has a special option "-pp", allowing to call any +preprocessor. If Camlp4 is used, the parsing is done (only once) by Camlp4, and +the Objective Caml compiler resumes the rest of the compilation (typing, code +generation). + +Camlp4 can parse normal OCaml concrete syntax or any other user-definable +syntax. As an example, an alternative syntax is provided, named Revised, +because it tries to fix some problems of the original syntax. + +Camlp4 can pretty print the normal OCaml concrete syntax or the revised one +(Pretty-Printer). It is therefore always possible to have a version of your +sources compilable by the compiler Objective Caml without preprocessing. + +Camlp4 can also serve as a Program Transformation tool, the user can supply +transformations and apply them easily as a pre-processing task. This is done +with Filters. +.SH OPTIONS +.TP +\fB.ml\fR +Parse this implementation file +.TP +\fB.mli\fR +Parse this interface file +.TP +\fB.(cmo|cma)\fR +Load this module inside the Camlp4 core +.TP +\fB\-I\fR +Add directory in search patch for object files. +.TP +\fB\-where\fR +Print camlp4 library directory and exit. +.TP +\fB\-nolib\fR +No automatic search for object files in library directory. +.TP +\fB\-intf\fR +Parse as an interface, whatever its extension. +.TP +\fB\-impl\fR +Parse as an implementation, whatever its extension. +.TP +\fB\-str\fR +Parse as an implementation. +.TP +\fB\-unsafe\fR +Generate unsafe accesses to array and strings. +.TP +\fB\-noassert\fR +Obsolete, do not use this option. +.TP +\fB\-verbose\fR +More verbose in parsing errors. +.TP +\fB\-loc\fR +Name of the location variable (default: _loc). +.TP +\fB\-QD\fR +Dump quotation expander result in case of syntax error. +.TP +\fB\-o\fR +Output on instead of standard output. +.TP +\fB\-v\fR +Print Camlp4 version and exit. +.TP +\fB\-version\fR +Print Camlp4 version number and exit. +.TP +\fB\-no_quot\fR +Don't parse quotations, allowing to use, e.g. "<:>" as token. +.TP +\fB\-loaded\-modules\fR +Print the list of loaded modules. +.TP +\fB\-parser\fR +Load the parser Camlp4Parsers/.cmo +.TP +\fB\-printer\fR +Load the printer Camlp4Printers/.cmo +.TP +\fB\-filter\fR +Load the filter Camlp4Filters/.cmo +.TP +\fB\-ignore\fR +ignore the next argument +.TP +\fB\-\-\fR +Deprecated, does nothing +.PP +Options added by loaded object files: +.TP +\fB\-I\fR +Add a directory to INCLUDE search path. +.TP +\fB\-U\fR +Undefine for IFDEF instruction. +.TP +\fB\-D\fR +Define for IFDEF instruction. +.TP +\fB\-meta_action\fR +Undocumented +.TP +\fB\-split_gext\fR +Old name for the option \fB\-split_ext\fR. +.TP +\fB\-split_ext\fR +Split EXTEND by functions to turn around a PowerPC problem. +.TP +\fB\-help_seq\fR +Print explanations about new sequences and exit. +.SH "SEE ALSO" +.BR ocamlc(1), +.BR ocaml(1). +.br +The full documentation for +.B CamlP4 +is being developed on a Wiki available on the web at +.br +.B . +.SH AUTHOR +CamlP4 is Copyright INRIA, it was mainly written by Nicolas Pouillard. +.PP +This manual page was written by Stefano Zacchiroli , +for the Debian project (but may be used by others). diff --git a/debian/man/camlp4boot.1 b/debian/man/camlp4boot.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4boot.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4o.1 b/debian/man/camlp4o.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4o.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4of.1 b/debian/man/camlp4of.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4of.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4of.opt.1 b/debian/man/camlp4of.opt.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4of.opt.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4oof.1 b/debian/man/camlp4oof.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4oof.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4oof.opt.1 b/debian/man/camlp4oof.opt.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4oof.opt.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4orf.1 b/debian/man/camlp4orf.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4orf.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4orf.opt.1 b/debian/man/camlp4orf.opt.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4orf.opt.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4prof.1 b/debian/man/camlp4prof.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4prof.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4r.1 b/debian/man/camlp4r.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4r.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4rf.1 b/debian/man/camlp4rf.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4rf.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/camlp4rf.opt.1 b/debian/man/camlp4rf.opt.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/camlp4rf.opt.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/man/mkcamlp4.1 b/debian/man/mkcamlp4.1 new file mode 100644 index 00000000..96b01d97 --- /dev/null +++ b/debian/man/mkcamlp4.1 @@ -0,0 +1 @@ +.so camlp4.1 diff --git a/debian/ocaml-nox.manpages b/debian/ocaml-nox.manpages new file mode 100644 index 00000000..c2fb6982 --- /dev/null +++ b/debian/ocaml-nox.manpages @@ -0,0 +1 @@ +debian/camlp4*.1 -- 2.30.2