Skip to content

Commit b8a000a

Browse files
committed
Add manual page for cadabra-server
1 parent bdb9d50 commit b8a000a

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

client_server/CMakeLists.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,3 +170,13 @@ if (MSVC AND NOT INSTALL_TARGETS_ONLY)
170170
DESTINATION bin
171171
)
172172
endif()
173+
174+
# manual pages
175+
if(NOT MSVC)
176+
install(
177+
FILES
178+
../man/man1/cadabra-server.1
179+
DESTINATION
180+
man/man1
181+
)
182+
endif()

man/man1/cadabra-server.1

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.TH CADABRA-SERVER 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+
cadabra-server \- the server backend for running Cadabra2 notebooks
22+
.SH SYNOPSIS
23+
.BR "cadabra-server"
24+
.SH DESCRIPTION
25+
.B On starting cadabra-server, it will print a port number on stdout, where
26+
connections to the cadabra kernel can be made. All interaction with
27+
the server is through that port on the localhost interface.
28+
29+
.SH SEE ALSO
30+
.BR cadabra2-gtk (1), cadabra2 (1)
31+
32+
See the web page at
33+
.BR "https://cadabra.science/"
34+
for more information and up\-to\-date sample notebooks.
35+
.SH AUTHORS
36+
Kasper Peeters <[email protected]>
37+

0 commit comments

Comments
 (0)