diff options
author | Mathieu Lirzin <mthl@gnu.org> | 2015-06-26 23:17:01 +0200 |
---|---|---|
committer | Mathieu Lirzin <mthl@gnu.org> | 2016-05-07 11:32:17 +0200 |
commit | 8f430594f4452c378de08177be187d1cb5de1cd0 (patch) | |
tree | 91758d0c655d18fcc7d0f80cc8bbb53417e77604 | |
parent | b3202cecf6a051d726f9af5d080aeb89257b0a98 (diff) | |
download | mcron-8f430594f4452c378de08177be187d1cb5de1cd0.tar.gz mcron-8f430594f4452c378de08177be187d1cb5de1cd0.tar.bz2 mcron-8f430594f4452c378de08177be187d1cb5de1cd0.zip |
build: Fix build of the manual.
* mcron.texinfo.in: Rename to ...
* doc/mcron.texi: ... this.
* doc/config.texi.in: New file.
* configure.ac: Adapt to it.
* makefile.am: Likewise.
* .gitignore: Likewise.
* README--git: Likewise.
-rw-r--r-- | .gitignore | 9 | ||||
-rw-r--r-- | README--git | 11 | ||||
-rw-r--r-- | configure.ac | 7 | ||||
-rw-r--r-- | doc/config.texi.in | 5 | ||||
-rw-r--r-- | doc/mcron.texi (renamed from mcron.texinfo.in) | 102 | ||||
-rw-r--r-- | makefile.am | 11 |
6 files changed, 79 insertions, 66 deletions
@@ -10,13 +10,18 @@ config.status configure core.scm depcomp +/doc/.dirstamp +/doc/config.texi +/doc/mcron.info +/doc/mcron.1 +/doc/stamp-vti +/doc/version.texi install-sh makefile makefile.in /mcron mcron.c -mcron.info +/mdate-sh *.o -mcron.texinfo missing texinfo.tex diff --git a/README--git b/README--git index 43e9890..0b24ded 100644 --- a/README--git +++ b/README--git @@ -1,6 +1,7 @@ GNU mcron --- README--git -*-text-*- Copyright (C) 2012, 2014 Dale Mellor + Copyright (C) 2015, 2016 Mathieu Lirzin Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright @@ -10,13 +11,9 @@ GNU mcron --- README--git -*-text-*- If you have pulled mcron from the GIT repository, these are the steps you will need to take to build it the first time: -1) aclocal -2) autoconf -3) automake -a (will error) -4) ./configure (will error) -5) automake -a -6) ./configure --prefix={wherever} -7) make install +1) autoreconf -vfi +2) ./configure --prefix={wherever} +3) make install After that it should just be a simple matter of typing `make install' when you diff --git a/configure.ac b/configure.ac index 764ea03..fee17fc 100644 --- a/configure.ac +++ b/configure.ac @@ -3,6 +3,7 @@ # Copyright (C) 2003, 2005, 2012, 2014 Dale Mellor +# Copyright (C) 2015, 2016 Mathieu Lirzin # # This file is part of GNU mcron. # @@ -174,6 +175,8 @@ AC_SUBST(CONFIG_TMP_DIR) real_program_prefix=`echo $program_prefix | sed s/NONE//` AC_SUBST(real_program_prefix) - -AC_CONFIG_FILES(mcron.texinfo makefile scm/mcron/makefile scm/mcron/config.scm) +AC_CONFIG_FILES([doc/config.texi + makefile + scm/mcron/makefile + scm/mcron/config.scm]) AC_OUTPUT diff --git a/doc/config.texi.in b/doc/config.texi.in new file mode 100644 index 0000000..50d9a18 --- /dev/null +++ b/doc/config.texi.in @@ -0,0 +1,5 @@ +@set CONFIG_SOCKET_FILE @CONFIG_SOCKET_FILE@ +@set CONFIG_SPOOL_DIR @CONFIG_SPOOL_DIR@ +@set CONFIG_PID_FILE @CONFIG_PID_FILE@ +@set CONFIG_ALLOW_FILE @CONFIG_ALLOW_FILE@ +@set CONFIG_DENY_FILE @CONFIG_DENY_FILE@ diff --git a/mcron.texinfo.in b/doc/mcron.texi index bbf8e5b..cb97a06 100644 --- a/mcron.texinfo.in +++ b/doc/mcron.texi @@ -1,12 +1,14 @@ \input texinfo @c %**start of header @setfilename mcron.info -@settitle mcron @VERSION@ +@include config.texi +@include version.texi +@settitle mcron @value{VERSION} @c %**end of header @syncodeindex fn cp -@copying This manual is for GNU mcron (version @VERSION@), which is a +@copying This manual is for GNU mcron (version @value{VERSION}), which is a program for running jobs at scheduled times. Copyright @copyright{} 2003, 2005, 2006, 2012, 2014 Dale Mellor @@ -68,36 +70,36 @@ running jobs at scheduled times. Simple examples -* Guile Simple Examples:: -* Vixie Simple Examples:: +* Guile Simple Examples:: +* Vixie Simple Examples:: Full available syntax -* Guile Syntax:: -* Extended Guile examples:: -* Vixie Syntax:: +* Guile Syntax:: +* Extended Guile examples:: +* Vixie Syntax:: Extended Guile examples -* AT commands:: -* Every second Sunday:: -* Two hours every day:: -* Missing the first appointment:: -* Penultimate day of every month:: +* AT commands:: +* Every second Sunday:: +* Two hours every day:: +* Missing the first appointment:: +* Penultimate day of every month:: Vixie -* Paul Vixie's copyright:: -* Crontab file:: -* Incompatibilities with old Unices:: +* Paul Vixie's copyright:: +* Crontab file:: +* Incompatibilities with old Unices:: Detailed invoking -* Invoking mcron:: -* Invoking cron or crond:: +* Invoking mcron:: +* Invoking cron or crond:: * Invoking crontab:: * Behaviour on laptops:: -* Exit codes:: +* Exit codes:: Guile modules @@ -182,8 +184,8 @@ been to allow such simple specifications to be made easily. The examples show how to create the command descriptions, and subsequently how to run mcron to make them happen. @menu -* Guile Simple Examples:: -* Vixie Simple Examples:: +* Guile Simple Examples:: +* Vixie Simple Examples:: @end menu @node Guile Simple Examples, Vixie Simple Examples, Simple examples, Simple examples @@ -258,9 +260,9 @@ on your system, as root. @node Syntax, Invoking, Simple examples, Top @chapter Full available syntax @menu -* Guile Syntax:: -* Extended Guile examples:: -* Vixie Syntax:: +* Guile Syntax:: +* Extended Guile examples:: +* Vixie Syntax:: @end menu @node Guile Syntax, Extended Guile examples, Syntax, Syntax @section Guile Syntax @@ -392,11 +394,11 @@ they seem. The following examples illustrate some pitfalls, and demonstrate how to code around them. @menu -* AT commands:: -* Every second Sunday:: -* Two hours every day:: -* Missing the first appointment:: -* Penultimate day of every month:: +* AT commands:: +* Every second Sunday:: +* Two hours every day:: +* Missing the first appointment:: +* Penultimate day of every month:: @end menu @node AT commands, Every second Sunday, Extended Guile examples, Extended Guile examples @@ -545,9 +547,9 @@ the variable and runs the command in the user's default shell, as advertised by the /etc/passwd file. @menu -* Paul Vixie's copyright:: -* Crontab file:: -* Incompatibilities with old Unices:: +* Paul Vixie's copyright:: +* Crontab file:: +* Incompatibilities with old Unices:: @end menu @@ -796,11 +798,11 @@ place in the part which implements the mcron personality. @menu -* Invoking mcron:: -* Invoking cron or crond:: +* Invoking mcron:: +* Invoking cron or crond:: * Invoking crontab:: * Behaviour on laptops:: -* Exit codes:: +* Exit codes:: @end menu @node Invoking mcron, Invoking cron or crond, Invoking, Invoking @@ -893,21 +895,21 @@ standard output. @cindex invoking cron @cindex crond, invokation @cindex invoking crond -@cindex @CONFIG_SPOOL_DIR@ -@cindex @CONFIG_SOCKET_FILE@ +@cindex @value{CONFIG_SPOOL_DIR} +@cindex @value{CONFIG_SOCKET_FILE} NOTE THAT THIS SECTION ONLY APPLIES IF THE @code{cron} or @code{crond}, and @code{crontab} PROGRAMS HAVE BEEN INSTALLED BY THE SYSTEM ADMINISTRATOR. If the program runs by the name of @code{cron} or @code{crond}, then -it will read all the files in @code{@CONFIG_SPOOL_DIR@} (which should only -be readable by root) and the file @code{/etc/crontab}, and then -detaches itself from the terminal to live forever as a daemon +it will read all the files in @code{@value{CONFIG_SPOOL_DIR}} (which +should only be readable by root) and the file @code{/etc/crontab}, and +then detaches itself from the terminal to live forever as a daemon process. Additionally, it creates a UNIX socket at -@code{@CONFIG_SOCKET_FILE@}, and listens for messages sent to that socket -consisting of a user name whose crontabs have been changed. In this -case, the program will re-read that user's crontab. This is for -correct functioning with the crontab program. +@code{@value{CONFIG_SOCKET_FILE}}, and listens for messages sent to +that socket consisting of a user name whose crontabs have been +changed. In this case, the program will re-read that user's crontab. +This is for correct functioning with the crontab program. Further, if the @code{--noetc} option was not used, a job is scheduled to run every minute to check if /etc/crontab has been modified @@ -1060,7 +1062,7 @@ No problems. @item 1 An attempt has been made to start cron but there is already a -@CONFIG_PID_FILE@ file. If there really is no other cron daemon +@value{CONFIG_PID_FILE} file. If there really is no other cron daemon running (this does not include invokations of mcron) then you should remove this file before attempting to run cron. @@ -1078,9 +1080,9 @@ to be specified in one of these forms. @item 4 An attempt to run cron has been made by a user who does not have -permission to access the crontabs in @CONFIG_SPOOL_DIR@. These files -should be readable only by root, and the cron daemon must be run as -root. +permission to access the crontabs in @value{CONFIG_SPOOL_DIR}. These +files should be readable only by root, and the cron daemon must be run +as root. @item 5 An attempt to run mcron has been made, but there are no jobs to @@ -1088,7 +1090,7 @@ schedule! @item 6 The system administrator has blocked this user from using crontab with -the files @CONFIG_ALLOW_FILE@ and @CONFIG_DENY_FILE@. +the files @value{CONFIG_ALLOW_FILE} and @value{CONFIG_DENY_FILE}. @item 7 Crontab has been run with more than one of the arguments @code{-l}, @@ -1248,7 +1250,7 @@ This module is introduced to a program with the command @code{(use-modules (mcron redirect))}. This module provides the @code{with-mail-out} function, described -fully in @ref{Guile Syntax}. +fully in @ref{Guile Syntax}. @node The vixie-time module, The job-specifier module, The redirect module, Guile modules @section The vixie-time module @@ -1325,7 +1327,7 @@ return silently. Otherwise, the behaviour is identical to Once this module has been declared in a program, a crontab file can be used to augment the current job list with a call to -@code{read-vixie-file}. +@code{read-vixie-file}. @node Index, , Guile modules, Top @unnumbered Index diff --git a/makefile.am b/makefile.am index 633cf2f..189ce02 100644 --- a/makefile.am +++ b/makefile.am @@ -1,5 +1,6 @@ ## Makefile for the toplevel directory of mcron. ## Copyright (C) 2003 Dale Mellor +## Copyright (C) 2015 Mathieu Lirzin ## # This file is part of GNU mcron. # @@ -31,9 +32,9 @@ CLEANFILES = mcron.c EXTRA_DIST = makefile.ed mcron.c.template BUGS -info_TEXINFOS = mcron.texinfo +info_TEXINFOS = doc/mcron.texi -dist_man_MANS = mcron.1 +dist_man_MANS = doc/mcron.1 bin_PROGRAMS = mcron mcron_SOURCES = mcron.c @@ -79,6 +80,6 @@ uninstall-hook: # Not part of formal package building, but a rule for manual use to get the # elemental man page. Will only work once the mcron program is installed. -mcron.1 : mcron.c - $(HELP2MAN) -n 'a program to run tasks at regular (or not) intervals' \ - ./mcron > mcron.1 +doc/mcron.1: mcron.c + -$(HELP2MAN) -n 'a program to run tasks at regular (or not) intervals' \ + ./mcron > $@ |