[scilab] 27/29: Rework manpages
Julien Puydt
julien.puydt at laposte.net
Wed Nov 22 17:19:36 UTC 2017
This is an automated email from the git hooks/post-receive script.
jpuydt-guest pushed a commit to branch master
in repository scilab.
commit 925224fa98eb0ae0c7634b05bd5a0753802f57dc
Author: Julien Puydt <julien.puydt at laposte.net>
Date: Wed Nov 22 14:41:40 2017 +0100
Rework manpages
---
debian/XML2Modelica.1 | 14 +++++
debian/changelog | 1 +
debian/control | 2 +-
debian/intersci.1 | 21 -------
debian/modelicac.1 | 28 ++++++---
debian/modelicat.1 | 26 ++++++++
debian/rules | 5 --
debian/scilab-cli.links | 1 +
debian/scilab-cli.manpages | 1 -
debian/scilab-full-bin.manpages | 3 +-
debian/scilab.1 | 130 ++++++++++++++++++++++++++++++++++++++++
debian/scilab.links | 1 +
debian/scilab.manpages | 3 +-
debian/scinotes.1 | 11 ++++
debian/xcos.1 | 11 ++++
15 files changed, 221 insertions(+), 37 deletions(-)
diff --git a/debian/XML2Modelica.1 b/debian/XML2Modelica.1
new file mode 100644
index 0000000..e047bcc
--- /dev/null
+++ b/debian/XML2Modelica.1
@@ -0,0 +1,14 @@
+.TH "XML2Modelica" "1" "November 2017"
+.SH NAME
+XML2Modelica \- Scilab's translator from XML model to flat Modelica
+.SH SYNOPSIS
+.B XML2Modelica\fR \fB-o\fR <outputfile> <inputfile>
+.SH OPTIONS
+.TP
+.B -o\fR <outputfile>
+Set output file name
+.TP
+.B -init
+Generate flat Modelica code for initialization
+.SH AUTHOR
+Manpage written by Julien Puydt for Debian
diff --git a/debian/changelog b/debian/changelog
index cbdcef3..c94db27 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -30,6 +30,7 @@ scilab (6.0.0-1) UNRELEASED; urgency=medium
- Refresh patch to fix the build with OCaml 4.05.
- Add new build-depends.
- Add patch to handle the lucene 4.10 api.
+ * Rework the manpages.
-- Julien Puydt <julien.puydt at laposte.net> Tue, 14 Nov 2017 16:46:25 +0100
diff --git a/debian/control b/debian/control
index d31c469..bfeb49d 100644
--- a/debian/control
+++ b/debian/control
@@ -19,7 +19,7 @@ Build-Depends: cdbs, debhelper (>= 10), gfortran,
# Documentation
libjeuclid-core-java (>= 3.1.3), libbatik-java (>= 1.7), fop (>= 0.95),
javahelp2, libsaxon-java, libavalon-framework-java, docbook-xsl,
- libxml-commons-external-java, help2man,
+ libxml-commons-external-java,
# Optional Scilab features
libfftw3-dev, libsuitesparse-dev (>= 3.4.0),
libmatio-dev (>= 1.5.0),
diff --git a/debian/intersci.1 b/debian/intersci.1
deleted file mode 100644
index 321a414..0000000
--- a/debian/intersci.1
+++ /dev/null
@@ -1,21 +0,0 @@
-.TH "intersci" "1" "November 18, 2008"
-.SH NAME
-intersci \- intersci is a program for building an interface file between Scilab
-and C/Fortran functions/subroutines.
-.SH SYNOPSIS
-.B intersci \fIinterface_file\fP\ 'files'\ 'libs'
-
-.br
-This manual page documents briefly the
-.B intersci
-commands.
-.SH DESCRIPTION
-Intersci is a program for building an interface file between Scilab and
-Fortran subroutines or C functions. This interface describes both the routine
-called and the associated Scilab function.
-.PP
-See : http://www.scilab.org/doc/intersci.pdf
-.SH AUTHOR
-Intersci was written by the Scilab Consortium.
-.PP
-This manual page was written by Sylvestre Ledru <sylvestre at debian.org>.
diff --git a/debian/modelicac.1 b/debian/modelicac.1
index 3f5168b..602482d 100644
--- a/debian/modelicac.1
+++ b/debian/modelicac.1
@@ -1,8 +1,9 @@
-.TH "modelicac" "1" "November 18, 2008"
+.TH "modelicac" "1" "November 22, 2017"
.SH NAME
modelicac \- modelicac is a compiler for a subset of the Modelica language including parts of the 'equation' subset that can express relations between Real variable.
.SH SYNOPSIS
-.B modelicac [-c] [-o <outputfile>] <inputfile> [ -L directory | -hpath directory | -keep-all-variables | -jac | -no-parameter-removal | -no-simplifs | -trace filename | -xml ]
+\fBmodelicac\fR [\fB-c\fR] [\fB-o\fR <outputfile>] <inputfile> [\fB-L\fR <directory> | \fB-hpath\fR <directory> | \fB-keep-all-variables\fR | \fB-jac\fR | \fB-no-parameter-removal\fR | \fB-no-simplifs\fR | \fB-only-outputs\fR | \fB-trace\fR <filename> | \fB-with-init-in\fR <init_input_file> | \fB-with-init-out\fR <init_output_file> | \fB-xml\fR ]
+
This manual page documents briefly the
.B modelicac
commands.
@@ -15,16 +16,16 @@ A complete list of options is included below.
.B \-c
Compile only, do not instantiate. Modelicac produces a "*.moc" file when invoked with that option.
.TP
-.B \-o outputfile
+.B \-o <outputfile>
Set output file name to <outputfile> (this option also works
with \-c option but is somewhat useless because of the class
name restrictions given above).
.TP
-.B \-L directory
+.B \-L <directory>
Add <directory> to the list of directories to be searched when
producing a C file (no effect when used with \-c).
.TP
-.B \-hpath directory
+.B \-hpath <directory>
Specify a path to be added to #include directives in the
generated C code.
.TP
@@ -40,13 +41,26 @@ Do not remove any parameter
.B \-no-simplifs
Same as \-keep\-all\-variables \-no\-parameter\-removal
.TP
-.B \-trace filename
+.B \-only-outputs
+Generate code only for declared outputs
+(may have no effect depending on target)
+.TP
+.B \-trace <filename>
Generate tracing information for external function calls
into <filename>
.TP
+.B \-with-init-in <init_input_file>
+Generate initialization code and use the given file to get input data
+(may have no effect depending on target)
+.TP
+.B \-with-init-out <init_output_file>
+Generate initialization code and use the given file to generate output data
+(may have no effect depending on target)
+.TP
.B \-xml
Generate an XML version of the model instead of target code
.SH AUTHOR
Modelicac was written by TNI-Valiosys and Imagineby.
.PP
-This manual page was written by Sylvestre Ledru <sylvestre at debian.org>.
+This manual page was written by Sylvestre Ledru
+<sylvestre at debian.org>, and updated by Julien Puydt.
diff --git a/debian/modelicat.1 b/debian/modelicat.1
new file mode 100644
index 0000000..8381929
--- /dev/null
+++ b/debian/modelicat.1
@@ -0,0 +1,26 @@
+.TH "modelicat" "1" "November 2017"
+.SH NAME
+modelicat - translator for Xcos from Modelica 2.x to flat Modelica
+.SH SYNOPSIS
+\fBmodelicat\fR [\fB-lib\fR <filename>] [\fB-o\fR <filename>] [\fB-fundir\fR <dirname>] \fB-command\fR "command"
+.SH OPTIONS
+.TP
+.B \-fundir\fR <dirname>
+Directory containing the Modelica functions
+.TP
+.B \-lib\fR <filename>
+Declare the file as containing a Modelica library of classes
+.TP
+.B \-o\fR <filename>
+Specify target filename (default is `<instance name>.mo`)
+.TP
+.B \-command\fR "command"
+Define the component to be created as a regular Modelica component declaration
+.TP
+.B \-xml
+Generate an XML version of the model instead of flat Modelica code
+.TP
+.B \-with-init
+Generate an XML version of the initialization problem in a file named <filename>_init.xml
+.SH AUTHOR
+Manpage written by Julien Puydt for Debian
diff --git a/debian/rules b/debian/rules
index bacdf82..84adad7 100755
--- a/debian/rules
+++ b/debian/rules
@@ -85,11 +85,6 @@ install/scilab-data::
# Remove dead code
rm -rf $(DEB_DESTDIR)usr/share/scilab/modules/helptools/bin $(DEB_DESTDIR)usr/share/scilab/modules/tclsci/demos/tk/timer $(DEB_DESTDIR)usr/share/scilab/modules/intersci/examples/sedprov $(DEB_DESTDIR)usr/share/scilab/modules/macros
-# Generate the manpages
- help2man ./bin/scilab > debian/scilab.1
- help2man ./bin/scilab-cli > debian/scilab-cli.1
- help2man ./bin/scilab-adv-cli > debian/scilab-adv-cli.1
-
mkdir -p $(CURDIR)/debian/scilab-cli/usr/share/icons/
cp -R $(DEB_DESTDIR)usr/share/icons/hicolor/ $(CURDIR)/debian/scilab-cli/usr/share/icons/
diff --git a/debian/scilab-cli.links b/debian/scilab-cli.links
new file mode 100644
index 0000000..ce9b89c
--- /dev/null
+++ b/debian/scilab-cli.links
@@ -0,0 +1 @@
+usr/share/man/man1/scilab.1.gz usr/share/man/man1/scilab-cli.1.gz
diff --git a/debian/scilab-cli.manpages b/debian/scilab-cli.manpages
deleted file mode 100644
index f8d6c1c..0000000
--- a/debian/scilab-cli.manpages
+++ /dev/null
@@ -1 +0,0 @@
-debian/scilab-cli.1
diff --git a/debian/scilab-full-bin.manpages b/debian/scilab-full-bin.manpages
index c13d4e3..e896875 100644
--- a/debian/scilab-full-bin.manpages
+++ b/debian/scilab-full-bin.manpages
@@ -1,2 +1,3 @@
-debian/intersci.1
debian/modelicac.1
+debian/modelicat.1
+debian/XML2Modelica.1
diff --git a/debian/scilab.1 b/debian/scilab.1
new file mode 100644
index 0000000..255040c
--- /dev/null
+++ b/debian/scilab.1
@@ -0,0 +1,130 @@
+.TH "scilab-cli" "1" "November 2017"
+.SH NAME
+scilab, scilab-cli and scilab-adv-cli \- Scilab shell
+.SH SYNOPSIS
+.B scilab\fR <arguments>
+.PP
+.SH OPTIONS
+A complete list of options is included below.
+.SS General options
+.TP
+.B \-args\fR <rest>
+Accept all extra arguments and make them available through sciargs
+.TP
+.B \-display\fR <display> (or \fB\-d\fR <display>)
+Use the given server display (under Xwindow systems)
+.TP
+.B \-e\fR <instruction>
+Execute the scilab instruction given in argument
+(\fB\-e\fR and \fB\-f\fR arguments are mutually exclusive.)
+.TP
+.B \-f\fR <file>
+Execute the scilab script given in argument
+(\fB\-e\fR and \fB\-f\fR arguments are mutually exclusive.)
+.TP
+.B \-quit
+Force scilab exit after execution of script from \fB\-e\fR or \fB\-f\fR argument
+(this flag is ignored if it is not used with \fB\-e\fR or \fB\-f\fR argument)
+.TP
+.B \-l\fR <lang>
+change the language of scilab (default : en_US)
+.TP
+.B \-nocolor
+Remove the color in the cli and adv-cli modes
+.TP
+.B \-nw
+Enable console mode
+.TP
+.B \-nwni\fR (or \fB-nogui\fR)
+Enable terminal mode
+.SS "Developer Trace arguments"
+.TP
+.B \--parse-trace
+Display bison state machine evolution
+.TP
+.B \--AST-trace
+Display ASCII-art AST to be human readable
+.TP
+.B \--pretty-print
+Display pretty-printed code, standard Scilab syntax.
+.SS "Developer Timer arguments"
+.TP
+.B \--AST-timed
+Time each AST node
+.TP
+.B \--timed
+Time global execution
+.SS "Developer Debug arguments"
+.TP
+.B \--context-dump
+Display context status
+.TP
+.B \--exec-verbose
+Display command before running it.
+.TP
+.B \-nb
+Do not display Scilab loading on start
+.TP
+.B \-noatomsautoload
+Do not load ATOMS installed module
+.TP
+.B \--no-exec
+Only do Lexing/parsing do not execute instructions
+.TP
+.B \-nouserstartup
+Do not execute the user startup files SCIHOME/.scilab or SCIHOME/scilab.ini
+.TP
+.B \-ns
+Don't execute etc/scilab.start
+(will disable many features - only use if you know what you are doing)
+.TP
+.B \--timeout\fR <delay>
+Kill the Scilab process after the given delay
+.SS "Developer arguments"
+.TP
+.B \-debug
+Start Scilab under gdb
+(define the variable SCILAB_GDB_OPT to add custom arguments to gdb)
+.TP
+.B \-debug-kdbg
+Start Scilab under kdbg
+.TP
+.B \-profiling
+Start Scilab under valgrind
+(define the variable SCILAB_VALGRIND_OPT to add custom arguments to
+valgrind and override the existing valgrind arguments)
+.TP
+.B \-profiling-visu
+Start Scilab under callgrind
+(define the variable SCILAB_VALGRIND_OPT to add custom arguments to
+callgrind and override the existing callgrind arguments)
+.TP
+.B \-disable-exception-catching
+Disable Scilab exception catching system.
+.TP
+.B \--parse-file\fR <file>
+Only parse the given file argument without execution and exit
+.TP
+.B \--parse-trace
+Display bison state machine evolution
+.TP
+.B \--pretty-print
+Display pretty-printed code using standard Scilab syntax
+.SH ENVIRONMENT VARIABLES
+.TP
+SCIVERBOSE
+Provides debugging information of the startup
+.TP
+JAVA_HOME
+Declares which Java Virtual Machine to use
+.TP
+SCI_DISABLE_TK
+Disables Tk (but not Tcl) features
+.TP
+SCI_JAVA_ENABLE_HEADLESS
+Runs Java Headless VM
+.TP
+SCI_DISABLE_EXCEPTION_CATCHING
+Disable the catch by Scilab of exception (segfault, ...)
+.SH AUTHOR
+This manual page was written by Julien Puydt for Debian
diff --git a/debian/scilab.links b/debian/scilab.links
new file mode 100644
index 0000000..031a7c1
--- /dev/null
+++ b/debian/scilab.links
@@ -0,0 +1 @@
+usr/share/man/man1/scilab.1.gz usr/share/man/man1/scilab-adv-cli.1.gz
diff --git a/debian/scilab.manpages b/debian/scilab.manpages
index 8501608..4f121b8 100644
--- a/debian/scilab.manpages
+++ b/debian/scilab.manpages
@@ -1,2 +1,3 @@
-debian/scilab-adv-cli.1
debian/scilab.1
+debian/scinotes.1
+debian/xcos.1
diff --git a/debian/scinotes.1 b/debian/scinotes.1
new file mode 100644
index 0000000..54d7f7e
--- /dev/null
+++ b/debian/scinotes.1
@@ -0,0 +1,11 @@
+.TH "scinotes" "1" "November 2017"
+.SH NAME
+scinotes - Scilab text editor
+.SH SYNOPSIS
+.B scinotes\fR [files]
+.SH OPTIONS
+.TP
+.B \-indent
+format (indent, trailing spaces, quote mismatch) the given files
+.SH AUTHOR
+Manpage written by Julien Puydt for Debian
diff --git a/debian/xcos.1 b/debian/xcos.1
new file mode 100644
index 0000000..29766f7
--- /dev/null
+++ b/debian/xcos.1
@@ -0,0 +1,11 @@
+.TH "xcos" "1" "November 2017"
+.SH NAME
+xcos - Scilab's hybrid simulator
+.SH SYNOPSIS
+.B scinotes\fR [files.xcos]
+.SH OPTIONS
+.TP
+.B \-simulate
+Start the simulation - only one file will be accepted
+.SH AUTHOR
+Manpage written by Julien Puydt for Debian
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/scilab.git
More information about the debian-science-commits
mailing list