[PATCH] Add clisp-link manual page
|
View:
New views
2 Messages
—
Rating Filter:
Alert me
|
 |
[PATCH] Add clisp-link manual page
by Luca Capello
::
Rate this Message:
Hi all!
Since Debian requires that every binary installed on the system has a corresponding manual page, here attached is my first try for clisp-link, modelled after doc/_clisp.1 and [1]. It'll be included in the next Debian version [2]. The original patch targets 2.44.1 since the next Debian stable release, lenny [3], will ship with this version [4]. I ported it to the latest CVS, but I haven't tested it yet, sorry. Comments welcome! Thx, bye, Gismo / Luca Footnotes: [1] http://clisp.podval.org/impnotes/modules.html#mod-overview [2] http://git.debian.org/?p=pkg-common-lisp/clisp.git;a=commitdiff;h=a6998ffb9c2b975926b02455bbd91b73276de41b [3] http://wiki.debian.org/DebianLenny [4] we're freezing this week [5], so I don't have time to update CLISP to the latest released version, sorry [5] http://lists.debian.org/debian-devel-announce/2008/07/msg00005.html --8<---------------cut here---------------start------------->8--- diff -Naur clisp.ORG/doc/_clisp-link.1 clisp/doc/_clisp-link.1 --- clisp.ORG/doc/_clisp-link.1 1970-01-01 01:00:00.000000000 +0100 +++ clisp/doc/_clisp-link.1 2008-07-21 01:02:42.000000000 +0200 @@ -0,0 +1,75 @@ +.\" -*- nroff -*- +.\" +.\" Copyright (c) 2008 Luca Capello <luca@...> + +.TH "CLISP-LINK" "1" "Last modified: 2008\-07\-20" "CLISP 2.44" "Platform: @PLATFORM@" + +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l + +.SH "NAME" +clisp-link - CLISP facility for adding external modules + +.SH "SYNOPSIS" +.HP 6 +\fBclisp\fR {[\fBlink\fR \fIlink\fR \fIdir\fR] | [\fBcreate-module-set\fR \fImodule-dir\fR \fIfile1.c\fR \.\.\.] | [\fBadd-module-set\fR \fImodule-dir\fR \fIsource-dir\fR \fIdestination-dir\fR] | [\fBadd-module-sets\fR \fIsource-dir\fR \fIdestination-dir\fR \fImodule-dir\fR] | [\fBrun\fR \fIsource-dir\fR \fImodule-dir\fR \.\.\.]} + +.SH "DESCRIPTION" +.PP +Invokes \fBclisp\fR(1) to add an external module (written in C, for +example)\. + +.SH "OPTIONS" +.PP +\fBlink\fR \fIlink\fR \fIdir\fR +.RS 4 +Makes link from \fIlink\fR to \fIdir\fR. +.RE +.PP +\fBcreate-module-set\fR \fImodule-dir\fR \fIfile1.c\fR \.\.\. +.RS 4 +Creates a module set in \fImodule-dir\fR which refers (via symbolic links) to \fIfile1.c\fR etc\. The files are expected to be modules of their own\. +.RE +.PP +\fBadd-module-set\fR \fImodule-dir\fR \fIsource-dir\fR \fIdestination-dir\fR +.RS 4 +Combines a linking set in \fIsource-dir\fR and a module in \fImodule-dir\fR to a new linking set, in the \fIdestination\fR which is newly created\. +.RE +.PP +\fBadd-module-sets\fR \fIsource-dir\fR \fIdestination-dir\fR \fImodule-dir\fR +.RS 4 +Functionally the same as multiple \fBadd-module-set\fR commands, but it is faster and require less disk spaces\. +.RE +.PP +\fBrun\fR \fIsource-dir\fR \fImodule-dir\fR \.\.\. +.RS 4 +Runs the linking set in \fIsource-dir\fR, with the module in \fImodule-dir\fR loaded\. More than one module can be specified\. If \fBclisp\fR(1) has been built with the configuration option \fI--with-dynamic-modules\fR, the loading will be performed dynamically\. Otherwise - this is much slower - a temporary linking set will be created and deleted afterwards\. + +.SH "AUTHORS" +.PP +\fBBruno Haible\fR <\&\fI\%http://www.haible.de/bruno/\fR\&> +.sp -1n +.IP "" 4 +Author\. +.PP +\fBMichael Stoll\fR <\&\fI\%http://www.faculty.iu-bremen.de/mstoll/\fR\&> +.sp -1n +.IP "" 4 +Author\. +.PP +\fBSam Steingold\fR <\&\fI\%http://sds.podval.org/\fR\&> +.sp -1n +.IP "" 4 +Author\. +.PP +\fBclisp\fR(1) is licensed under the terms of the GNU General Public License (GPL), version 2\. See \fICOPYRIGHT\fR (file in the CLISP sources) for the list of other contributors and the full text of the license\. +.PP +This manual page was written by Luca Capello <luca@...> for the +Debian clisp package and is licensed under the terms of the GNU +General Public License (GPL), version 2\. + +.SH "COPYRIGHT" +.PP +This manual page is Copyright \(co 2008 Luca Capello <luca@...>\. diff -Naur clisp.ORG/doc/Makefile clisp/doc/Makefile --- clisp.ORG/doc/Makefile 2008-07-21 01:01:46.000000000 +0200 +++ clisp/doc/Makefile 2008-07-21 01:03:45.000000000 +0200 @@ -166,6 +166,12 @@ _clisp.1: clisp.1 sed $(ROFF_UNCOMMENT) $< > $@ +clisp-link.1: clisp.xml $(GEN_DEPS) man.xsl $(OLINK) + $(XMLOUT) "olink-pile.xml" $(DOC_MAN) -o $@ man.xsl $< + +_clisp-link.1: clisp-link.1 + sed $(ROFF_UNCOMMENT) $< > $@ + impnotes.xml: impnotes.xml.in $(IMPNOTES) ../version.sh Makefile $(RM) $@ $(FILLIN) $< > $@ @@ -185,9 +191,9 @@ (test -n "$(DIST)" && rsync -av impnotes.html \ impnotes.css $(DIST)/) || true -man: _clisp.html _clisp.1 - (cd ../build && make clisp.html clisp.1 && \ - test -n "$(DIST)" && rsync -av clisp.1 clisp.html $(DIST)/) || true +man: _clisp.html _clisp.1 _clisp-link.1 + (cd ../build && make clisp.html clisp.1 clisp-link.1 && \ + test -n "$(DIST)" && rsync -av clisp.1 clisp-link.1 clisp.html $(DIST)/) || true impnotes.fo: impnotes.xml $(IMPNOTES) fo.xsl $(XSL_TARGET) $(XMLOUT) "olink-pile.xml" $(DOC_IMP) -o $@ fo.xsl $< @@ -229,7 +235,7 @@ clean: force $(RM) impnotes.xml impnotes.texi impnotes.html impnotes.pdf html \ - clisp.xml clisp.html clisp.1 *.tdb $(CATALOG_FILE) impnotes.fo \ + clisp.xml clisp.html clisp.1 clisp-link.1 *.tdb $(CATALOG_FILE) impnotes.fo \ id-href.map count: $(IMPNOTES) diff -Naur clisp.ORG/src/makemake.in clisp/src/makemake.in --- clisp.ORG/src/makemake.in 2008-07-21 01:01:46.000000000 +0200 +++ clisp/src/makemake.in 2008-07-21 01:18:07.000000000 +0200 @@ -1739,7 +1739,7 @@ DOC='LISP-tutorial CLOS-guide editors' -TXT_FILES='README README.de README.es clisp.1 clisp.html clisp-1.html clisp.c' +TXT_FILES='README README.de README.es clisp-link.1 clisp.1 clisp.html clisp-1.html clisp.c' if [ $CROSS = false -a $HOS = unix ] ; then TXT_FILES=$TXT_FILES' distmakefile' fi @@ -3358,7 +3358,7 @@ IMPNOTES_FILES=${IMPNOTES_FILES}" clisp.ico" fi echol "IMPNOTES_FILES = ${IMPNOTES_FILES}" -echol "MANUALS = clisp.1 clisp.html \$(TXTFILES) \$(IMPNOTES_FILES)" +echol "MANUALS = clisp-link.1 clisp.1 clisp.html \$(TXTFILES) \$(IMPNOTES_FILES)" echol for f in ${IMPNOTES_FILES} ; do echol "${f} : ${SRCDOCDIR_M}${f}" @@ -3421,7 +3421,7 @@ fi platform_line="" case $f in - clisp.html | clisp.1 | clisp-1.html) + clisp.html | clisp-link.1 | clisp.1 | clisp-1.html) if [ $HOS = win32 ]; then platform_line=" | sed -e \"s,@PLATFORM@,${TSYS},g\"" else platform_line=" | sed -e \"s,@PLATFORM@,${host},g\"" @@ -3442,7 +3442,7 @@ echotab_to_HEXE "\$(CC) \$(CPPFLAGS) \$(CFLAGS)${flags} \$(CLFLAGS)${XCC_NOOPTFLAGS}" "txt.c" "txt" fi line="${HERE}txt" - if [ $f = clisp.1 ] ; then + if [ $f = clisp-link.1 -o $f = clisp.1 ] ; then line=$line" | \$(GREP) -v ${ARGQ1}^ *\$\$${ARGQ1}" fi # clisp-1.html is for chunked impnotes and does not depend on user hyperspec @@ -3604,12 +3604,13 @@ echotab "\$(INSTALL_DATA) ${SRCTOPDIR}emacs/$f \$(DESTDIR)\$(vimdir)/$f" done echol - echol "install-man : clisp.1 ${manual_dvi} clisp.html force" + echol "install-man : clisp-link.1 clisp.1 ${manual_dvi} clisp.html force" echotab "mkdir -p \$(DESTDIR)\$(prefix)" echotab "mkdir -p \$(DESTDIR)\$(exec_prefix)" echotab "mkdir -p \$(DESTDIR)\$(datarootdir)" echotab "mkdir -p \$(DESTDIR)\$(mandir)" echotab "mkdir -p \$(DESTDIR)\$(mandir)/man1" + echotab "\$(INSTALL_DATA) clisp-link.1 \$(DESTDIR)\$(mandir)/man1/clisp-link.1" echotab "\$(INSTALL_DATA) clisp.1 \$(DESTDIR)\$(mandir)/man1/clisp.1" case "$fsstnd" in gnu_ext) @@ -3672,6 +3673,7 @@ fi echol echol "uninstall-man : force" + echotab "\$(RM) \$(DESTDIR)\$(mandir)/man1/clisp-link.1" echotab "\$(RM) \$(DESTDIR)\$(mandir)/man1/clisp.1" case "$fsstnd" in gnu_ext) @@ -3821,7 +3823,7 @@ echotab "mkdir \$(TOPDIR)/data" echotab "${HLN} data/* \$(TOPDIR)/data/" echotab "mkdir \$(TOPDIR)/doc" -echotab "${HLN} clisp.1 clisp.man ${manual_dvi} clisp.html \$(TXTFILES) \$(IMPNOTES_FILES) \$(TOPDIR)/doc/" +echotab "${HLN} clisp-link.1 clisp.1 clisp.man ${manual_dvi} clisp.html \$(TXTFILES) \$(IMPNOTES_FILES) \$(TOPDIR)/doc/" echotab "mkdir \$(TOPDIR)/emacs" for f in ${EMACS_FILES} ${VIM_FILES}; do echotab "${HLN} ${SRCTOPDIR}emacs/${f} \$(TOPDIR)/emacs/${f}" @@ -3895,7 +3897,7 @@ echotab "cp -p data/${f} \$\$distdir/data/${f} ; \\" done echotab "mkdir \$\$distdir/doc ; \\" - echotab "for f in clisp.1 clisp.man clisp.html \$(TXTFILES) \$(IMPNOTES_FILES) ; do \\" + echotab "for f in clisp-link.1 clisp.1 clisp.man clisp.html \$(TXTFILES) \$(IMPNOTES_FILES) ; do \\" echotab " if test -f \$\$f ; then cp -p \$\$f \$\$distdir/doc/\$\$f ; else cp -p \`echo \$\$f | tr '[A-Z]' '[a-z]'\` \$\$distdir/doc/\$\$f ; fi ; \\" echotab "done ; \\" echotab "mkdir \$\$distdir/emacs; \\" @@ -3931,7 +3933,7 @@ -\$(RMRF) boot base full !! cat <<!! - -\$(RM) README README.de README.es clisp.1 clisp.man clisp.dvi clisp.ps clisp.pdf clisp.html clisp-1.html \$(IMPNOTES_FILES) clisp.c distmakefile \$(TXTFILES) COPYRIGHT.rtf install.nsi + -\$(RM) README README.de README.es clisp-link.1 clisp.1 clisp.man clisp.dvi clisp.ps clisp.pdf clisp.html clisp-1.html \$(IMPNOTES_FILES) clisp.c distmakefile \$(TXTFILES) COPYRIGHT.rtf install.nsi # clean2 removes everything that becomes obsolete once lisp${LEXE} # is recompiled without changing the bytecode format. --8<---------------cut here---------------end--------------->8--- ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ clisp-devel mailing list clisp-devel@... https://lists.sourceforge.net/lists/listinfo/clisp-devel |
|
|
Re: [PATCH] Add clisp-link manual page
by Sam Steingold
::
Rate this Message:
|
attachment0 (322 bytes) 
| Free Forum Powered by Nabble | Forum Help |