doc: Use default htmldir, pdfdir, etc. Rename updated manpage.
authorMatt Birkholz <matt@birchwood-abbey.net>
Tue, 7 Mar 2017 04:01:53 +0000 (21:01 -0700)
committerMatt Birkholz <matt@birchwood-abbey.net>
Tue, 7 Mar 2017 04:23:14 +0000 (21:23 -0700)
Define docdir, part of the default htmldir, pdfdir, etc.

Replace \- (minus) with - (hyphen) in the manpage.  (This was an old,
aesthetic choice?)

doc/Makefile.in
doc/configure.ac
doc/make-common.in
doc/mit-scheme.1 [moved from doc/scheme.1 with 52% similarity]

index d40b2f793eb52b5d91cf004d8e91c99b8ad11f45..3bd9c2b221dcd0358e24b34b0a8fb91e43046dfd 100644 (file)
@@ -44,6 +44,7 @@ libdir = @libdir@
 infodir = @infodir@
 mandir = @mandir@
 includedir = @includedir@
+docdir = @docdir@
 oldincludedir = /usr/include
 
 DESTDIR =
@@ -116,7 +117,7 @@ install-info-gz install-info:
 
 install-man:
        $(mkinstalldirs) $(DESTDIR)$(mandir)/man1
-       $(INSTALL_DATA) scheme.1 $(DESTDIR)$(mandir)/man1/.
+       $(INSTALL_DATA) mit-scheme.1 $(DESTDIR)$(mandir)/man1/.
 
 install-html:
        $(mkinstalldirs) $(DESTDIR)$(htmldir)
index 289523b194f62b418519aaa77904acbb1e9f7543..5164662f520f0cba621ed2e18d1d98265d0d12b0 100644 (file)
@@ -1,7 +1,7 @@
 dnl Process this file with autoconf to produce a configure script.
 
 AC_INIT([MIT/GNU Scheme documentation],
-       [9.2],
+       [9.2.1],
        [bug-mit-scheme@gnu.org],
        [mit-scheme-doc])
 AC_CONFIG_SRCDIR([ref-manual/scheme.texinfo])
@@ -44,11 +44,9 @@ INST_TARGETS=
 
 AC_ARG_ENABLE([html],
        [AC_HELP_STRING([--enable-html], [generate HTML documentation])])
-if test "${enable_html:-yes}" = "yes"; then
-    htmldir="${libdir}/mit-scheme/doc"
-elif test "${enable_html}" = "no"; then
+if test "${enable_html}" = "no"; then
     htmldir=
-else
+elif test "${enable_html:-yes}" != "yes"; then
     htmldir="${enable_html}"
 fi
 test "${htmldir}" = "" || TARGETS="${TARGETS} \$(TARGET_ROOT)/index.html"
@@ -57,11 +55,9 @@ AC_SUBST([htmldir])
 
 AC_ARG_ENABLE([pdf],
        [AC_HELP_STRING([--enable-pdf], [generate PDF documentation])])
-if test "${enable_pdf:-yes}" = "yes"; then
-    pdfdir="${libdir}/mit-scheme/doc"
-elif test "${enable_pdf}" = "no"; then
+if test "${enable_pdf}" = "no"; then
     pdfdir=
-else
+elif test "${enable_pdf:-yes}" != "yes"; then
     pdfdir="${enable_pdf}"
 fi
 test "${pdfdir}" = "" || TARGETS="${TARGETS} \$(TARGET_ROOT).pdf"
@@ -72,9 +68,7 @@ AC_ARG_ENABLE([ps],
        [AC_HELP_STRING([--enable-ps], [generate Postscript documentation])])
 if test "${enable_ps:-no}" = "no"; then
     psdir=
-elif test "${enable_ps}" = "yes"; then
-    psdir="${libdir}/mit-scheme/doc"
-else
+elif test "${enable_ps}" != "yes"; then
     psdir="${enable_ps}"
 fi
 test "${psdir}" = "" || TARGETS="${TARGETS} \$(TARGET_ROOT).ps"
index dcbce8d9403d7ffdb1b016afbef7c7869338592f..91724bb48dbe8949b2251675b56cf68054003f12 100644 (file)
@@ -56,6 +56,7 @@ mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
 
 # **** END BOILERPLATE ****
 
+docdir = @docdir@
 htmldir = @htmldir@
 pdfdir = @pdfdir@
 psdir = @psdir@
