Commit 3386849f authored by Jaakko Hannikainen's avatar Jaakko Hannikainen Committed by Slava Monich

doc: Move man pages under automake

This change prettifies man pages with <SYSCONFDIR> and /var/lib so
that it will show the actual value connman was compiled with, rather
than just hinting at some magical compile time variable.

Add only the man page autoconf .in files to the dist tar ball so
that running ./configure with a different prefix generates the man
pages using the given prefix. As the autoconf .in is not created by
standard rules, ensure also that the target directory is created.

Conflicts:
	connman/Makefile.am
parent 063f1930
......@@ -73,8 +73,12 @@ unit/*.gcov
doc/*.bak
doc/*.stamp
doc/connman.*
!doc/connman.8
!doc/connman.conf.5
doc/*.1
doc/*.5
doc/*.8
!doc/*.1.in
!doc/*.5.in
!doc/*.8.in
doc/connman-*.txt
vpn/builtin.h
......
......@@ -245,8 +245,6 @@ include Makefile.plugins
if CLIENT
bin_PROGRAMS += client/connmanctl
MANUAL_PAGES += doc/connmanctl.1
client_connmanctl_SOURCES = client/dbus_helpers.h client/dbus_helpers.c \
client/services.h client/services.c \
client/commands.h client/commands.c \
......@@ -394,14 +392,22 @@ EXTRA_DIST += doc/overview-api.txt doc/behavior-api.txt \
doc/vpn-config-format.txt \
doc/vpn-connection-api.txt \
doc/vpn-manager-api.txt doc/vpn-overview.txt \
doc/session-policy-format.txt
doc/session-policy-format.txt \
doc/connmanctl.1.in doc/connman.conf.5.in \
doc/connman-service.config.5.in \
doc/connman-vpn.conf.5.in \
doc/connman-vpn-provider.config.5.in \
doc/connman.8.in doc/connman-vpn.8.in
EXTRA_DIST += src/main.conf \
src/eduroam.config
MANUAL_PAGES += doc/connman.8 doc/connman.conf.5
MANUAL_PAGES += doc/connmanctl.1 doc/connman.conf.5 \
doc/connman-service.config.5 doc/connman-vpn.conf.5 \
doc/connman-vpn-provider.config.5 \
doc/connman.8 doc/connman-vpn.8
dist_man_MANS = $(MANUAL_PAGES)
nodist_man_MANS = $(MANUAL_PAGES)
pkgconfigdir = $(libdir)/pkgconfig
......@@ -467,6 +473,18 @@ do_subst = $(AM_V_GEN)$(SED) \
-e 's,[@]CONNMAN_SERVICE_REQUIRES[@],$(CONNMAN_SERVICE_REQUIRES),g' \
-e 's,[@]CONNMAN_SERVICE_AFTER[@],$(CONNMAN_SERVICE_AFTER),g'
%.1 : %.1.in
$(AM_V_at)$(MKDIR_P) $(dir $@)
$(do_subst) < $< > $@
%.5 : %.5.in
$(AM_V_at)$(MKDIR_P) $(dir $@)
$(do_subst) < $< > $@
%.8 : %.8.in
$(AM_V_at)$(MKDIR_P) $(dir $@)
$(do_subst) < $< > $@
%.service: %.service.in Makefile
$(AM_V_at)$(MKDIR_P) $(dir $@)
$(do_subst) < $< > $@
......@@ -484,4 +502,4 @@ include/connman/%.h: $(abs_top_srcdir)/include/%.h
$(AM_V_GEN)$(LN_S) $< $@
clean-local:
@$(RM) -rf include/connman
@$(RM) -rf include/connman $(MANUAL_PAGES)
......@@ -6,11 +6,11 @@
.SH NAME
service-name.config \- ConnMan service provisioning file
.SH SYNOPSIS
.B /var/lib/connman/\fIservice-name\fB.config
.B @storagedir@/\fIservice-name\fB.config
.SH DESCRIPTION
.P
\fIConnMan\fP's services are configured with so called
"\fBprovisioning files\fP" which reside under \fI/var/lib/connman/\fP.
"\fBprovisioning files\fP" which reside under \fI@storagedir@/\fP.
The files can be named anything, as long as they end in \fB.config\fP.
The provisioning files can be used to configure for example secured
wireless access points which need complex authentication, for example
......@@ -125,7 +125,7 @@ method (should only be used with \fBEAP=ttls\fP).
.SH "EXAMPLE"
.SS Eduroam
This is a configuration file for eduroam networks. This file could for
example be /var/lib/connman/eduroam.config. Your university's exact
example be @storagedir@/eduroam.config. Your university's exact
settings might be different.
.PP
.nf
......@@ -139,7 +139,7 @@ CACertFile = /etc/ssl/certs/UNIV_CA.crt
.SS Complex networking
This is a configuration file for a network providing EAP-TLS, EAP-TTLS and
EAP-PEAP services. The respective SSIDs are tls_ssid, ttls_ssid and peap_ssid
and the file name could be /var/lib/connman/complex.config.
and the file name could be @storagedir@/complex.config.
.PP
Please note that the SSID entry is for hexadecimal encoded SSID (e.g. "SSID =
746c735f73736964"). If your SSID does not contain any exotic character then
......
......@@ -6,11 +6,11 @@
.SH NAME
connection_name.config \- ConnMan vpn connection provisioning file
.SH SYNOPSIS
.B /var/lib/connman-vpn/\fIconnection-name\fB.config
.B @vpn_storagedir@/\fIconnection-name\fB.config
.SH DESCRIPTION
.P
\fIConnMan\fP's vpn connections are configured with so called
"\fBprovisioning files\fP" which reside under \fI/var/lib/connman-vpn/\fP.
"\fBprovisioning files\fP" which reside under \fI@vpn_storagedir@/\fP.
The files can be named anything, as long as they contain only printable
ascii characers, for example letters, numbers and underscores. The file
must end with \fB.config\fP. Each VPN connection requires a provisioning
......@@ -387,7 +387,7 @@ No Van Jacobson compression.
.SH "EXAMPLE"
This is a configuration file for a VPN providing L2TP, OpenVPN and
OpenConnect services. It could, for example, be in the file
.B /var/lib/connman-vpn/example.config\fR.
.B @vpn_storagedir@/example.config\fR.
.PP
.nf
[global]
......
......@@ -38,9 +38,8 @@ Print ConnMan-VPN's available options and exit.
.TP
.BI \-c\ file\fR,\ \fB\-\-config= \fIfile
Specify configuration file to set up various settings for ConnMan. If not
specified, the default value of \fI<SYSCONFDIR>/connman/connman-vpn.conf\fP
is used; where \fI<SYSCONFDIR>\fP is dependent on your distribution (usually
it's \fI/etc\fP). See \fBconnman-vpn.conf\fP(5) for more information on
specified, the default value of \fI@sysconfdir@/connman/connman-vpn.conf\fP
is used. See \fBconnman-vpn.conf\fP(5) for more information on
configuration file. The use of config file is optional and sane default values
are used if config file is missing.
.TP
......
......@@ -6,13 +6,7 @@
.SH NAME
connman-vpn.conf \- ConnMan-VPN configuration file
.SH SYNOPSIS
.B /etc/connman/connman-vpn.conf
.br
or
.br
\fI<SYSCONFDIR>\fB/connman/connman-vpn.conf
.br
.RI where\ <SYSCONFDIR> " depends on your distribution or build."
.B @sysconfdir@/connman/connman-vpn.conf
.SH DESCRIPTION
.P
.B connman-vpn.conf
......
......@@ -48,9 +48,8 @@ Print ConnMan's available options and exit.
.TP
.BI \-c\ file\fR,\ \fB\-\-config= \fIfile
Specify configuration file to set up various settings for ConnMan. If not
specified, the default value of \fI<SYSCONFDIR>/connman/main.conf\fP
is used; where \fI<SYSCONFDIR>\fP is dependent on your distribution (usually
it's \fI/etc\fP). See \fBconnman.conf\fP(5) for more information on
specified, the default value of \fI@sysconfdir@/connman/main.conf\fP
is used. See \fBconnman.conf\fP(5) for more information on
configuration file. The use of config file is optional and sane default values
are used if config file is missing.
.TP
......
......@@ -6,13 +6,7 @@
.SH NAME
main.conf \- ConnMan configuration file
.SH SYNOPSIS
.B /etc/connman/main.conf
.br
or
.br
\fI<SYSCONFDIR>\fB/connman/main.conf
.br
.RI where\ <SYSCONFDIR> " depends on your distribution or build."
.B @sysconfdir@/connman/main.conf
.SH DESCRIPTION
.P
.B main.conf
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment