Change manpage from man(7) to mdoc(7)

pkgconf.1

@@ -7,108 +7,116 @@
 .\" This software is provided 'as is' and without any warranty, express or
 .\" implied.  In no event shall the authors be liable for any damages arising
 .\" from the use of this software.
-.TH pkgconf 1 "December 2013"
+.Dd February 2, 2015
-.SH NAME
+.Dt PKGCONF 1
-pkgconf \- a system for configuring build dependency information
+.Os
-.SH SYNOPSIS
+.Sh NAME
-.B pkgconf
+.Nm pkgconf
-[options] [list of modules]
+.Nd a system for configuring build dependency information
-.SH DESCRIPTION
+.Sh SYNOPSIS
-.P
+.Nm
-pkgconf is a program which helps to configure compiler and linker flags for
+.Op Ar options
+.Op Ar list of modules
+.Sh DESCRIPTION
+.Nm
+is a program which helps to configure compiler and linker flags for
 development frameworks. This allows build systems to detect other dependencies
 and use them with the system toolchain.
-.SH GENERAL OPTIONS
+.Sh GENERAL OPTIONS
-.TP
+.Bl -tag -width indent
-\fB\-\-version\fP
+.It Fl -version
 Display the supported pkg-config version and exit.
-.TP
+.It Fl -atleast-pkgconfig-version Ns = Ns Ar VERSION
-\fB\-\-atleast\-pkgconfig\-version=VERSION\fP
 Exit with error if we do not support the requested pkg-config version.
-.TP
+.It Fl -errors-to-stdout
-\fB\-\-errors\-to\-stdout\fP
 Print all errors on the main output stream instead of the error output stream.
-.TP
+.It Fl -silence-errors
-\fB\-\-silence\-errors\fP
 Do not display any errors at all.
-.TP
+.It Fl -list-all
-\fB\-\-list\-all\fP
+Walk all directories listed in the
-Walk all directories listed in the \fBPKG_CONFIG_PATH\fP environmental variable
+.Va PKG_CONFIG_PATH
-and display information on packages which have registered information there.
+environmental variable and display information on packages which have registered
-.TP
+information there.
-\fB\-\-simulate\fP
+.It Fl -simulate
 Simulates resolving a dependency graph based on the requested modules on the
 command line. Dumps a series of trees denoting pkgconf's resolver state.
-.TP
+.It Fl -no-cache
-\fB\-\-no\-cache\fP
 Skip caching packages when they are loaded into the internal resolver.  This may
 result in an alternate dependency graph being computed.
-.TP
+.It Fl -ignore-conflicts
-\fB\-\-ignore\-conflicts\fP
 Ignore 'Conflicts' rules in modules.
-.TP
+.It Fl -env-only
-\fB\-\-env\-only\fP
 Learn about pkgconf's configuration strictly from environmental variables.
-.TP
+.It Fl -maximum-traverse-depth Ns = Ns Ar DEPTH
-\fB\-\-maximum\-traverse\-depth=DEPTH\fP
+Impose a limit on the allowed depth in the dependency graph.  For example, a
-Impose a limit on the allowed depth in the dependency graph.  For example, a depth
+depth of 2 will restrict the resolver from acting on child dependencies of
-of 2 will restrict the resolver from acting on child dependencies of modules added to
+modules added to the resolver's solution.
-the resolver's solution.
+.It Fl -static
-.TP
+Compute a deeper dependency graph and use compiler/linker flags intended for
-\fB\-\-static\fP
+static linking.
-Compute a deeper dependency graph and use compiler/linker flags intended for static
+.El
-linking.
+.Sh MODULE-SPECIFIC OPTIONS
-.SH MODULE\-SPECIFIC OPTIONS
+.Bl -tag -width indent
-.TP
+.It Fl -atleast-version Ns = Ns Ar VERSION
-\fB\-\-atleast\-version=VERSION\fP
 Exit with error if a module's version is less than the specified version.
-.TP
+.It Fl -exact-version Ns = Ns Ar VERSION
-\fB\-\-exact\-version=VERSION\fP
 Exit with error if a module's version is not exactly the specified version.
-.TP
+.It Fl -max-version Ns = Ns Ar VERSION
-\fB\-\-max\-version=VERSION\fP
 Exit with error if a module's version is greater than the specified version.
