Description: Added manpages Origin: Gauche upstream (revision 7036) Reviewed-By: NIIBE Yutaka Last-Update: 2010-03-17 Note that a patch of configure.ac is manually generated. Note that a patch of doc/gauche-install.1.in is manually edited, to avoid a quote (') at the begining of line. Other patches are get by 'svn -r7035:7036 diff'. 2010-02-05 Shiro Kawai * doc/gauche-install.1.in, doc/gauche-package.1.in, doc/gauche-cesconv.1.in: Added these manpages based on the ones provided by Jens Thiele. * doc/gosh.1.in, doc/gauche-config.1.in: Updated. * configure.ac: Changed to process the added manpages. --- gauche-0.9.orig/configure.ac (revision 7035) +++ gauche-0.9/configure.ac (revision 7036) @@ -731,7 +731,8 @@ AC_OUTPUT(Makefile src/Makefile src/genconfig lib/Makefile lib/slib.scm - doc/gosh.1 doc/gauche-config.1 doc/Makefile + doc/gosh.1 doc/gauche-config.1 doc/gauche-cesconv.1 + doc/gauche-install.1 doc/gauche-package.1 doc/Makefile ext/Makefile ext/Makefile.ext ext/auxsys/Makefile ext/binary/Makefile --- gauche-0.9.orig/doc/Makefile.in (revision 7035) +++ gauche-0.9/doc/Makefile.in (revision 7036) @@ -5,7 +5,8 @@ build = @build@ host = @host@ -MANPAGES = gosh.1 gauche-config.1 +MANPAGES = gosh.1 gauche-config.1 gauche-install.1 gauche-package.1 \ + gauche-cesconv.1 EXTRACTED = gauche-refe.texi gauche-refj.texi \ gauche-deve.texi gauche-devj.texi GENERATED = Makefile $(MANPAGES) --- gauche-0.9.orig/doc/gauche-package.1.in (revision 0) +++ gauche-0.9/doc/gauche-package.1.in (revision 7036) @@ -0,0 +1,98 @@ +.\" -*-nroff-*- +.TH "GAUCHE\-PACKAGE" "1" "" "Gauche @GAUCHE_VERSION@" "Gauche Commands" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +gauche-package \- gauche package builder/manager +.SH "SYNOPSIS" +.HP 15 +\fBgauche\-package\fR \fB\fICOMMAND\fR\fR [\fB\fIOPTION\fR\fR...] [\fB\fIARGS\fR\fR...] +.SH "DESCRIPTION" +.PP +This manual page documents briefly the +\fBgauche\-package\fR +command\&. +.PP +This manual page was written for the Debian distribution because the original program does not have a manual page\&. Instead, it has documentation in the GNU +\fBinfo\fR(1) +format; see below\&. +.PP +\fBgauche\-package\fR +is a program to create, download, compile, install and list gauche extension packages\&. +.SH "COMMANDS" +.PP +A summary of commands is included below\&. For a complete description, see the +\fBinfo\fR(1) +files and the output of the help command\&. +.PP +\fBbuild\fR +.RS 4 +Fetch and build package\&. +.RE +.PP +\fBcompile\fR +.RS 4 +Compile and link an extension module from sources\&. +.RE +.PP +\fBgenerate\fR +.RS 4 +Generate template source tree for a new Gauche extension\&. +.RE +.PP +\fBhelp\fR +.RS 4 +Show detailed help\&. +.RE +.PP +\fBinstall\fR +.RS 4 +Fetch, build and install package\&. +.RE +.PP +\fBlist\fR +.RS 4 +List known installed packages\&. +.RE +.PP +\fBmake\-gpd\fR +.RS 4 +Make gpd file (called from the configure script)\&. +.RE +.PP +\fBreconfigure\fR +.RS 4 +Show configure options of package\&. +.RE +.SH "DIAGNOSTICS" +.PP +\fBgauche\-package\fR +exits with status 0 on success\&. +.SH "SEE ALSO" +.PP +The program is (will be?) documented fully by the +Gauche Developers\' Reference +and the +rference manual of Gauche +available via the +\fBinfo\fR(1) +system and provides usage information via the help command\&. +.SH "AUTHORS" +.PP +\fBShiro Kawai\fR <\&shiro@acm\&.org\&> +.sp -1n +.IP "" 4 +Author. +.PP +\fBJens Thiele\fR <\&karme@karme\&.de\&> +.sp -1n +.IP "" 4 +Wrote this manpage for the Debian system\&. +.SH "COPYRIGHT" +Copyright \(co 2010 Jens Thiele +.br +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved\&. This file is offered as\-is, without any warranty\&. +.sp --- gauche-0.9.orig/doc/gauche-cesconv.1.in (revision 0) +++ gauche-0.9/doc/gauche-cesconv.1.in (revision 7036) @@ -0,0 +1,88 @@ +.\" -*-nroff-*- +.TH "GAUCHE\-CESCONV" "1" "" "Gauche @GAUCHE_VERSION@" "Gauche Commands" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +gauche-cesconv \- convert text from one character encoding scheme to another +.SH "SYNOPSIS" +.HP 15 +\fBgauche\-cesconv\fR [\fB\-h\fR] [\fB\-f\fR\ \fIencoding\fR] [\fB\-t\fR\ \fIencoding\fR] [\fB\-o\fR\ \fIoutfile\fR] [\fIinfile\fR] +.SH "DESCRIPTION" +.PP +The +\fBgauche\-cesconv\fR +command is a program to convert text from one character encoding scheme (CES) +to another\&, using Gauche's character conversion module. +Hence the supported character sets are the same as Gauche's. +See the info document of Gauche for more details. +.PP +There are other commands that provide the same functionality and more, +such as iconv(1) or nkf(1), but they are not universally available +by default. +This command is provided for Gauche's external packages to ease +the installation and configuration process; for those packages, +it is certain that gauche-cesconv is available, so they don't +need to check availability of iconv etc. +.PP +When +\fIinfile\fR +is omitted, the text is read from standard input\&. +.SH "OPTIONS" +.PP +\fB\-f\fR, \fB\-\-from\-code=\fR\fB\fIencoding\fR\fR +.RS 4 +Selects input encoding\&. Can be \'*JP\' to guess the +character encoding from japanese text, +among either ISO2022\-JP(\-1,2,3), EUCJP, SHIFT_JIS or UTF\-8\&. +If omitted, gauche\'s native CES is used\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Show summary of options\&. +.RE +.PP +\fB\-o\fR, \fB\-\-output=\fR\fB\fIoutfile\fR\fR +.RS 4 +Place output in file +\fIoutfile\fR\&. If omitted the converted text is written to standard output\&. +.RE +.PP +\fB\-t\fR, \fB\-\-to\-code=\fR\fB\fIencoding\fR\fR +.RS 4 +Selects output encoding\&. (see also +\fB\-\-from\-code\fR) +.RE +.SH "DIAGNOSTICS" +.PP +\fBgauche\-cesconv\fR +exits with status 0 on success\&. +.SH "SEE ALSO" +.PP +\fBgauche-package\fR(1), +\fBiconv\fR(1) +.PP +The program will be documented fully by the +Gauche Developers\' Reference +available via the +\fBinfo\fR(1) +system\&. +.SH "AUTHORS" +.PP +\fBShiro Kawai\fR <\&shiro@acm\&.org\&> +.sp -1n +.IP "" 4 +Author. +.PP +\fBJens Thiele\fR <\&karme@karme\&.de\&> +.sp -1n +.IP "" 4 +Wrote this manpage for the Debian system\&. +.SH "COPYRIGHT" +Copyright \(co 2010 Jens Thiele +.br +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved\&. This file is offered as\-is, without any warranty\&. +.sp --- gauche-0.9.orig/doc/gauche-config.1.in (revision 7035) +++ gauche-0.9/doc/gauche-config.1.in (revision 7036) @@ -1,6 +1,5 @@ -.\" $Id: gauche-config.1.in,v 1.3 2006-11-11 20:45:17 shirok Exp $ -*-nroff-*- -.TH GOSH "version @GAUCHE_VERSION@" -.UC 4 +.\" -*-nroff-*- +.TH GAUCHE\-CONFIG "1" "" "Gauche @GAUCHE_VERSION@" "Gauche Commands" .SH NAME gauche-config \- retrieve configuration parameters of Gauche .SH SYNOPSIS @@ -22,6 +21,8 @@ .TP .B --reconfigure Prints the command line used to configure the current Gauche installation. +It is pretty handy to configure another Gauche source tree with the same +configuration; just type `gauche-config --reconfigure | sh'. .SS Parameters to compile an application using Gauche .TP @@ -43,22 +44,41 @@ .SS Parameters to install files .TP -.B --syslibdir, --sitelibdir -Directories where system/site scheme files go. +.B --syslibdir, --sysarchdir, --sysincdir +Directories where the Gauche core system's Scheme files, +architecture-dependent files, and header files are installed, +respectively. +These directories belong to Gauche core; additional packages +should not put files in them. .TP -.B --sysarchdir, --sitearchdir -Directories where architecture-dependent system/site files go. +.B --sitelibdir, --sitearchdir, --siteincdir +Directories where the additional packages will put +Scheme files, architecture-dependent files, and +header files, respectively. .TP -.B --sysincdir, --siteincdir -Directories where system/site header files of extensions go. +.B --pkglibdir, --pkgarchdir, --pkgincdir +Same as --sitelibdir etc, except that the base directory name +is left as `${datadir}'. The result is suitable to be embedded +in Makefiles, for the base directory could be overridden at +build time rather than configure time. The default template for +Gauche extension packages use these options. .TP .B --mandir, --infodir Directories where gauche manpage and info docs are installed. -.SH Parameters to compile Gauche extention +.SS Parameters to compile Gauche extention .TP +.B --object-suffix +Extension of the compiled objects (e.g. 'o'). +.TP +.B --executable-suffix +Suffix of the executable (usually empty on Unix variants, +and '.exe' on Windows. Note that '.' is a part of suffix in +this option, as opposed to other -suffix options. +.TP .B --so-suffix -Object file suffix of the gauche extension. +Extension of the dynamically loadable (dlopen-able) modules +(e.g. 'so' or 'dll'). .TP .B --so-cflags Flags required to compile shared object. @@ -70,11 +90,18 @@ Libraries to be linked with a gauche extension. .TP .B --dylib-suffix -Dynamic/shared library file suffix of the system. +Suffix for dynamically linked libraries. Some unix variants +require special suffix (such as 'dylib'). On other platforms +this is the same as '--so-suffix'. .TP .B --dylib-ldflags -Flags required to link dynamic/shared library file. +Flags required to link dynamically linked library file. +Some unix variants require special flags. On other platforms +this is the same as '--so-ldflags'. .TP +.B --rpath-flag +Compler flag(s) to embed RPATH in the binary. +.TP .B --libgauche-so The name of shared library of libgauche. @@ -82,9 +109,9 @@ Shiro Kawai (shiro @ acm . org) .SH SEE ALSO -gosh(1) +gosh(1), gauche-package(1) .PP -Gauche Scheme interpreter: +Gauche Scheme script engine: .br http://practical-scheme.net/gauche/ --- gauche-0.9.orig/doc/gosh.1.in (revision 7035) +++ gauche-0.9/doc/gosh.1.in (revision 7036) @@ -1,6 +1,5 @@ -.\" $Id: gosh.1.in,v 1.4 2006-11-11 20:45:17 shirok Exp $ -*-nroff-*- -.TH GOSH "version @GAUCHE_VERSION@" -.UC 4 +.\" -*-nroff-*- +.TH "GOSH" "1" "" "Gauche @GAUCHE_VERSION@" "Gauche Commands" .SH NAME gosh \- a Scheme script interpreter .SH SYNOPSIS @@ -37,7 +36,7 @@ .I Gosh is a stand-alone Scheme interpreter built on top of the .I Gauche -Scheme implementation. +Scheme script engine. When .I script @@ -73,7 +72,7 @@ Command line options are processed before loading the script file or entering the interactive mode. -The options -I, -A, -u, -l, -e and -E are processed in the order +The options -I, -A, -u, -l, -L, -e and -E are processed in the order of appearance. For example, adding a load path by -I option affects the -l options after it, but not the ones before it. @@ -113,6 +112,11 @@ Loads a Scheme file .I file. .TP +.BI -L file +Like -l, but doesn't complain if +.I file +doesn't exist. +.TP .BI -e expr Evaluates a Scheme expression .I expr. @@ -122,13 +126,28 @@ .I expr is read as if it is surrounded by parenthesis. .TP +.BI -p type +Turns on the profiler. Currently +.I type +can only be 'time'. +.TP .BI -f flag Sets various flags. - no-inline don't inline primitive procedures - no-source-info don't preserve source information for debug + case-fold uses case-insensitive reader (as in R5RS) load-verbose report while loading files - case-fold uses case-insensitive reader (as in R5RS) + no-inline don't inline primitive procedures and constants + (combined no-inline-globals, no-inline-locals, and + no-inline-constants.) + no-inline-globals don't inline global procedures. + no-inline-locals don't inline local procedures. + no-inline-constants don't inline constants. + no-post-inline-pass don't run post-inline optimization pass. .TP +.BI -F feature +Makes +.I feature +available in cond-expand forms. +.TP .BI -- Specifies that there are no more options. If there are more arguments after this, they are taken as script file name and @@ -153,7 +172,7 @@ .SH SEE ALSO gauche-config(1) .PP -Gauche Scheme interpreter: +Gauche Scheme script engine: .br http://practical-scheme.net/gauche/ .PP --- gauche-0.9.orig/doc/gauche-install.1.in (revision 0) +++ gauche-0.9/doc/gauche-install.1.in (revision 7036) @@ -0,0 +1,188 @@ +.\" -*-nroff-*- +.TH "GAUCHE\-INSTALL" "1" "" "Gauche @GAUCHE_VERSION@" "Gauche Commands" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +gauche-install \- install files and set attributes +.SH "SYNOPSIS" + 1)* \fBgauche\-install\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR \fB\fIDEST\fR\fR + 2)* \fBgauche\-install\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR... \fB\fIDIRECTORY\fR\fR + 3)* \fBgauche\-install\fR \fB\-d\fR [\fB\fIOPTION\fR\fR...] \fB\fIDIRECTORY\fR\fR... + 4) \fBgauche\-install\fR \fB\-T\fR \fIDIRECTORY\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR... + 5) \fBgauche\-install\fR \fB\-U\fR \fIDIRECTORY\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR... +.SH "DESCRIPTION" +.PP +\fBgauche\-install\fR +is a program to install and remove files\&. +On installation it allows to set ownership and permissions\&. +This command is upward compatible with BSD install(1) and can be +used as a drop-in replacement of it. Notably, +1st, 2nd and 3rd command-line format above are compatible with BSD install. +.PP +This command is provided mainly for Gauche's extension packages +to have simpler installation and configuration process. Being certain +that gauche\-install is available, those packages don't need to +worry about subtle differences between various install(1) commands. +.PP +The first format copies +.I FILE +on the file or in the directory named by +.I DEST\&. +The second format copies +.I FILE ... +into the directory +.IR DIRECTORY . +.PP +The third format ensures +.I DIRECTORY +exists. If it doesn't, the command creates the path to the +.I DIRECTORY , +including any intermediate ones. +.PP +The fourth format installing +.I FILE ... +to the +.IR DIRECTORY . +It is more convenient than the first and second formats in +the following regards: +.IP "" 3 +* If the destination directory does not exist, it is created +(with any intermediate paths as needed). +.IP "" 3 +* The list of files can be empty, so that when the list of +installed files can be generated by configuration, you don't +need to handle the empty case specially in Makefile. +(With BSD install format, empty file list yields an error.) +.IP "" 3 +* The directory prefix of files are preserved within the +destination directory. This is handy to install subtree of files. +For example, the following command installs '/usr/share/foo/main', '/usr/share/foo/conf/x' and '/usr/share/foo/conf/y' with a +single command. + + gauche-install -T /usr/share/foo main conf/x conf/y + +Giving \fB\-p\fR option suppresses this behavior and +strips any directory prefix like the second format. The +following command line installs '/usr/share/foo/main', '/usr/share/foo/x' and '/usr/share/foo/y'. + + gauche-install -T /usr/share/foo -p main conf/x conf/y +.PP +The fifth format removes +.I FILE ... +in the +.IR DIRECTORY . +Irrelevant options are ignored, so it is handy to uninstall +files just by chaning \fB\-T\fR in the fourth format to \fB\-U\fR. +.SH "OPTIONS" +.PP +\fB\-C\fR, \fB\-\-canonical\-suffix\fR +.RS 4 +This is used specially to install Gauche's autogenerated +Scheme source by experimental precompilation. The generated file +has a *\&.sci. Upon installation, this command replaces the suffix +for *\&.scm\&. +.RE +.PP +\fB\-d\fR, \fB\-\-directory\fR +.RS 4 +Creates directories\&. (3rd format only)\&. It is only for the compatibility. +Using the \fB\-T\fR option, the destination directories are created +automatically if missing. +.RE +.PP +\fB\-g\fR, \fB\-\-group=\fR\fIGROUP\fR +.RS 4 +Change group of the installed file\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Show summary of options\&. +.RE +.PP +\fB\-m\fR, \fB\-\-mode=\fR\fIMODE\fR +.RS 4 +Change mode of the installed file\&. +.RE +.PP +\fB\-n\fR, \fB\-\-dry\-run\fR +.RS 4 +Just prints what actions to be done\&. +.RE +.PP +\fB\-o\fR, \fB\-\-owner=\fR\fIOWNER\fR +.RS 4 +Change owner of the installed file\&. +.RE +.PP +\fB\-p\fR, \fB\-\-strip\-prefix=\fR\fIPREFIX\fR +.RS 4 +Strip +\fIPREFIX\fR +directories from +\fIFILE\fR(s) before installation\&. (4th/5th format only)\&. +.RE +.PP +\fB\-\-shebang=\fR\fB\fIPATH\fR\fR +.RS 4 +Adds #!PATH before the file contents\&. Useful to install scripts\&. +.RE +.PP +\fB\-S\fR, \fB\-\-srcdir=\fR\fB\fIdirectory\fR\fR +.RS 4 +Look for files within \fIdirectory\fR; useful if VPATH is used +in Makefiles. +.RE +.PP +\fB\-T\fR, \fB\-\-target=\fR\fB\fIdirectory\fR\fR +.RS 4 +Installs files to the +\fIdirectory\fR, creating paths if needed\&. +Partial path of files are preserved unless \fB\-p\fR option is given\&. +(4th format only) +.RE +.PP +\fB\-U\fR, \fB\-\-uninstall=\fR\fB\fIdirectory\fR\fR +.RS 4 +Reverse of +\fB\-T\fR, e\&.g\&. removes files from its destination\&. +Other options (except \fB\-h\fR and \fB\-n\fR) are ignored. +.RE +.PP +\fB\-v\fR, \fB\-\-verbose\fR +.RS 4 +Work verbosely\&. +.RE +.SH "DIAGNOSTICS" +.PP +\fBgauche\-install\fR +exits with status 0 on success\&. +.SH "SEE ALSO" +.PP +\fBgauche-package\fR(1), +\fBinstall\fR(1) +.PP +The program will be documented fully by the +Gauche Developers\' Reference +available via the +\fBinfo\fR(1) +system\&. +.SH "AUTHORS" +.PP +\fBShiro Kawai\fR <\&shiro@acm\&.org\&> +.sp -1n +.IP "" 4 +Author. +.PP +\fBJens Thiele\fR <\&karme@karme\&.de\&> +.sp -1n +.IP "" 4 +Wrote this manpage for the Debian system\&. +.SH "COPYRIGHT" +Copyright \(co 2010 Jens Thiele +.br +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved\&. This file is offered as\-is, without any warranty\&. +.sp