summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJim Meyering <meyering@redhat.com>2008-05-02 23:23:42 +0200
committerJim Meyering <meyering@redhat.com>2008-05-17 12:53:14 +0200
commit28ca38170027bb9acd77e01d5e77577b8e677106 (patch)
treefa3d9a44ba243b8aef7d78b763993f660990232a /man
parent8208baa939236528d8c7fff486dec9100b36d90d (diff)
downloadidutils-28ca38170027bb9acd77e01d5e77577b8e677106.tar.gz
idutils-28ca38170027bb9acd77e01d5e77577b8e677106.tar.bz2
idutils-28ca38170027bb9acd77e01d5e77577b8e677106.zip
Generate man pages, update from coreutils.
* configure.ac (AC_CONFIG_FILES): Add man/Makefile. Check for help2man. * man/Makefile.am: New file. * .gitignore: Add .version and .tarball-version. * Makefile.am (SUBDIRS): Add man. * cfg.mk: Update from coreutils. * maint.mk: Likewise. * man/aid.x: New file. * man/defid.x: Likewise. * man/eid.x: Likewise. * man/fid.x: Likewise. * man/fnid.x: Likewise. * man/gid.x: Likewise. * man/lid.x: Likewise. * man/mkid.x: Likewise. * man/xtokid.x: Likewise.
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am67
-rw-r--r--man/aid.x4
-rw-r--r--man/defid.x3
-rw-r--r--man/eid.x4
-rw-r--r--man/fid.x4
-rw-r--r--man/fnid.x4
-rw-r--r--man/gid.x4
-rw-r--r--man/lid.x4
-rw-r--r--man/mkid.x4
-rw-r--r--man/xtokid.x4
10 files changed, 102 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..aff98d1
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,67 @@
+## Process this file with automake to produce Makefile.in -*-Makefile-*-
+dist_man_MANS = mkid.1 lid.1 fid.1 fnid.1 xtokid.1 eid.1 aid.1 gid.1 defid.1
+
+man_aux = $(dist_man_MANS:.1=.x)
+EXTRA_DIST = $(man_aux)
+MAINTAINERCLEANFILES = $(man_MANS)
+
+# Depend on .version to get version number changes.
+common_dep = $(top_srcdir)/.version
+
+mkid.1: $(common_dep) $(srcdir)/mkid.x ../src/mkid.c
+lid.1: $(common_dep) $(srcdir)/lid.x ../src/lid.c
+fid.1: $(common_dep) $(srcdir)/fid.x ../src/fid.c
+fnid.1: $(common_dep) $(srcdir)/fnid.x ../src/fnid.c
+xtokid.1: $(common_dep) $(srcdir)/xtokid.x ../src/xtokid.c
+eid.1: $(common_dep) $(srcdir)/eid.x ../src/eid ../src/lid.c
+aid.1: $(common_dep) $(srcdir)/aid.x ../src/aid ../src/lid.c
+gid.1: $(common_dep) $(srcdir)/gid.x ../src/gid ../src/lid.c
+
+SUFFIXES = .x .1
+
+# Ensure that help2man runs the ../src/ginstall binary as
+# `install' when creating install.1.
+# Similarly, ensure that it uses the ../src/[ binary to create test.1.
+t = $*.td
+mapped_name = `echo $*|sed 's/install/ginstall/; s/test/[/'`
+
+# That is necessary to avoid failures for programs that are also shell built-in
+# functions like echo, false, printf, pwd.
+.x.1:
+ @echo "Updating man page $@"; \
+ PATH=../src$(PATH_SEPARATOR)$$PATH; export PATH; \
+ $(HELP2MAN) \
+ --include=$(srcdir)/$*.x \
+ --output=$@ $*$(EXEEXT)
+
+check-local: check-x-vs-1 check-programs-vs-x
+
+# Sort in traditional ASCII order, regardless of the current locale;
+# otherwise we may get into trouble with distinct strings that the
+# current locale considers to be equal.
+ASSORT = LC_ALL=C sort
+
+# Ensure that for each .x file in this directory, there is a
+# corresponding .1 file in the definition of $(dist_man_MANS) above.
+.PHONY: check-x-vs-1
+check-x-vs-1:
+ PATH=../src$(PATH_SEPARATOR)$$PATH; export PATH; \
+ t=ls-files.$$$$; \
+ (cd $(srcdir) && ls -1 *.x) | sed 's/\.x$$//' | $(ASSORT) > $$t;\
+ echo $(dist_man_MANS) | fmt -w1 | sed 's/\.1$$//' | $(ASSORT) \
+ | diff -u - $$t || { rm $$t; exit 1; }; \
+ rm $$t
+
+programs = \
+ echo 'spy:;@echo $$(all_programs)' \
+ | MAKEFLAGS= $(MAKE) -s -C $(srcdir)/../src -f Makefile -f - spy \
+ | fmt -1 | $(ASSORT) -u | grep -v '\['
+
+.PHONY: check-programs-vs-x
+check-programs-vs-x:
+ for p in `$(programs)`; do \
+ test $$p = ginstall && p=install || : ; \
+ test -f $(srcdir)/$$p.x \
+ || { echo missing $$p.x 1>&2; missing=1; }; \
+ done; \
+ test "$$missing" = 1 && exit 1 || :
diff --git a/man/aid.x b/man/aid.x
new file mode 100644
index 0000000..940eaf7
--- /dev/null
+++ b/man/aid.x
@@ -0,0 +1,4 @@
+[NAME]
+aid \- Query ID database and report results.
+[DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/defid.x b/man/defid.x
new file mode 100644
index 0000000..f56e0ad
--- /dev/null
+++ b/man/defid.x
@@ -0,0 +1,3 @@
+[NAME]
+defid \- [DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/eid.x b/man/eid.x
new file mode 100644
index 0000000..81036cb
--- /dev/null
+++ b/man/eid.x
@@ -0,0 +1,4 @@
+[NAME]
+eid \- Query ID database and report results.
+[DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/fid.x b/man/fid.x
new file mode 100644
index 0000000..a190b5e
--- /dev/null
+++ b/man/fid.x
@@ -0,0 +1,4 @@
+[NAME]
+fid \- List identifiers in F1; if F2 is also given, list those common to both
+[DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/fnid.x b/man/fnid.x
new file mode 100644
index 0000000..3f0adcb
--- /dev/null
+++ b/man/fnid.x
@@ -0,0 +1,4 @@
+[NAME]
+fnid \- Print constituent file names that match PATTERN,
+[DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/gid.x b/man/gid.x
new file mode 100644
index 0000000..9ae9862
--- /dev/null
+++ b/man/gid.x
@@ -0,0 +1,4 @@
+[NAME]
+gid \- Query ID database and report results.
+[DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/lid.x b/man/lid.x
new file mode 100644
index 0000000..1e9b56f
--- /dev/null
+++ b/man/lid.x
@@ -0,0 +1,4 @@
+[NAME]
+lid \- Query ID database and report results.
+[DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/mkid.x b/man/mkid.x
new file mode 100644
index 0000000..c313181
--- /dev/null
+++ b/man/mkid.x
@@ -0,0 +1,4 @@
+[NAME]
+mkid \- build an identifier database
+[DESCRIPTION]
+.\" Add any additional description here
diff --git a/man/xtokid.x b/man/xtokid.x
new file mode 100644
index 0000000..af17e48
--- /dev/null
+++ b/man/xtokid.x
@@ -0,0 +1,4 @@
+[NAME]
+xtokid \- Print all tokens found in a source file.
+[DESCRIPTION]
+.\" Add any additional description here