Skip to content

Commit de5ba83

Browse files
committed
Add manual pages
Adapted the contents of `README.adoc`. To regenerate: $ asciidoctor -b manpage -a revnumber=1.2.0 *.1.adoc Signed-off-by: Philippe Proulx <[email protected]>
1 parent d21662c commit de5ba83

File tree

7 files changed

+1529
-0
lines changed

7 files changed

+1529
-0
lines changed

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ set (CMAKE_CXX_STANDARD_REQUIRED ON)
1515

1616
# jome
1717
add_subdirectory (assets)
18+
add_subdirectory (man)
1819
add_subdirectory (jome)
1920
add_subdirectory (jome-ctl)

man/CMakeLists.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Copyright (C) 2025 Philippe Proulx <eepp.ca>
2+
#
3+
# This software may be modified and distributed under the terms
4+
# of the MIT license. See the LICENSE file for details.
5+
6+
install (
7+
FILES
8+
jome.1
9+
jome-ctl.1
10+
DESTINATION
11+
share/man/man1
12+
)

man/about.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
== About
2+
3+
**jome** was originally written by and is maintained by, as of jome
4+
{revnumber}, Philippe Proulx (**eepp**).
5+
6+
GitHub project: ⟨https://github.com/eepp/jome⟩.

man/jome-ctl.1

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'\" t
2+
.\" Title: vlttng
3+
.\" Author: [see the "AUTHOR(S)" section]
4+
.\" Generator: Asciidoctor 2.0.23
5+
.\" Date: 8 April 2025
6+
.\" Manual: JOME
7+
.\" Source: JOME
8+
.\" Language: English
9+
.\"
10+
.TH "JOME\-CTL" "1" "8 April 2025" "JOME" "JOME"
11+
.ie \n(.g .ds Aq \(aq
12+
.el .ds Aq '
13+
.ss \n[.ss] 0
14+
.nh
15+
.ad l
16+
.de URL
17+
\fI\\$2\fP <\\$1>\\$3
18+
..
19+
.als MTO URL
20+
.if \n[.g] \{\
21+
. mso www.tmac
22+
. am URL
23+
. ad l
24+
. .
25+
. am MTO
26+
. ad l
27+
. .
28+
. LINKSTYLE bold
29+
.\}
30+
.SH "NAME"
31+
jome-ctl \- control a jome server
32+
.SH "SYNOPSIS"
33+
.sp
34+
.nf
35+
\fBjome\-ctl\fP \fISERVER\-NAME\fP [\fBpick\fP | \fBquit\fP]
36+
.fi
37+
.br
38+
.SH "DESCRIPTION"
39+
.sp
40+
\fBjome\-ctl\fP controls the \fBjome\fP(1) server named \fISERVER\-NAME\fP.
41+
.sp
42+
See the \(lqServer mode\(rq section and \fB\-s\fP\~option of
43+
\fBjome\fP(1) to learn more.
44+
.sp
45+
On Unix, \fBjome\-ctl\fP reads from and writes to the socket file
46+
\fB/tmp/\fP\fISERVER\-NAME\fP.
47+
.sp
48+
The two available commands are:
49+
.sp
50+
\fBpick\fP (default)
51+
.RS 4
52+
Show the window of the jome server \fISERVER\-NAME\fP to pick an emoji.
53+
.sp
54+
If you accept an emoji, then jome closes its window and sends what
55+
it prints to the standard output to \fBjome\-ctl\fP which prints it as is
56+
and exits with status\~0.
57+
.sp
58+
If you cancel (press \fBEscape\fP or \fBCtrl\fP+\fBC\fP, or close the
59+
window), then \fBjome\-ctl\fP doesn\(cqt print anything and exits with
60+
status\~1.
61+
.RE
62+
.sp
63+
\fBquit\fP
64+
.RS 4
65+
Terminate the jome server \fISERVER\-NAME\fP, also removing the
66+
associated socket file.
67+
.RE
68+
.SH "EXIT STATUS"
69+
.sp
70+
\fB0\fP when the jome server accepts an emoji or \fB1\fP otherwise.
71+
.SH "ABOUT"
72+
.sp
73+
\fBjome\fP was originally written by and is maintained by, as of jome
74+
1.2.0, Philippe Proulx (\fBeepp\fP).
75+
.sp
76+
GitHub project: ⟨https://github.com/eepp/jome⟩.
77+
.SH "SEE ALSO"
78+
.sp
79+
\fBjome\fP(1)

man/jome-ctl.1.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
= vlttng(1)
2+
:revdate: 8 April 2025
3+
:docdate: {revdate}
4+
:doctype: manpage
5+
:manmanual: JOME
6+
:mansource: JOME
7+
:man-linkstyle: bold
8+
9+
== Name
10+
11+
jome-ctl - control a jome server
12+
13+
== Synopsis
14+
15+
[verse]
16+
**jome-ctl** __SERVER-NAME__ [**pick** | **quit**]
17+
18+
== Description
19+
20+
**jome-ctl** controls the **jome**(1) server named __SERVER-NAME__.
21+
22+
See the "`Server mode`" section and **-s**{nbsp}option of
23+
**jome**(1) to learn more.
24+
25+
On Unix, **jome-ctl** reads from and writes to the socket file
26+
**/tmp/**__SERVER-NAME__.
27+
28+
The two available commands are:
29+
30+
**pick** (default)::
31+
Show the window of the jome server __SERVER-NAME__ to pick an emoji.
32+
+
33+
If you accept an emoji, then jome closes its window and sends what
34+
it prints to the standard output to **jome-ctl** which prints it as is
35+
and exits with status{nbsp}0.
36+
+
37+
If you cancel (press **Escape** or **Ctrl**+**C**, or close the
38+
window), then **jome-ctl** doesn't print anything and exits with
39+
status{nbsp}1.
40+
41+
**quit**::
42+
Terminate the jome server __SERVER-NAME__, also removing the
43+
associated socket file.
44+
45+
== Exit status
46+
47+
**0** when the jome server accepts an emoji or **1** otherwise.
48+
49+
include::about.adoc[]
50+
51+
== See also
52+
53+
**jome**(1)

0 commit comments

Comments
 (0)