Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #51 from paravoid/misc-manpage-fixes
  • Loading branch information
Fabian Mauchle committed Sep 30, 2019
2 parents 0666c76 + 4add5ea commit 83a28c7
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 18 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Expand Up @@ -22,6 +22,8 @@ TAGS
radsecproxy
radsecproxy-conf
radsecproxy-hash
radsecproxy.8
radsecproxy.conf.5
build-aux/*
tests/t_fticks
tests/t_rewrite
Expand Down
4 changes: 2 additions & 2 deletions Makefile.am
Expand Up @@ -46,7 +46,7 @@ radsecproxy_LDADD = librsp.a @SSL_LIBS@
radsecproxy_conf_LDFLAGS = @TARGET_LDFLAGS@
radsecproxy_hash_LDADD = fticks_hashmac.o hash.o list.o

dist_man_MANS = radsecproxy.1 radsecproxy-hash.1 radsecproxy.conf.5
dist_man_MANS = radsecproxy.8 radsecproxy-hash.8 radsecproxy.conf.5

EXTRA_DIST = \
LICENSE THANKS \
Expand All @@ -59,7 +59,7 @@ EXTRA_DIST = \

html: radsecproxy.html radsecproxy-hash.html radsecproxy.conf.html

%.html: %.1
%.html: %.8
groff -mandoc -Thtml $< >$@
%.html: %.5
groff -mandoc -Thtml $< >$@
8 changes: 4 additions & 4 deletions README
Expand Up @@ -13,11 +13,11 @@ support. Without any special options to configure, all transports
supported by the system will be enabled. See the output from
"./configure --help" for how to change this.

To use radsecproxy you need to create a config file which is normally
found in /usr/local/etc/radsecproxy.conf. You can also specify the
location with the "-c" command line option (see below). For further
To use radsecproxy you need to create a config file which is normally found in
/etc/radsecproxy.conf or /usr/local/etc/radsecproxy.conf. You can also specify
the location with the "-c" command line option (see below). For further
instructions, please see the enclosed example file and the manpages
radsecproxy(1) and radsecproxy.conf(5)
radsecproxy(8) and radsecproxy.conf(5).

Note for Cygwin users:
Due to a bug in openssl the tls option CACertificatePath is currently unusable.
Expand Down
10 changes: 10 additions & 0 deletions configure.ac
Expand Up @@ -92,6 +92,16 @@ if test "x$dtls" = "xyes" ; then
TARGET_CFLAGS="$TARGET_CFLAGS -DRADPROT_DTLS"
fi

dnl Substitute variables such as sysconfdir
AC_CONFIG_FILES([radsecproxy.8 radsecproxy.conf.5])

dnl Expand sysconfdir early to avoid two layers of substitution
test "x$prefix" = xNONE && prefix=$ac_default_prefix
test "x$exec_prefix" = xNONE && exec_prefix='${prefix}'
SYSCONFDIR=`eval echo $sysconfdir`
SYSCONFDIR=`eval echo $SYSCONFDIR`
AC_SUBST(SYSCONFDIR)

AC_SUBST(TARGET_CFLAGS)
AC_SUBST(TARGET_LDFLAGS)
AX_CHECK_SSL
Expand Down
2 changes: 1 addition & 1 deletion radsecproxy-hash.1 → radsecproxy-hash.8
@@ -1,4 +1,4 @@
.TH radsecproxy-hash 1 "5 May 2018"
.TH radsecproxy-hash 8 "5 May 2018"

.SH "NAME"
radsecproxy-hash - print digests of Ethernet MAC addresses
Expand Down
6 changes: 3 additions & 3 deletions radsecproxy.1 → radsecproxy.8.in
@@ -1,4 +1,4 @@
.TH radsecproxy 1 "5 July 2018"
.TH radsecproxy 8 "5 July 2018"

.SH "NAME"
radsecproxy - a generic RADIUS proxy that provides both RADIUS UDP and TCP/TLS (RadSec) transport.
Expand Down Expand Up @@ -84,9 +84,9 @@ This signal is ignored.

.SH "FILES"
.TP
.B /usr/local/etc/radsecproxy.conf
.B @SYSCONFDIR@/radsecproxy.conf
.sp
The default configuration file.

.SH "SEE ALSO"
radsecproxy.conf(5), radsecproxy-hash(1)
radsecproxy.conf(5), radsecproxy-hash(8)
3 changes: 1 addition & 2 deletions radsecproxy.conf-example
@@ -1,5 +1,4 @@
# Master config file, must be in /usr/local/etc/radsecproxy or specified with -c option
# All possible config options are listed below
# Master config file, all possible config options are listed below

# First you may define any global options, these are:
#
Expand Down
11 changes: 5 additions & 6 deletions radsecproxy.conf.5 → radsecproxy.conf.5.in
Expand Up @@ -6,9 +6,9 @@ radsecproxy.conf \- Radsec proxy configuration file
.SH DESCRIPTION
When the proxy server starts, it will first check the command line arguments,
and then read the configuration file. Normally radsecproxy will read the
configuration file \fI/usr/local/etc/radsecproxy.conf\fR. The command line
configuration file \fI@SYSCONFDIR@/radsecproxy.conf\fR. The command line
\fB\-c\fR option can be used to instead read an alternate file (see
\fBradsecproxy\fR(1) for details).
\fBradsecproxy\fR(8) for details).

If the configuration file can not be found, the proxy will exit with an error
message. Note that there is also an include facility so that any configuration
Expand Down Expand Up @@ -79,7 +79,7 @@ be included. The value can be a single file, or it can use normal shell globbing
to specify multiple files, e.g.:

.RS
include /usr/local/etc/radsecproxy.conf.d/*.conf
include @SYSCONFDIR@/radsecproxy.conf.d/*.conf
.RE

The files are sorted alphabetically. Included files are read in the order they
Expand Down Expand Up @@ -222,7 +222,7 @@ not supported.
The FTicksPrefix option is used to set the \fIprefix\fR printed in F-Ticks
messages. This allows for use of F-Ticks messages in non-eduroam environments.
If no FTicksPrefix option is given, it defaults to the prefix used for eduroam
(\*(T<F\-TICKS/eduroam/1.0\*(T>)
(\fIF\-TICKS/eduroam/1.0\fR).

.RE

Expand Down Expand Up @@ -915,5 +915,4 @@ subattributes are removed.
.RE

.SH "SEE ALSO"
\fBradsecproxy\fR(1),
.URL https://tools.ietf.org/html/rfc6614 " Transport Layer Security (TLS) Encryption for RADIUS "
\fBradsecproxy\fR(8)

0 comments on commit 83a28c7

Please sign in to comment.