From 605fc281c1fd80b63b6bc608e5882b1abaec0035 Mon Sep 17 00:00:00 2001 From: P. J. McDermott Date: Sat, 14 Oct 2023 16:08:38 -0400 Subject: build, man: Add manual page --- diff --git a/Makefile.am b/Makefile.am index accbfa6..883846c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -70,6 +70,8 @@ V_REDIR_ = $(V_REDIR_$(AM_DEFAULT_VERBOSITY)) V_REDIR_0 = 1>/dev/null 2>&1 V_REDIR_1 = +SUFFIXES = + version.c: $(atsign_OBJECTS) $(atsign_DEPENDENCIES) $(AM_V_GEN)printf 'const char *PACKAGE_VERSION_GIT = "%s";\n' \ "$(PACKAGE_VERSION_GIT)" >version.c @@ -89,6 +91,13 @@ install-exec-hook: src='$(DESTDIR)$(bindir)/@$(EXEEXT)'; \ echo " $(LN_S) '$${dst}' '$${src}'"; \ $(LN_S) "$${dst}" "$${src}" +install-data-hook: + @set -e; \ + dst="$$(printf 'atsign' | \ + sed '$(transform); s/$$/$(EXEEXT)/').1"; \ + src='$(DESTDIR)$(man1dir)/@$(EXEEXT).1'; \ + echo " $(LN_S) '$${dst}' '$${src}'"; \ + $(LN_S) "$${dst}" "$${src}" uninstall-hook: echo " rm -f '$(DESTDIR)$(bindir)/@$(EXEEXT)'" rm -f "$(DESTDIR)$(bindir)/@$(EXEEXT)" @@ -157,6 +166,7 @@ release: files@files.pehjota.net:files/pub/$(PACKAGE)/$(VERSION)/ include $(top_srcdir)/src/local.mk +include $(top_srcdir)/man/local.mk include $(top_srcdir)/tests/local.mk SUBDIRS = . po diff --git a/man/.gitignore b/man/.gitignore new file mode 100644 index 0000000..ba0d22a --- /dev/null +++ b/man/.gitignore @@ -0,0 +1 @@ +*.? diff --git a/man/atsign.1in b/man/atsign.1in new file mode 100644 index 0000000..6cc1123 --- /dev/null +++ b/man/atsign.1in @@ -0,0 +1,41 @@ +.TH ATSIGN "1" "2023-10-14" "@PACKAGE_STRING@" + +.SH NAME +@ATSIGN@ \- delay until a specified time + +.SH SYNOPSIS +.B @ATSIGN@ +[\fI\,date\/\fR]\fI\,time\/\fR + +.SH OPTIONS + +.TP +\fB\-F\fR, \fB\-\-list\-formats\fR +List all supported date and time formats + +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this help information + +.TP +\fB\-V\fR, \fB\-\-version\fR +Show version information + +.SH "REPORTING BUGS" +Report bugs to <@PACKAGE_BUGREPORT@>. + +.SH COPYRIGHT +Copyright \(co 2023 P. J. McDermott +.PP +@ is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.PP +@ is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. +.PP +You should have received a copy of the GNU General Public License +along with @. If not, see . diff --git a/man/local.mk b/man/local.mk new file mode 100644 index 0000000..65814fe --- /dev/null +++ b/man/local.mk @@ -0,0 +1,43 @@ +# Process this file with automake to produce an input makefile. +# +# Copyright (C) 2018, 2023 P. J. McDermott +# +# This file is part of @ +# +# @ is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# @ is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with @. If not, see . + +man1_sources = \ + %reldir%/atsign.1in +man1_MANS = $(man1_sources:.1in=.1) + +CLEANFILES += \ + $(man1_MANS) +EXTRA_DIST += \ + $(man1_sources) + +if ENABLE_SYMLINK +atsign = @$(EXEEXT) +else !ENABLE_SYMLINK +atsign = $$(printf 'atsign' | sed '$(transform); s/$$/$(EXEEXT)/') +endif +man_subst = sed \ + -e "s|[@]PACKAGE_STRING[@]|$(PACKAGE_STRING)|g" \ + -e "s|[@]PACKAGE_BUGREPORT[@]|$(PACKAGE_BUGREPORT)|g" \ + -e "s|[@]ATSIGN[@]|$(atsign)|g" + +SUFFIXES += .1in .1 + +.1in.1: + $(AM_V_GEN)$(MKDIR_P) "$$(dirname $@)" + $(AM_V_at)$(man_subst) $< >$@ -- cgit v0.9.1