-.TP
+.It Fl -exists
-\fB\-\-exists\fP
+Exit with a non-zero result if the dependency resolver was able to find all of
-Exit with a non-zero result if the dependency resolver was able to find all of the
+the requested modules.
-requested modules.
+.It Fl -uninstalled
-.TP
+Exit with a non-zero result if the dependency resolver uses an
-\fB\-\-uninstalled\fP
+.Sq uninstalled
-Exit with a non-zero result if the dependency resolver uses an 'uninstalled' module
+module as part of it's solution.
-as part of it's solution.
+.It Fl -no-uninstalled
-.TP
+Forbids the dependency resolver from considering 'uninstalled' modules as part
-\fB\-\-no\-uninstalled\fP
+of a solution.
-Forbids the dependency resolver from considering 'uninstalled' modules as part of a
+.El
-solution.
+.Sh QUERY-SPECIFIC OPTIONS
-.SH QUERY\-SPECIFIC OPTIONS
+.Bl -tag -width indent
-.TP
+.It Fl -cflags Ns , Fl -cflags-only-I Ns , Fl -cflags-only-other
-\fB\-\-cflags\fP, \fB\-\-cflags\-only\-I\fP, \fB\-\-cflags\-only\-other\fP
+Display either all CFLAGS, only
-Display either all CFLAGS, only \fB\-I\fP CFLAGS or only CFLAGS that are not \fB-I\fP.
+.Fl I
-.TP
+CFLAGS or only CFLAGS that are not
-\fB\-\-libs\fP, \fB\-\-libs\-only\-L\fP, \fB\-\-libs\-only\-l\fP, \fB\-\-libs\-only\-other\fP
+.Fl I .
-Display either all linker flags, only \fB\-L\fP linker flags, only \fB-l\fP linker flags or only linker flags that are not \fB-L\fP or \fB-l\fP.
+.It Fl -libs Ns , Fl -libs-only-L Ns , Fl -libs-only-l Ns , Fl -libs-only-other
-.TP
+Display either all linker flags, only
-\fB\-\-keep\-system\-cflags\fP, \fB\-\-keep\-system\-libs\fP
+.Fl L
-Keep CFLAGS or linker flag fragments that would be filtered due to being included by default in the compiler.
+linker flags, only
-.TP
+.Fl l
-\fB\-\-define-variable=VARNAME=VALUE\fP
+linker flags or only linker flags that are not
-Define \fBVARNAME\fP as \fBVALUE\fP. Variables are used in query output, and some modules' results may change based on the presence of a variable definition.
+.Fl L
-.TP
+or
-\fB\-\-print\-variables\fP
+.Fl l .
+.It Fl -keep-system-cflags Ns , Fl -keep-system-libs
+Keep CFLAGS or linker flag fragments that would be filtered due to being
+included by default in the compiler.
+.It Fl -define-variable Ns = Ns Ar VARNAME Ns = Ns Ar VALUE
+Define
+.Va VARNAME
+as
+.Va VALUE .
+Variables are used in query output, and some modules' results may change based
+on the presence of a variable definition.
+.It Fl -print-variables
 Print all seen variables for a module to the output channel.
-.TP
+.It Fl -variable Ns = Ns Ar VARNAME
-\fB\-\-variable=VARNAME\fP
+Print the value of
-Print the value of \fBVARNAME\fP.
+.Va VARNAME .
-.TP
+.It Fl -print-requires Ns , Fl -print-requires-private
-\fB\-\-print-requires\fP, \fB\-\-print\-requires\-private\fP
+Print the modules included in either the
-Print the modules included in either the \fBRequires\fP field or the \fBRequires.private\fP field.
+.Va Requires
-.TP
+field or the
-\fB\-\-digraph\fP
+.Va Requires.private
-Dump the dependency resolver's solution as a graphviz 'dot' file.  This can be used with graphviz to visualize
+field.
-module interdependencies.
+.It Fl -digraph
-.SH EXAMPLES
+Dump the dependency resolver's solution as a graphviz
-.TP
+.Sq dot
+file. This can be used with graphviz to visualize module interdependencies.
+.El
+.Sh EXAMPLES
 Displaying the CFLAGS of a package:
-shell> pkgconf --cflags foo
+.Dl $ pkgconf --cflags foo
-.br
+.Dl -fPIC -I/usr/include/foo
--fPIC -I/usr/include/foo