summaryrefslogtreecommitdiff
path: root/headers.1.in
diff options
context:
space:
mode:
authorAki <please@ignore.pl>2024-08-26 13:08:20 +0200
committerAki <please@ignore.pl>2024-08-26 13:09:46 +0200
commit911c7d42043aabb36ba509fe6325c247b1f7415c (patch)
tree2d7af61723ccf596cd80f36f7b91dc838716e65a /headers.1.in
parentf7d4ad2f7dd6bf64d13896d3409fde9b5437e374 (diff)
downloadheaders-911c7d42043aabb36ba509fe6325c247b1f7415c.zip
headers-911c7d42043aabb36ba509fe6325c247b1f7415c.tar.gz
headers-911c7d42043aabb36ba509fe6325c247b1f7415c.tar.bz2
Added manual pageHEADmaster
Diffstat (limited to 'headers.1.in')
-rw-r--r--headers.1.in27
1 files changed, 27 insertions, 0 deletions
diff --git a/headers.1.in b/headers.1.in
new file mode 100644
index 0000000..661f2ca
--- /dev/null
+++ b/headers.1.in
@@ -0,0 +1,27 @@
+.TH headers 1 "2024-08-26"
+.SH NAME
+headers - prints list of headers from one or more standards
+.SH SYNOPSIS
+.B headers
+.RB [ \-d
+.IR path ]
+.RI [ standards ]...
+.SH DESCRIPTION
+Once called this script will scan standard database directory, parse its content and then perform action based on
+command-line arguments. If any trailing
+.I standards
+were passed, the tool will print all headers from the selected standards. Otherwise a list of available standards will
+be printed to standard output.
+.P
+Optionally,
+.B -d
+can be provided to change the default location where standard definitions are scanned.
+.SH FILES
+Default location with standard definitions is at
+.IR @HEADERS_DB@ .
+.SH ENVIRONMENT
+In addition to
+.B \-d
+option,
+.B HEADERS_DB_PATH
+can be set in the environment to change the default location for standard definitions.