similarity index 52%
rename from doc/scheme.1
rename to doc/mit-scheme.1
index 81e9464d171d7941e3ccb004e594467e14681412..f013a408edebb1612f64f6c6caafceb4ce191796 100644 (file)
@@ -1,74 +1,85 @@
-.TH "scheme" "1" "9.2" "MIT/GNU Scheme Team" ""
+.TH "mit-scheme" "1" "9.2" "MIT/GNU Scheme Team" ""
 .SH "NAME"
-.LP 
-MIT/GNU Scheme \- Scheme development environment
+.LP
+mit-scheme - The MIT/GNU Scheme development environment
 .SH "SYNOPSIS"
 .LP 
-.B scheme
+.B mit-scheme
 .RI [ OPTIONS ]
 .br 
 .SH "DESCRIPTION"
 .LP 
 MIT/GNU Scheme is an implementation of the Scheme programming
-language, providing an interpreter, compiler, source\-code debugger,
-integrated Emacs\-like editor, and a large runtime library.  MIT/GNU
+language, providing an interpreter, compiler, source-code debugger,
+integrated Emacs-like editor, and a large runtime library.  MIT/GNU
 Scheme is best suited to programming large applications with a rapid
 development cycle.
 .SH "OPTIONS"
 .LP 
-These are some of the more common command\-line options.  For full
+These are some of the more common command-line options.  For full
 information about available options, see the Texinfo documentation.
 Additional options may also be supported by the band.  Use the
-\-\-help option (last) to see descriptions of all available
-command\-line options.
+--help option (last) to see descriptions of all available
+command-line options.
 .TP 
-.RI \-\-version
+.RI --version
 .br 
 Report various version numbers, then exit.
 .TP 
-.RI \-\-heap " NBLOCKS"
+.RI --heap " NBLOCKS"
 .br 
-Specify the size of the heap in 1024\-word blocks.
+Specify the size of the heap in 1024-word blocks.
 .TP 
-.RI \-\-stack " NBLOCKS"
+.RI --stack " NBLOCKS"
 .br 
-Specify the size of the stack in 1024\-word blocks.
+Specify the size of the stack in 1024-word blocks.
 .TP 
-.RI \-\-library " PATH"
+.RI --library " PATH"
 .br 
 Specify where to look for Scheme's binary files.
 .I PATH
-should be a colon\-separated list of directory names.
+should be a colon-separated list of directory names.
 .TP 
-\-\-option\-summary
+--option-summary
 .br 
 Print the actual values of the machine parameters (like those above).
 .TP 
-\-\-no\-init\-file
+--no-init-file
 .br 
-Don't load the user's init file (~/.scheme.init or scheme.ini).
+Don't load the user's init file.
 .TP 
-\-\-edit
+--edit
 .br 
 Start the text editor after starting Scheme.
 .TP 
-.RI \-\-eval " EXPRESSION" ...
+.RI --eval " EXPRESSION" ...
 .br 
 Evaluate the specified expressions after starting Scheme.
 .TP 
-.RI \-\-load " FILENAME" ...
+.RI --load " FILENAME" ...
 .br 
 Load the specified files after starting Scheme.
 .SH "FILES"
-.LP 
-\fI/usr/local/lib/mit\-scheme\fP 
+.TP 
+\fI.scheme.init\fP or \fISCHEME.INI\fP
+.br
+Scheme loads this file first, if it exists in the user's home directory.
 .SH "ENVIRONMENT VARIABLES"
 .LP 
 MIT/GNU Scheme refers to a large number of environment variables.  See
 the Texinfo documentation for details.
+.SH "EXAMPLES"
+.LP 
+To use the evaluator in a command-line interface, type:
+.LP 
+.B mit-scheme
+.LP 
+To start the editor and use it as a front-end to the evaluator, type:
+.LP 
+.B mit-scheme --edit
 .SH "AUTHORS"
 .LP 
-MIT/GNU Scheme Team <bug\-mit\-scheme@gnu.org>
+The MIT/GNU Scheme Team <bug-mit-scheme@gnu.org>
 .SH "SEE ALSO"
 .LP
 The full documentation for MIT/GNU Scheme is maintained as a set of
@@ -80,7 +91,7 @@ program is properly installed at your site, the command
 .B info
 "MIT/GNU Scheme User"
 .PP
-should give you access to the complete User's manual.  Programming
+should give you access to the complete user's manual.  Programming
 information is located in the Info topics "MIT/GNU Scheme Ref" and
 "SOS".  Usage of the
 .B IMAIL