Skip to content

Commit 024bf3d

Browse files
kpeeterskpeeters
committed
Add more manual pages
1 parent eec645b commit 024bf3d

File tree

4 files changed

+117
-0
lines changed

4 files changed

+117
-0
lines changed

‎core/CMakeLists.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,9 @@ if(NOT MSVC)
368368
install(
369369
FILES
370370
../man/man1/cadabra2.1
371+
../man/man1/cadabra2cadabra.1
372+
../man/man1/cadabra2html.1
373+
../man/man1/cadabra2python.1
371374
DESTINATION
372375
man/man1
373376
)

‎man/man1/cadabra2cadabra.1‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.TH CADABRA2CADABRA 1 "Jan 22, 2019" "" ""
2+
.\"
3+
.\" Man page written by Kasper Peeters <[email protected]>
4+
.\"
5+
.\" This program is free software; you can redistribute it and/or modify
6+
.\" it under the terms of the GNU General Public License as published by
7+
.\" the Free Software Foundation; either version 3 of the License, or
8+
.\" (at your option) any later version.
9+
.\"
10+
.\" This program is distributed in the hope that it will be useful,
11+
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
.\" GNU General Public License for more details.
14+
.\"
15+
.\" You should have received a copy of the GNU General Public License
16+
.\" along with this program; if not, write to the Free Software
17+
.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18+
.\"
19+
.\"
20+
.SH NAME
21+
cadabra2cadabra \- convert Cadabra2 notebooks to text input files
22+
.SH SYNOPSIS
23+
.BR "cadabra2-gtk [notebook file (.cnb)]"
24+
.SH DESCRIPTION
25+
.B The Cadabra2-Gtk notebook front\-end for Cadabra2 produces
26+
notebooks in a JSON format. This command converts these to standard
27+
text input files which can be processed with the command-line client
28+
cadabra2.
29+
30+
.SH SEE ALSO
31+
.BR cadabra2-gtk (1), cadabra2 (1)
32+
33+
See the web page at
34+
.BR "https://cadabra.science/"
35+
for more information and up\-to\-date sample notebooks.
36+
.SH AUTHORS
37+
Kasper Peeters <[email protected]>
38+

‎man/man1/cadabra2html.1‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.TH CADABRA2HTML 1 "Jan 22, 2019" "" ""
2+
.\"
3+
.\" Man page written by Kasper Peeters <[email protected]>
4+
.\"
5+
.\" This program is free software; you can redistribute it and/or modify
6+
.\" it under the terms of the GNU General Public License as published by
7+
.\" the Free Software Foundation; either version 3 of the License, or
8+
.\" (at your option) any later version.
9+
.\"
10+
.\" This program is distributed in the hope that it will be useful,
11+
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
.\" GNU General Public License for more details.
14+
.\"
15+
.\" You should have received a copy of the GNU General Public License
16+
.\" along with this program; if not, write to the Free Software
17+
.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18+
.\"
19+
.\"
20+
.SH NAME
21+
cadabra2html \- convert Cadabra2 notebooks to standalone HTML files
22+
.SH SYNOPSIS
23+
.BR "cadabra2-gtk [notebook file (.cnb)]"
24+
.SH DESCRIPTION
25+
.B This command converts Cadabra2 notebooks to a standalone HTML
26+
file, including all maths and graphics. It does the same thing as
27+
the 'File / Export to standalone HTML' menu option in the
28+
cadabra2-gtk notebook interface.
29+
30+
.SH SEE ALSO
31+
.BR cadabra2-gtk (1).
32+
33+
See the web page at
34+
.BR "https://cadabra.science/"
35+
for more information and up\-to\-date sample notebooks.
36+
.SH AUTHORS
37+
Kasper Peeters <[email protected]>
38+

‎man/man1/cadabra2python.1‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.TH CADABRA2PYTHON 1 "Jan 22, 2019" "" ""
2+
.\"
3+
.\" Man page written by Kasper Peeters <[email protected]>
4+
.\"
5+
.\" This program is free software; you can redistribute it and/or modify
6+
.\" it under the terms of the GNU General Public License as published by
7+
.\" the Free Software Foundation; either version 3 of the License, or
8+
.\" (at your option) any later version.
9+
.\"
10+
.\" This program is distributed in the hope that it will be useful,
11+
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
.\" GNU General Public License for more details.
14+
.\"
15+
.\" You should have received a copy of the GNU General Public License
16+
.\" along with this program; if not, write to the Free Software
17+
.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18+
.\"
19+
.\"
20+
.SH NAME
21+
cadabra2python \- convert Cadabra2 text input files to pure Python
22+
.SH SYNOPSIS
23+
.BR "cadabra2-gtk [notebook file (.cnb)]"
24+
.SH DESCRIPTION
25+
.B The input format for cadabra2 is a special mixture of Cadabra2
26+
notation and Python code. The cadabra2python command converts these
27+
input files to pure Python files, which can be processed by
28+
Python directly.
29+
30+
.SH SEE ALSO
31+
.BR cadabra2 (1).
32+
33+
See the web page at
34+
.BR "https://cadabra.science/"
35+
for more information and up\-to\-date sample notebooks.
36+
.SH AUTHORS
37+
Kasper Peeters <[email protected]>
38+

0 commit comments

Comments
 (0)