[cpp-log4shib] 23/26: Add man page for log4shib-config

Tue Oct 19 16:13:29 UTC 2021

This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to annotated tag debian/1.0.4-1
in repository cpp-log4shib.

View the commit online:
http://git.shibboleth.net/view/?p=cpp-log4shib.git;a=commit;h=0e203c6524a7f8e43b69e4c266d0fcc48b7e85e6

commit 0e203c6524a7f8e43b69e4c266d0fcc48b7e85e6
Author: Russ Allbery <rra at stanford.edu>
AuthorDate: Tue Jun 5 20:53:06 2012 -0700

    Add man page for log4shib-config
---
 debian/changelog               |  2 ++
 debian/clean                   |  1 +
 debian/control                 |  2 +-
 debian/liblog4shib-dev.install |  1 +
 debian/log4shib-config.pod     | 70 ++++++++++++++++++++++++++++++++++++++++++
 debian/rules                   |  5 +++
 6 files changed, 80 insertions(+), 1 deletion(-)

diff --git a/debian/changelog b/debian/changelog
index 4324259..4c73c14 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -8,6 +8,8 @@ log4shib (1.0.4-1) UNRELEASED; urgency=low
     - Fix varargs issue on x86_64.
   * Patch upstream configure.in to declare m4 as the macro directory so
     that autoreconf works properly.
+  * Write a manual page for log4shib-config in POD and generate it and
+    install it as part of the package build.
   * Add Maintainer, Uploaders, and Vcs-* headers for the pkg-shibboleth
     packaging team.
   * Work around issues with -lpthread and libtool and with picking up
diff --git a/debian/clean b/debian/clean
new file mode 100644
index 0000000..b4c98f6
--- /dev/null
+++ b/debian/clean
@@ -0,0 +1 @@
+debian/log4shib-config.1
diff --git a/debian/control b/debian/control
index 14c7ab5..f7ff2e2 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,7 @@ Section: libs
 Priority: extra
 Maintainer: Debian Shib Team <pkg-shibboleth-devel at lists.alioth.debian.org>
 Uploaders: Russ Allbery <rra at debian.org>
-Build-Depends: debhelper (>= 9), dh-autoreconf, doxygen, graphviz
+Build-Depends: debhelper (>= 9), dh-autoreconf, doxygen, graphviz, perl
 Standards-Version: 3.9.3
 Homepage: https://wiki.shibboleth.net/confluence/display/OpenSAML/log4shib
 Vcs-Git: git://git.debian.org/git/pkg-shibboleth/log4shib.git
diff --git a/debian/liblog4shib-dev.install b/debian/liblog4shib-dev.install
index e8c1e16..1cd634e 100644
--- a/debian/liblog4shib-dev.install
+++ b/debian/liblog4shib-dev.install
@@ -4,3 +4,4 @@ usr/lib/*/lib*.a
 usr/lib/*/lib*.so
 usr/lib/*/pkgconfig/log4shib.pc
 usr/share/aclocal/log4shib.m4
+debian/log4shib-config.1 usr/share/man/man1
diff --git a/debian/log4shib-config.pod b/debian/log4shib-config.pod
new file mode 100644
index 0000000..531eda7
--- /dev/null
+++ b/debian/log4shib-config.pod
@@ -0,0 +1,70 @@
+=head1 NAME
+
+log4shib-config - Flags for linking with the log4shib library
+
+=head1 SYNOPSIS
+
+B<log4shib-config> [B<--prefix>[=I<dir>]] [B<--exec-prefix>[=I<dir>]]
+    [B<--package>] [B<--version>] [B<--cflags>] [B<--libs>] [B<--help>]
+
+=head1 DESCRIPTION
+
+B<log4shib-config> prints out various configuration information for the
+log4shib library, such as the compiler and linker flags required to build
+and link programs against the library.
+
+log4shib provides a library of C++ classes for flexible logging to files,
+syslog, and other destinations.  It is modeled after the log4j Java
+library, staying as close to that API as is reasonable.
+
+log4shib is a fork of the log4cpp library with additional fixes and
+modifications to improve its thread safety and robustness.  It is
+primarily intended for use by the Shibboleth web authentication system.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--help>
+
+Prints a usage message.  This is the default action.
+
+=item B<--cflags>
+
+Prints the compiler flags required to build software using log4shib.
+
+=item B<--libs>
+
+Prints the linker flags required to link software with log4shib.
+
+=item B<--package>
+
+Prints the name of the log4shib package.
+
+=item B<--version>
+
+Prints the version of log4shib from which this script came.
+
+=item B<--prefix>[=I<dir>]
+
+Prints the prefix with which log4shib was compiled.  If the optional
+argument is supplied, also sets the prefix to I<dir> for any subsequent
+flags.  (This is rarely useful.)
+
+=item B<--exec-prefix>[=I<dir>]
+
+Prints the prefix for compiled files with which log4shib was compiled.  If
+the optional argument is supplied, also sets the exec prefix to I<dir> for
+any subsequent flags.  (This is rarely useful.)
+
+=back
+
+Other, lesser-used options are also available to print out additional
+configure-time information.  Run with B<--help> for a full list of
+available options.
+
+=head1 AUTHOR
+
+Written by Russ Allbery <rra at debian.org> for the Debian distribution.
+
+=cut
diff --git a/debian/rules b/debian/rules
index 5539a75..ebe88f3 100755
--- a/debian/rules
+++ b/debian/rules
@@ -1,5 +1,8 @@
 #!/usr/bin/make -f
 
+VERSION := $(shell dpkg-parsechangelog | grep ^Version: | cut -d' ' -f2 \
+		| cut -d- -f1)
+
 # Enable compiler hardening flags.
 export DEB_BUILD_MAINT_OPTIONS = hardening=+bindnow,+pie
 
@@ -29,6 +32,8 @@ override_dh_auto_configure:
 # of the Cflags and Libs pkgconfig configuration.  LDFLAGS and CPPFLAGS are
 # set by /usr/share/dpkg/buildflags.mk above.
 override_dh_install:
+	pod2man --release=$(VERSION) --section=1 --center=log4shib \
+	    debian/log4shib-config.pod debian/log4shib-config.1
 	dh_install -a -i -Xlog4shib.la --fail-missing
 	perl -i -pe 's/^(Libs: .*)\Q$(LDFLAGS)\E/$$1/' \
 	    debian/*/usr/lib/*/pkgconfig/log4shib.pc

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.
