This patch adds a small u-config.1 manual page, formatted using the
mdoc(7) language. In order to avoid having to keep up to date both the
manual page and the u-config.c source, the manual page defers to the
`--help` option when it comes to which pkg-config options and
environment variables are supported.
Debian has a policy of always shipping manual pages with binaries in
/usr/bin, hence why I wrote this.
---
Hi! First of all thanks for your work on u-config, it's a really nice
little tool. I intend to package this for Debian, since I find it useful
when working on pkg-config files. As also mentioned in the commit
message, this is the reason why I wrote this. If there's anything
I should change, please let me know. I'll soon also send this as
a GitHub pull request, since that's where u-config development seems to
happen.
Bye!
u-config.1 | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 79 insertions(+)
create mode 100644 u-config.1
diff --git a/u-config.1 b/u-config.1
new file mode 100644
index 0000000..e0584c3
--- /dev/null
+++ b/u-config.1
@@ -0,0 +1,79 @@
+.Dd 2024-08-22
+.Dt U-CONFIG 1
+.Os
+.
+.Sh NAME
+.Nm u-config
+.Nd smaller, simpler, portable pkg-config clone
+.
+.Sh SYNOPSIS
+.Nm
+.Op Ar options
+.Ar package Op Ar package ...
+.
+.Sh DESCRIPTION
+.Nm
+is a small, highly portable pkg-config and pkgconf clone. It retrieves compiler
+and linker flags, version, and other dependency information of software
+packages.
+.Pp
+Package metadata is retrieved from
+.Dq .pc
+text files, located in a system-specific path. You can override the default
+search path with environment variables like
+.Ev PKG_CONFIG_PATH .
+See
+.Sx ENVIRONMENT
+for more information.
+.Pp
+This manual page describes the
+.Nm
+utility in particular. For general information about pkg-config concepts and its
+file format, refer to manual pages provided by other projects, like
+.Xr pkgconf 1
+and
+.Xr pc 5 .
+.Pp
+.Nm
+supports a subset of the options of other pkg-config implementations. For a
+list of supported options, use the
+.Fl \-help
+option. Some of them are unique to
+.Nm :
+.Bl -tag -width indent
+.It Fl \-newlines
+Separate arguments by line feeds instead of spaces, which is sometimes useful
+like in the fish shell or when manually examining output.
+.It Fl \-msvc\-syntax
+Translates and prints compiler arguments into a syntax compatible with the MSVC
+compiler. For example,
+.Fl l Ar libname
+becomes
+.Cm libname.lib .
+.El
+.
+.Sh ENVIRONMENT
+.Nm
+supports all the important pkg-config run-time environment variables. To see
+which are supported, use the
+.Fl \-help
+option.
+.
+.Sh EXAMPLES
+.Bd -literal
+$ u-config --cflags --libs foo
+-I/usr/include/foo -DFOO_HAS_BAR=1 -lfoo
+.Ed
+.
+.Sh SEE ALSO
+.Xr pkgconf 1 ,
+.Xr pc 5
+.
+.Sh AUTHORS
+.Nm
+was written by
+.An Chris Wellons Aq Mt wellons@nullprogram.com .
+This manual page was written by
+.An Andrea Pappacoda Aq Mt andrea@pappacoda.it
+for the Debian project
+.Pq and may be used by others .
--
2.43.0