Skip to content

Commit

Permalink
beep.1: Automatically use the installed locations of README.md etc
Browse files Browse the repository at this point in the history
  • Loading branch information
ndim committed Jan 4, 2019
1 parent 728ce46 commit 1a78460
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -17,6 +17,7 @@
*.s
*.lst
*.gcc-lst
/beep.1

# The compressed man page
/beep.1.gz
Expand Down
1 change: 0 additions & 1 deletion DEVELOPMENT.md
Expand Up @@ -103,7 +103,6 @@ Options:
TODO list
---------

* TODO: Make beep.1 refer to README.md at the installed location.
* TODO: Document references to Johnathan's Email or Website as historic.
* TODO: Go over all documentation regarding links.

Expand Down
8 changes: 5 additions & 3 deletions GNUmakefile
Expand Up @@ -193,6 +193,11 @@ $(foreach compiler,$(COMPILERS),$(eval $(call PER_COMPILER,$(compiler))))

man1_DATA += beep.1.gz
CLEANFILES += beep.1.gz
CLEANFILES += beep.1

%.1: %.1.in
$(SED) -e "s|[@]pkgdocdir@|$(pkgdocdir)|g" < $< > $@.tmp
mv -f $@.tmp $@

%.1.gz: %.1
$(GZIP) --best -c < $< > $@
Expand Down Expand Up @@ -291,9 +296,6 @@ ifneq (,$(man1_DATA))
$(INSTALL) -m 0755 -d $(DESTDIR)$(man1dir)
$(INSTALL) -m 0644 -p $(man1_DATA) $(DESTDIR)$(man1dir)/
endif

.PHONY: install-doc
install-doc: doc
ifneq (,$(pkgdoc_DATA))
$(INSTALL) -m 0755 -d $(DESTDIR)$(pkgdocdir)
$(INSTALL) -m 0644 -p $(pkgdoc_DATA) $(DESTDIR)$(pkgdocdir)/
Expand Down
6 changes: 3 additions & 3 deletions beep.1 → beep.1.in
Expand Up @@ -136,7 +136,7 @@ rule to allow write access to
.B /dev/input/by-path/platform-pcspkr-event-spkr
for certain users and/or user groups. For details, see the
.B beep
.B INSTALL.md
.B @pkgdocdir@/PERMISSIONS.md
file.
.\"
.SS "APIs"
Expand Down Expand Up @@ -253,7 +253,7 @@ will produce first two 1000Hz beeps, then 5 beeps at the default tone, but only
.SH SEE ALSO
.\" .BR fixme (1),
.\" .BR andme (1),
.BR README.md ,
.BR INSTALL.md ,
.BR @pkgdocdir@/README.md ,
.BR @pkgdocdir@/INSTALL.md ,
.UR "https://github.com/ndim/beep"
.UE
3 changes: 2 additions & 1 deletion beep.c
Expand Up @@ -20,7 +20,8 @@
*/

/*
* For more documentation on beep, see the beep-usage.txt and beep.1 files.
* For more documentation on beep, see the beep-usage.txt and
* beep.1.in files.
*/


Expand Down
2 changes: 1 addition & 1 deletion gen-freq-table
@@ -1,6 +1,6 @@
#!/usr/bin/env python3
#
# gen-freq-table - calculate and print the frequency table for use in beep.1 man page
# gen-freq-table - calculate and print the frequency table for use in beep(1) man page
# Copyright (C) 2018-2019 Hans Ulrich Niedermann
#
# This program is free software; you can redistribute it and/or modify
Expand Down

0 comments on commit 1a78460

Please sign in to comment.