From bc48534814cce147fabd06af8309daff4101b820 Mon Sep 17 00:00:00 2001 From: Ariadne Conill Date: Fri, 24 Jul 2020 07:48:14 -0600 Subject: [PATCH] add ifquery manpage --- Makefile | 13 ++++++++++ doc/ifquery.scd | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) create mode 100644 doc/ifquery.scd diff --git a/Makefile b/Makefile index 36cd719..4c21443 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,5 @@ +SCDOC := scdoc + PACKAGE_NAME := ifupdown-ng PACKAGE_VERSION := 0.2 PACKAGE_BUGREPORT := https://github.com/kaniini/ifupdown-ng/issues/new @@ -54,6 +56,7 @@ libifupdown.a: ${LIBIFUPDOWN_OBJ} clean: rm -f ${LIBIFUPDOWN_OBJ} ${CMD_OBJ} rm -f ${CMDS} ${MULTICALL} + rm -f ${MANPAGES} check: libifupdown.a ${CMDS} kyua test @@ -63,3 +66,13 @@ install: all for i in ${CMDS}; do \ ln -s /sbin/${MULTICALL} ${DESTDIR}/sbin/$$i; \ done + +.scd.1 .scd.2 .scd.3 .scd.4 .scd.5 .scd.6 .scd.7 .scd.8: + ${SCDOC} < $< > $@ + +MANPAGES = \ + doc/ifquery.8 + +docs: ${MANPAGES} + +.SUFFIXES: .scd .1 .2 .3 .4 .5 .6 .7 .8 diff --git a/doc/ifquery.scd b/doc/ifquery.scd new file mode 100644 index 0000000..12d47a5 --- /dev/null +++ b/doc/ifquery.scd @@ -0,0 +1,66 @@ +ifquery(8) + +# NAME + +ifquery - query interface configuration and state + +# SYNOPSIS + +*ifquery* [<_options_>...] <_interfaces_...> + +*ifquery* -L|--list + +*ifquery* -s|--state + +# DESCRIPTION + +*ifquery* is used to extract information from the interface configuration +file. It can also be used to convert from old versions of the interface +configuration file to the current format. + +# OPTIONS + +*-a, --auto* + Only match interfaces that are marked as _auto_. + +*-h, --help* + Display supported options to ifquery. + +*-i, --interfaces* _FILE_ + Use _FILE_ as the config database. + +*-s, --state* + Query the state database instead of the config database. + +*-D, --dot* + Generate a dependency graph that can be used with GraphViz + *dot*(1). Used with *--list*. + +*-I, --include* _PATTERN_ + Include _PATTERN_ when matching against the config or state + database. + +*-L, --list* + List interfaces which exist in the configuration database. + +*-P, --pretty-print* + When listing interfaces, print their configuration in a format + that is compatible with *interfaces*(5) files. + +*-S, --state-file* _FILE_ + Use _FILE_ as the state database. + +*-V, --version* + Print the ifupdown-ng version and exit. + +*-X, --exclude* _PATTERN_ + Exclude _PATTERN_ when matching against the config or state + database. + +# SEE ALSO + +*ifup*(8), *ifdown*(8), *interfaces*(5) + +# AUTHORS + +Ariadne Conill