Skip to content

Commit 04138f1

Browse files
committed
Add manual pages.
1 parent d11e42b commit 04138f1

File tree

4 files changed

+111
-0
lines changed

4 files changed

+111
-0
lines changed

core/CMakeLists.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,3 +361,13 @@ install(
361361
if (MSVC AND NOT INSTALL_TARGETS_ONLY)
362362
install_dlls_from("core")
363363
endif()
364+
365+
# manual pages
366+
if(NOT MSVC)
367+
install(
368+
FILES
369+
../man/man1/cadabra2.1
370+
DESTINATION
371+
man/man1
372+
)
373+
endif()

frontend/gtkmm/CMakeLists.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,3 +174,13 @@ if (NOT INSTALL_TARGETS_ONLY)
174174
install_dlls_from("frontend/gtkmm")
175175
endif()
176176
endif()
177+
178+
# manual pages
179+
if(NOT MSVC)
180+
install(
181+
FILES
182+
../../man/man1/cadabra2-gtk.1
183+
DESTINATION
184+
man/man1
185+
)
186+
endif()

man/man1/cadabra2-gtk.1

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.TH CADABRA2-GTK 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+
cadabra2-gtk \- gtk notebook front\-end for cadabra2
22+
.SH SYNOPSIS
23+
.BR "cadabra2-gtk [notebook file (.cnb)]"
24+
.SH DESCRIPTION
25+
.B Cadabra2-Gtk
26+
is a graphical notebook front\-end for the computer algebra system
27+
.B cadabra2
28+
which makes use of the Gtk toolkit.
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+

man/man1/cadabra2.1

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.TH CADABRA2 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+
cadabra2 \- field\-theory motivated computer algebra system, 2.x series
22+
.SH SYNOPSIS
23+
.BR "cadabra2 [-d] [input file (.cdb)]"
24+
.SH DESCRIPTION
25+
.B Cadabra2
26+
is a computer algebra system for the solution of (quantum) field
27+
theory problems.
28+
29+
This is the command-line client for the Cadabra2 computer algebra
30+
system for field theory problems.
31+
32+
.SH OPTIONS
33+
.TP
34+
\fB \-d\fR
35+
Runs under control of the default debugger.
36+
37+
.SH ENVIRONMENT VARIABLES
38+
The following variables toggle various features on or off, depending
39+
on whether the variable is set or not:
40+
.TP
41+
\fB CADABRA_NO_UNICODE\fR
42+
Do not use UTF8 characters to display greek characters and
43+
mathematical symbols. Instead, use their LaTeX equivalent, so
44+
that the output is pure ASCII.
45+
.SH SEE ALSO
46+
.BR cadabra2-gtk (1).
47+
48+
See the web page at
49+
.BR "https://cadabra.science/"
50+
for binaries, example calculations and the full manual.
51+
.SH AUTHORS
52+
Kasper Peeters <[email protected]>
53+

0 commit comments

Comments
 (0)