Skip to content

Commit 14a9a99

Browse files
committed
Relocate man pages
Initially I copied the nfs-utils style of situating man pages in the src/ tree along side the tools they document. However, build systems, package integrators, and development tools appear to expect man pages to reside under: ${topdir}/man/man? And I'm beginning to encounter some naming conflicts under src/tlshd/. Relocate the man pages from src/ and construct a proper section- based man folder hierarchy. Signed-off-by: Chuck Lever <[email protected]>
1 parent 5059498 commit 14a9a99

File tree

8 files changed

+78
-12
lines changed

8 files changed

+78
-12
lines changed

Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ AUTOMAKE_OPTIONS = foreign
2020

2121
EXTRA_DIST = autogen.sh CONTRIBUTING.md LICENSE.txt \
2222
README.md SECURITY.md
23-
SUBDIRS = src systemd
23+
SUBDIRS = man src systemd
2424
MAINTAINERCLEANFILES = Makefile.in cscope.* ktls-utils*.tar.gz

configure.ac

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ AC_USE_SYSTEM_EXTENSIONS
2929
AC_LANG(C)
3030
AC_PROG_CC
3131
AC_PROG_INSTALL
32+
AC_PROG_MKDIR_P
3233

3334
unitdir=/usr/lib/systemd/system
3435
AC_ARG_WITH(systemd,
@@ -93,5 +94,12 @@ fi
9394

9495
AC_SUBST([AM_CPPFLAGS])
9596

96-
AC_CONFIG_FILES([Makefile src/Makefile src/tlshd/Makefile systemd/Makefile])
97+
AC_CONFIG_FILES([Makefile \
98+
man/Makefile \
99+
man/man5/Makefile \
100+
man/man8/Makefile \
101+
src/Makefile \
102+
src/tlshd/Makefile \
103+
systemd/Makefile])
104+
97105
AC_OUTPUT

man/Makefile.am

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#
2+
# Copyright (c) 2025 Oracle and/or its affiliates.
3+
#
4+
# ktls-utils is free software; you can redistribute it and/or
5+
# modify it under the terms of the GNU General Public License as
6+
# published by the Free Software Foundation; version 2.
7+
#
8+
# This program is distributed in the hope that it will be useful,
9+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11+
# General Public License for more details.
12+
#
13+
# You should have received a copy of the GNU General Public License
14+
# along with this program; if not, write to the Free Software
15+
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16+
# 02110-1301, USA.
17+
#
18+
19+
SUBDIRS = man5 man8
20+
21+
MAINTAINERCLEANFILES = Makefile.in

man/man5/Makefile.am

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#
2+
# Copyright (c) 2025 Oracle and/or its affiliates.
3+
#
4+
# ktls-utils is free software; you can redistribute it and/or
5+
# modify it under the terms of the GNU General Public License as
6+
# published by the Free Software Foundation; version 2.
7+
#
8+
# This program is distributed in the hope that it will be useful,
9+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11+
# General Public License for more details.
12+
#
13+
# You should have received a copy of the GNU General Public License
14+
# along with this program; if not, write to the Free Software
15+
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16+
# 02110-1301, USA.
17+
#
18+
19+
dist_man5_MANS = tlshd.conf.5
20+
21+
MAINTAINERCLEANFILES = Makefile.in

src/tlshd/tlshd.conf.man renamed to man/man5/tlshd.conf.5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
.SH NAME
2323
tlshd.conf \- tlshd configuration file
2424
.SH SYNOPSIS
25-
.B /etc/tlshd.conf
25+
.I /etc/tlshd.conf
2626
.SH DESCRIPTION
2727
The
2828
.B tlshd

man/man8/Makefile.am

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#
2+
# Copyright (c) 2025 Oracle and/or its affiliates.
3+
#
4+
# ktls-utils is free software; you can redistribute it and/or
5+
# modify it under the terms of the GNU General Public License as
6+
# published by the Free Software Foundation; version 2.
7+
#
8+
# This program is distributed in the hope that it will be useful,
9+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11+
# General Public License for more details.
12+
#
13+
# You should have received a copy of the GNU General Public License
14+
# along with this program; if not, write to the Free Software
15+
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16+
# 02110-1301, USA.
17+
#
18+
19+
dist_man8_MANS = tlshd.8
20+
21+
MAINTAINERCLEANFILES = Makefile.in

src/tlshd/tlshd.man renamed to man/man8/tlshd.8

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,13 @@ The
2828
.B tlshd
2929
program implements a user agent that services TLS handshake requests
3030
on behalf of kernel TLS consumers.
31-
Using the
32-
.BR accept (2)
33-
system call, it materializes kernel socket endpoints in user space
34-
in order to perform TLS handshakes using a TLS library.
31+
It materializes kernel socket endpoints in user space
32+
in order to perform TLS handshakes using a standard TLS library.
3533
After each handshake completes,
3634
.B tlshd
3735
plants TLS session metadata into the kernel socket to enable
38-
the use of kTLS to secure subsequent communication on that socket.
36+
the use of kTLS to secure subsequent communication on that socket,
37+
and passes the socket back to the kernel.
3938
.SH OPTIONS
4039
.TP
4140
.B \-c " or " \-\-config

src/tlshd/Makefile.am

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@
1818

1919
dist_sysconf_DATA = tlshd.conf
2020

21-
man5_MANS = tlshd.conf.man
22-
man8_MANS = tlshd.man
23-
EXTRA_DIST = $(man5_MANS) $(man8_MANS)
24-
2521
sbin_PROGRAMS = tlshd
2622
tlshd_CFLAGS = -Werror -Wall -Wextra $(LIBGNUTLS_CFLAGS) \
2723
$(LIBKEYUTILS_CFLAGS) $(GLIB_CFLAGS) $(LIBNL3_CFLAGS) \

0 commit comments

Comments
 (0)