From 0d0e0b96ce1fec53eb184a33a86657952cba2fea Mon Sep 17 00:00:00 2001 From: Matt Birkholz Date: Mon, 6 Mar 2017 21:01:53 -0700 Subject: [PATCH] doc: Use default htmldir, pdfdir, etc. Rename updated manpage. 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 | 3 +- doc/configure.ac | 18 ++++------ doc/make-common.in | 1 + doc/{scheme.1 => mit-scheme.1} | 63 ++++++++++++++++++++-------------- 4 files changed, 46 insertions(+), 39 deletions(-) rename doc/{scheme.1 => mit-scheme.1} (52%) diff --git a/doc/Makefile.in b/doc/Makefile.in index d40b2f793..3bd9c2b22 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -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) diff --git a/doc/configure.ac b/doc/configure.ac index 289523b19..5164662f5 100644 --- a/doc/configure.ac +++ b/doc/configure.ac @@ -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" diff --git a/doc/make-common.in b/doc/make-common.in index dcbce8d94..91724bb48 100644 --- a/doc/make-common.in +++ b/doc/make-common.in @@ -56,6 +56,7 @@ mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs # **** END BOILERPLATE **** +docdir = @docdir@ htmldir = @htmldir@ pdfdir = @pdfdir@ psdir = @psdir@ diff --git a/doc/scheme.1 b/doc/mit-scheme.1 similarity index 52% rename from doc/scheme.1 rename to doc/mit-scheme.1 index 81e9464d1..f013a408e 100644 --- a/doc/scheme.1 +++ b/doc/mit-scheme.1 @@ -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 +The MIT/GNU Scheme Team .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 -- 2.25.1