Hamlib/doc/Makefile.am

EXTRA_DIST = hamlib.cfg index.doxygen hamlib.css footer.html \
	Hamlib_design.eps Hamlib_design.png

dist_man_MANS = man1/rigctl.1 man1/rigctld.1 man1/rigmem.1 man1/rigsmtr.1 \
	man1/rigswr.1 man1/rotctl.1 man1/rotctld.1 man7/hamlib.7 \
	man7/hamlib-primer.7 man7/hamlib-utilities.7

htmldir = $(docdir)/html
dist_html_DATA = Hamlib_design.png hamlib.html

SRCDOCLST = ../src/rig.c ../src/rotator.c ../src/tones.c ../src/locator.c \
	../src/event.c ../src/conf.c ../src/mem.c ../src/settings.c

info_TEXINFOS = hamlib.texi
hamlib_TEXINFOS = nutshell.texi getting_started.texi utility_programs.texi \
	fdl.texi

AM_MAKEINFOHTMLFLAGS = --no-headers --no-split

doc: hamlib.cfg $(SRCDOCLST)
	doxygen hamlib.cfg

# Don't attempt to generate DVI file with 'make distcheck'
dvi:
Install certain top level files into docdir Install generated Texinfo HTML manual into docdir/html. 2017-07-28 02:33:14 +00:00			`EXTRA_DIST = hamlib.cfg index.doxygen hamlib.css footer.html \`
			`Hamlib_design.eps Hamlib_design.png`
misc fix git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@952 7ae35d74-ebe9-4afe-98af-79ac388436b8 2002-02-12 22:08:33 +00:00
Move utility man page files to doc/man1 Maintain manual page files in the doc directory rather than the source directories. 2018-04-30 12:19:59 +00:00			`dist_man_MANS = man1/rigctl.1 man1/rigctld.1 man1/rigmem.1 man1/rigsmtr.1 \`
New project information manual pages Project information manual pages (section 7) have been created from the Texinfo manual that provide a set of general information pages about Hamlib. 2018-07-30 03:00:14 +00:00			`man1/rigswr.1 man1/rotctl.1 man1/rotctld.1 man7/hamlib.7 \`
			`man7/hamlib-primer.7 man7/hamlib-utilities.7`
Move utility man page files to doc/man1 Maintain manual page files in the doc directory rather than the source directories. 2018-04-30 12:19:59 +00:00
Install certain top level files into docdir Install generated Texinfo HTML manual into docdir/html. 2017-07-28 02:33:14 +00:00			`htmldir = $(docdir)/html`
Create HTML manual at 'make dist' time Per the suggestion of Greg Troxel, N1DAM, remove the need for the 'makeinfo' dependency at build time by creating the HTML version of the manual along with the info version at 'make dist' time. The removes the build dependency on 'makeinfo' that was introduced since the release of 3.1. 2018-03-23 23:15:55 +00:00			`dist_html_DATA = Hamlib_design.png hamlib.html`
doc/Makefile.am: distribute Texinfo HTML and PDF Build and distribute the HTML and PDF files generated from the Texinfo source with 'make dist'. Also install these files with 'make install'. 2013-02-26 02:58:43 +00:00
don't forget style sheet in dist git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@1486 7ae35d74-ebe9-4afe-98af-79ac388436b8 2003-06-22 19:51:49 +00:00			`SRCDOCLST = ../src/rig.c ../src/rotator.c ../src/tones.c ../src/locator.c \`
Add some tips on Hamlib man pages formatting 2018-05-03 12:31:12 +00:00			`../src/event.c ../src/conf.c ../src/mem.c ../src/settings.c`
don't forget style sheet in dist git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@1486 7ae35d74-ebe9-4afe-98af-79ac388436b8 2003-06-22 19:51:49 +00:00
doc: First run at texinfo documentation After much consideration, texinfo was chosen for the Hamlib manual. Initially Docbook had been considered and then abandoned. Doxygen generated output from the source files has filled that role since but experience has shown that more explanation would be useful. ASCIIdoc had been considered and while HTML and PDF outputs are possible, GNU info style documentation seems not to be. Texinfo provides for all three and is easily integrated into Automake and enables version and update variables generated by Autotools to be easily integrated into the documentation. The manual is released under the GNU Free Document License with no invariant sections and no cover texts. This meets the current Debian Free Software Guidelines. 2013-02-24 13:37:40 +00:00			`info_TEXINFOS = hamlib.texi`
hamlib.texi: Chapter 3 draft Initial draft of chapter 3 of the Hamlib manual. 2013-04-12 15:35:04 +00:00			`hamlib_TEXINFOS = nutshell.texi getting_started.texi utility_programs.texi \`
			`fdl.texi`
doc: First run at texinfo documentation After much consideration, texinfo was chosen for the Hamlib manual. Initially Docbook had been considered and then abandoned. Doxygen generated output from the source files has filled that role since but experience has shown that more explanation would be useful. ASCIIdoc had been considered and while HTML and PDF outputs are possible, GNU info style documentation seems not to be. Texinfo provides for all three and is easily integrated into Automake and enables version and update variables generated by Autotools to be easily integrated into the documentation. The manual is released under the GNU Free Document License with no invariant sections and no cover texts. This meets the current Debian Free Software Guidelines. 2013-02-24 13:37:40 +00:00
			`AM_MAKEINFOHTMLFLAGS = --no-headers --no-split`

don't forget style sheet in dist git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@1486 7ae35d74-ebe9-4afe-98af-79ac388436b8 2003-06-22 19:51:49 +00:00			`doc: hamlib.cfg $(SRCDOCLST)`
workaround for automake/libtool install bug? git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@601 7ae35d74-ebe9-4afe-98af-79ac388436b8 2001-07-21 13:03:13 +00:00			`doxygen hamlib.cfg`
Add empty dvi: target to quell distcheck error 2018-12-13 21:10:42 +00:00
			`# Don't attempt to generate DVI file with 'make distcheck'`
			`dvi:`