Reworked how man pages are generated. Now, man pages in the client and server directory are "fwknop(d).8.in" and a target was added to Makefile.am to create the man pages while doing variable substitutions based on directives specified via the configure script. Minor tweak to fwknop.spec file.
git-svn-id: file:///home/mbr/svn/fwknop/trunk@251 510a4753-2344-4c79-9c09-4d669213fbeb
This commit is contained in:
@@ -40,3 +40,12 @@ EXTRA_DIST = \
|
||||
win32/libfko.sln \
|
||||
win32/libfko.vcproj
|
||||
|
||||
# Make dist makes the man pages to put them in the distribution. We
|
||||
# do not want that. They will be remade after configure and make is
|
||||
# later. This is bit of a kludge, but seems to work (until I find a
|
||||
# better way). --DSS
|
||||
#
|
||||
dist-hook:
|
||||
rm -f $(distdir)/client/fwknop.8
|
||||
rm -f $(distdir)/server/fwknopd.8
|
||||
|
||||
|
||||
@@ -9,3 +9,19 @@ fwknop_CPPFLAGS = -I $(top_srcdir)/lib -I $(top_srcdir)/common
|
||||
fwknop_LDADD = $(top_builddir)/lib/libfko.la
|
||||
|
||||
dist_man_MANS = fwknop.8
|
||||
|
||||
EXTRA_DIST = fwknop.8.in
|
||||
|
||||
fwknop.8: fwknop.8.in
|
||||
$(SED) \
|
||||
-e 's|[@]prefix@|$(prefix)|g' \
|
||||
-e 's|[@]sysconfdir@|$(sysconfdir)|g' \
|
||||
-e 's|[@]datarootdir@|$(datarootdir)|g' \
|
||||
-e 's|[@]bindir@|$(bindir)|g' \
|
||||
-e 's|[@]sbindir@|$(sbindir)|g' \
|
||||
-e 's|[@]localstatedir@|$(localstatedir)|g' \
|
||||
< "$<" > "$@"
|
||||
|
||||
clean-local:
|
||||
rm -f fwknop.8
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ vulnerabilities (both 0-day and unpatched code) much more difficult.
|
||||
|
||||
The main configuration for *fwknopd* is maintained within two files:
|
||||
'fwknopd.conf' and 'access.conf'. The default location for these files
|
||||
is determined at package configuration (typically '<prefix>/etc/fwknop')The
|
||||
is determined at package configuration (typically '@sysconfdir@/fwknop')The
|
||||
configuration variables within these files are desribed below.
|
||||
|
||||
|
||||
@@ -37,12 +37,12 @@ COMMAND-LINE OPTIONS
|
||||
*-a, --access-file*='<access-file>'::
|
||||
Specify the location of the 'access.conf' file. If this option is
|
||||
not given, 'fwkopd' will use the compile-time default location (typically
|
||||
'<prefix>/etc/fwknop/access.conf'.
|
||||
'@sysconfdir@/fwknop/access.conf'.
|
||||
|
||||
*-c, --config*='<config-file>'::
|
||||
Specify the location of the 'fwknopd.conf' file. If this option is
|
||||
not given, 'fwkopd' will use the default location (typically
|
||||
'<prefix>/etc/fwknop/fwknopd.conf'.
|
||||
'@sysconfdir@/fwknop/fwknopd.conf'.
|
||||
|
||||
*-C, --packet-limit*='<n>'::
|
||||
Specify the number of candidate SPA packets to process and exit when
|
||||
@@ -84,14 +84,14 @@ COMMAND-LINE OPTIONS
|
||||
*--rotate-digest-cache*::
|
||||
Rotate the digest cache file by renaming it to ``<name>-old'', and
|
||||
starting a new one. The digest cache file is typically found in
|
||||
'<prefix>/var/run/fwknop/digest.cache'.
|
||||
'@localstatedir@/run/fwknop/digest.cache'.
|
||||
|
||||
*-S, --Status*::
|
||||
Display the status of any *fwknopd* processes that may or not be
|
||||
running.
|
||||
|
||||
*-v, --verbose*::
|
||||
Run *fwknopd* in verbose mode. This can option acn be specified
|
||||
Run *fwknopd* in verbose mode. This can option can be specified
|
||||
multiple times to increase the verbosity of the output to the system
|
||||
log file (or to the screen if running in the foreground).
|
||||
|
||||
|
||||
@@ -1,8 +1,16 @@
|
||||
%define _prefix /usr
|
||||
%define _bindir /usr/bin
|
||||
%define _sbindir /usr/sbin
|
||||
%define _includedir /usr/include
|
||||
%ifarch x86_64
|
||||
%define _libdir /usr/lib64
|
||||
%else
|
||||
%define _libdir /usr/lib
|
||||
%endif
|
||||
%define _sysconfdir /etc
|
||||
%define _localstatedir /var
|
||||
%define _infodir /usr/share/info
|
||||
%define _mandir /usr/share/man
|
||||
|
||||
Name: fwknop
|
||||
Version: 2.0.0_beta_rc1
|
||||
|
||||
@@ -23,3 +23,18 @@ dist_man_MANS = fwknopd.8
|
||||
|
||||
dist_fwknopd_DATA = fwknopd.conf access.conf
|
||||
|
||||
EXTRA_DIST = fwknopd.8.in
|
||||
|
||||
fwknopd.8: fwknopd.8.in
|
||||
$(SED) \
|
||||
-e 's|[@]prefix@|$(prefix)|g' \
|
||||
-e 's|[@]sysconfdir@|$(sysconfdir)|g' \
|
||||
-e 's|[@]datarootdir@|$(datarootdir)|g' \
|
||||
-e 's|[@]bindir@|$(bindir)|g' \
|
||||
-e 's|[@]sbindir@|$(sbindir)|g' \
|
||||
-e 's|[@]localstatedir@|$(localstatedir)|g' \
|
||||
< "$<" > "$@"
|
||||
|
||||
clean-local:
|
||||
rm -f fwknopd.8
|
||||
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
.\" Title: fwknopd
|
||||
.\" Author: [see the "AUTHOR" section]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
||||
.\" Date: 07/09/2010
|
||||
.\" Date: 07/10/2010
|
||||
.\" Manual: Fwknop Server
|
||||
.\" Source: Fwknop Server
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "FWKNOPD" "8" "07/09/2010" "Fwknop Server" "Fwknop Server"
|
||||
.TH "FWKNOPD" "8" "07/10/2010" "Fwknop Server" "Fwknop Server"
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * set default formatting
|
||||
.\" -----------------------------------------------------------------
|
||||
@@ -29,7 +29,7 @@ fwknopd \- Firewall Knock Operator Daemon
|
||||
.sp
|
||||
The main application of this program is to protect services such as \fISSH\fR with an additional layer of security in order to make the exploitation of vulnerabilities (both 0\-day and unpatched code) much more difficult\&.
|
||||
.sp
|
||||
The main configuration for \fBfwknopd\fR is maintained within two files: \fIfwknopd\&.conf\fR and \fIaccess\&.conf\fR\&. The default location for these files is determined at package configuration (typically \fI<prefix>/etc/fwknop\fR)The configuration variables within these files are desribed below\&.
|
||||
The main configuration for \fBfwknopd\fR is maintained within two files: \fIfwknopd\&.conf\fR and \fIaccess\&.conf\fR\&. The default location for these files is determined at package configuration (typically \fI@sysconfdir@/fwknop\fR)The configuration variables within these files are desribed below\&.
|
||||
.SH "COMMAND-LINE OPTIONS"
|
||||
.PP
|
||||
\fB\-a, \-\-access\-file\fR=\fI<access\-file>\fR
|
||||
@@ -39,7 +39,7 @@ Specify the location of the
|
||||
file\&. If this option is not given,
|
||||
\fIfwkopd\fR
|
||||
will use the compile\-time default location (typically
|
||||
\fI<prefix>/etc/fwknop/access\&.conf\fR\&.
|
||||
\fI@sysconfdir@/fwknop/access\&.conf\fR\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-c, \-\-config\fR=\fI<config\-file>\fR
|
||||
@@ -49,7 +49,7 @@ Specify the location of the
|
||||
file\&. If this option is not given,
|
||||
\fIfwkopd\fR
|
||||
will use the default location (typically
|
||||
\fI<prefix>/etc/fwknop/fwknopd\&.conf\fR\&.
|
||||
\fI@sysconfdir@/fwknop/fwknopd\&.conf\fR\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-C, \-\-packet\-limit\fR=\fI<n>\fR
|
||||
@@ -121,7 +121,7 @@ files\&. This will also force a flush of the current \(lqFWKNOP\(rq Netfilter ch
|
||||
\fB\-\-rotate\-digest\-cache\fR
|
||||
.RS 4
|
||||
Rotate the digest cache file by renaming it to \(lq<name>\-old\(rq, and starting a new one\&. The digest cache file is typically found in
|
||||
\fI<prefix>/var/run/fwknop/digest\&.cache\fR\&.
|
||||
\fI@localstatedir@/run/fwknop/digest\&.cache\fR\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-S, \-\-Status\fR
|
||||
@@ -135,7 +135,7 @@ processes that may or not be running\&.
|
||||
.RS 4
|
||||
Run
|
||||
\fBfwknopd\fR
|
||||
in verbose mode\&. This can option acn be specified multiple times to increase the verbosity of the output to the system log file (or to the screen if running in the foreground)\&.
|
||||
in verbose mode\&. This can option can be specified multiple times to increase the verbosity of the output to the system log file (or to the screen if running in the foreground)\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-h, \-\-help\fR
|
||||
Reference in New Issue
Block a user