Package: ksh
Version: 93q-2
Severity: wishlist
Tags: patch
Hi,
When ksh93 is built, shcomp is also built. This binary can compile a ksh93
script. There is some reference to this program in the installed doc
but not in ksh man page.
I suggest that shcomp be installed and that there is some reference to it
in the man page.
I have written a little English man page for shcomp so that lintian is happy,
and one in French so that French people are happy ;-)
I would be nice if the "SEE ALSO" section in ksh man page listed shcomp...
I don't know how to do that properly
Please, find below :
a diff for debian/rules so that shcomp and man pages are installed,
the English man page for shcomp
the French man page for shcomp (using charset ISO-8859-1)
Regards,
Christophe.
diff -u debian/rules.orig debian/rules
-%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<-
--- debian/rules.orig 2005-06-03 12:33:36.153877223 +0200
+++ debian/rules 2005-06-03 12:39:30.253797170 +0200
@@ -43,8 +43,11 @@
dh_testroot
dh_installdirs
$(INSTALL_PROGRAM) arch/$(ARCH)/bin/ksh debian/ksh/bin/ksh93
+ $(INSTALL_PROGRAM) arch/$(ARCH)/bin/shcomp debian/ksh/bin/shcomp
$(INSTALL_FILE) arch/$(ARCH)/man/man1/sh.1
debian/ksh/usr/share/man/man1/ksh93.1
$(INSTALL_FILE) arch/$(ARCH)/fun/* debian/ksh/usr/share/ksh/functions
+ $(INSTALL_FILE) shcomp.1 debian/ksh/usr/share/man/man1/shcomp.1
+ $(INSTALL_FILE) fr-shcomp.1 debian/ksh/usr/share/man/fr/man1/shcomp.1
dh_installdocs
dh_installmenu
dh_installchangelogs
-%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<-
English man page : shcomp.1
-%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<-
..\"
..\" File written by Christophe Martin <[EMAIL PROTECTED]>
..\" Based on the output of "shcomp --man"
..\"
..TH SHCOMP 1 "Fri Jun 3 2005" KSH93 "User Environment Utilities"
..SH NAME
shcomp \- compile a ksh93 shell script
..SH SYNOPSIS
..B shcomp
[
..I options
] [\fIinfile\fP] [\fIoutfile\fP]]
..SH ORIGINE OF THIS MAN PAGE
This man page was written by Christophe Martin <[EMAIL PROTECTED]>
for the
..B Debian
..B GNU/Linux
system. It is based on "shcomp \-\-man" output.
..SH DESCRIPTION
Unless
..I \-D
is specified,
..B shcomp
takes a shell script,
..IR infile ,
and creates a
binary format file,
..IR outfile ,
that
..B ksh93
can read and execute with the same
effect as the original script.
..PP
Since aliases are processed as the script is read, alias definitions whose
value requires variable expansion will not work correctly.
..PP
If
..I \-D
is specifed, all double quoted strings that are preceded by $ are
output. These are the messages that need to be translated to locale specific
versions for internationalization.
..PP
If
..I outfile
is omitted, then the results will be written to standard output.
If
..I infile
is also omitted, the shell script will be read from standard input.
..SH OPTIONS
..TP
\fI\-D\fP, \fI\-\-dictionary\fP
Generate a list of strings that need to be placed in a
message catalog for internationalization.
..TP
\fI\-n\fP, \fI\-\-noexec\fP
Displays warning messages for obsolete or non-conforming
constructs.
..TP
\fI\-v\fP, \fI\-\-verbose\fP
Displays input from
..I infile
onto standard error as it reads it.
..TP
\fI\-\-man\fP
Displays this man page on standard error and exits.
..TP
\fI\-\-help\fP
Shows a short help message and exits.
..SH EXIT STATUS
..TP
0
Successful completion.
..TP
>0
An error occurred.
..SH DEBIAN WARNING
On a
..B Debian
..B GNU/Linux
system, more than one package may provide ksh. the output of
..B shcomp
can only be used by
..BR ksh93 .
Other ksh will fail running the compiled script.
..SH EXAMPLE
..nf
( echo '#! /bin/ksh93' ; shcomp myscript ) > myscript.bin &&
chmod 755 myscript.bin
\&./myscript.bin
..fi
..SH SEE ALSO
..BR ksh (1)
..SH IMPLEMENTATION
..nf
version shcomp (AT&T Labs Research) 2003-03-02
author David Korn <[EMAIL PROTECTED]>
copyright Copyright (c) 1982-2005 AT&T Corp.
license http://www.opensource.org/licenses/cpl1.0.txt
..fi
-%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<-
French man page : fr-shcomp.1
-%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<-
..\"
..\" File written by Christophe Martin <[EMAIL PROTECTED]>
..\" Based on the output of "shcomp --man"
..\"
..TH SHCOMP 1 "Vendredi 3 juin 2005" KSH93 "Manuel de l'utilisateur UNIX"
..SH NAME
shcomp \- compile un script shell ksh93
..SH SYNOPSIS
..B shcomp
[
..I options
] [\fIfichier-d-entrée\fP] [\fIfichier-de-sortie\fP]]
..SH ORIGINE DE CETTE PAGE DE MANUEL
Écrite par Christophe Martin
<[EMAIL PROTECTED]>,
pour le projet
..B Debian
..BR GNU/Linux ,
elle est basée sur l'affichage de « shcomp \-\-man ».
..SH DESCRIPTION
À moins que
..I \-D
ne soit spécifié sur la ligne de commande,
..B shcomp
lit un script,
..IR fichier-d-entrée ,
et crée un fichier binaire,
..IR fichier-de-sortie ,
que
..B ksh93
peut lire et exécuter de la même manière et avec les mêmes effets
que le script d'origine.
..PP
Puisque ils sont evalués lors de la lecture du script, les alias dont la
valeur nécessite l'expansion de variables ne fonctionneront pas correctement.
..PP
Si on utilise l'option
..BR \-D ,
toutes les chaines entre guillemets (\fB"\fP) précédées d'un $ sont affichées.
Ces chaines sont les messages qui doivent être
traduits pour l'internationnalisation du script.
..PP
Si on omet
..IR fichier-de-sortie ,
alors le résultat est écrit sur la sortie standard.
Si on omet également
..IR fichier-d-entrée ,
alors le script est lu depuis l'entrée standard.
..SH OPTIONS
..TP
\fI\-D\fP, \fI\-\-dictionary\fP
Génère une liste de chaines qui doivent être placées dans un catalogue
de messages pour l'internationnalisation du script.
..TP
\fI\-n\fP, \fI\-\-noexec\fP
Affiche des alertes lorsque le script contient des constructions obsolètes
ou non conformes.
..TP
\fI\-v\fP, \fI\-\-verbose\fP
Affiche Les lignes de
..I fichier-d-entrée
au fur et à mesure qu'elles sont lues.
..TP
\fI\-\-man\fP
Affiche cette page de manuel (en anglais) sur l'erreur standard et quitte.
..TP
\fI\-\-help\fP
Affiche une courte aide (en anglais) et quitte.
..SH CODE DE RETOUR
..TP
0
Le programme a réussi.
..TP
>0
Une erreur s'est produite.
..SH ALERTE DEBIAN
Sur un système
..B Debian
..B GNU/Linux
plus d'un paquet fournit ksh. Seul
..B ksh93
peut exécuter les scripts compilés avec
..BR shcomp .
Les autres ksh échoueront.
..SH EXEMPLE
..nf
( echo '#! /bin/ksh93' ; shcomp monscript ) > monscript.bin &&
chmod 755 monscript.bin
\&./monscript.bin
..fi
..SH VOIR AUSSI
..BR ksh (1)
..SH IMPLEMENTATION
..nf
version shcomp (AT&T Labs Research) 2003-03-02
author David Korn <[EMAIL PROTECTED]>
copyright Copyright (c) 1982-2005 AT&T Corp.
license http://www.opensource.org/licenses/cpl1.0.txt
..fi
-%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<--%<-
-- System Information:
Debian Release: 3.1
APT prefers testing
APT policy: (500, 'testing')
Architecture: i386 (i686)
Kernel: Linux 2.6.8-1-686
Locale: LANG=fr_FR, LC_CTYPE=fr_FR (charmap=ISO-8859-1)
Versions of packages ksh depends on:
ii libc6 2.3.2.ds1-22 GNU C Library: Shared libraries an
-- no debconf information
