Hello Steven, Steven Shiau a écrit : > The most important commands to configure DRBL is: > drblsrv > drblpush > and the most important command an system administrator will use is: > dcs > > Do you want me to list all the commands an user might use?
This will be necessary sooner or later. However let us focus on most important commands first. When I inspect the code of sbin/drblsrv, I see the following lines: # Source DRBL setting . /opt/drbl/conf/drbl.conf I will write a script to modify such lines (in any script) into # Source DRBL setting . /etc/drbl/drbl.conf since files which provide system-wide settings should live in /etc, per the FHS. The change will not propagate into your upstream development, it will be part only of the debian package. Do you think that such a general change might provide a consistent set of scripts? I wrote the attached files to output the manpage drblsrv.8, Would you agree to review them and provide some feedback? You can view thr manpage by typing "man -l drblsrv.8" These files come with some suggestions: - adding option -h/--help and -v/--version for the command - documenting some strings output as diagnostics, documenting the exit status if it is useful, - writing a minimal manual page for drbl.conf's contents - documenting known bugs if any These suggestions are consistent with debian's quality assurance team's policy about manpages. They are not mandatory, but if we succeed in implementing some of them, users will enjoy. Thank you in advance for your feedback. Best regards, Georges. Then I shall write a manpage in docbook/xml format for drblsrv and submit it to your review. Will you be kind enough to provide me feedback about it? Best regards, Georges. > > Steven. > > > > Best regards, Georges. > > > > Georges Khaznadar a écrit : > >> Hello NCHC free-libre coders! > >> > >> I shall begin to package DRBL for Debian, with your help, if you do not > >> mind. There is work to do to meet Debian standards for packages in the > >> main section. > >> > >> I will talk about details in a separate e-mail. This one is to inform you > >> about the ITP (intention to package), see > >> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620722 if you prefer > >> viewing it in your favourite browser. > >> > >> Best regards, Georges. > >> > >> > >> Debian Bug Tracking System a écrit : > >>> Thank you for filing a new Bug report with Debian. > >>> > >>> This is an automatically generated reply to let you know your message > >>> has been received. > >>> > >>> Your message is being forwarded to the package maintainers and other > >>> interested parties for their attention; they will reply in due course. > >>> > >>> As you requested using X-Debbugs-CC, your message was also forwarded to > >>> debian-de...@lists.debian.org > >>> (after having been given a Bug report number, if it did not have one). > >>> > >>> Your message has been sent to the package maintainer(s): > >>> w...@debian.org > >>> > >>> If you wish to submit further information on this problem, please > >>> send it to 620...@bugs.debian.org. > >>> > >>> Please do not send mail to ow...@bugs.debian.org unless you wish > >>> to report a problem with the Bug-tracking system. > >>> > >>> -- > >>> 620722: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620722 > >>> Debian Bug Tracking System > >>> Contact ow...@bugs.debian.org with problems > >>> > >> > >> -- > >> Georges KHAZNADAR et Jocelyne FOURNIER > >> 22 rue des mouettes, 59240 Dunkerque France. > >> Téléphone +33 (0)3 28 29 17 70 > >> > > > > > > > > -- > Steven Shiau <steven _at_ nchc org tw> <steven _at_ stevenshiau org> > National Center for High-performance Computing, Taiwan. > http://www.nchc.org.tw > Public Key Server PGP Key ID: 1024D/9762755A > Fingerprint: A2A1 08B7 C22C 3D06 34DB F4BC 08B3 E3D7 9762 755A > -- Georges KHAZNADAR et Jocelyne FOURNIER 22 rue des mouettes, 59240 Dunkerque France. Téléphone +33 (0)3 28 29 17 70
drblsrv.xml
Description: XML document
'\" t .\" Title: drblsrv .\" Author: Georges Khaznadar <georg...@ofset.org> .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Date: 12/27/2011 .\" Manual: Administration commands .\" Source: drblsrv .\" Language: English .\" .TH "DRBLSRV" "8" "12/27/2011" "drblsrv" "Administration commands" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" drblsrv \- program to make a DRBL server .SH "SYNOPSIS" .HP \w'\fBdrblsrv\fR\ 'u \fBdrblsrv\fR [{\fB\-f\fR\ |\ \fB\-\-force\-yes\fR}] [{\fB\-i\fR\ |\ \fB\-\-install\fR}] [{\fB\-u\fR\ |\ \fB\-\-uninstall\fR}] [{\fB\-v\fR\ |\ \fB\-\-verbose\fR}] [{\fB\-t\fR\ |\ \fB\-\-testing\fR}\ {\fIy\fR\ |\ \fIn\fR}] [{\fB\-a\fR\ |\ \fB\-\-unstable\fR}\ {\fIy\fR\ |\ \fIn\fR}] [{\fB\-n\fR\ |\ \fB\-\-netinstall\fR}\ {\fIy\fR\ |\ \fIn\fR}] [{\fB\-m\fR\ |\ \fB\-\-smp\-client\fR}\ {\fIy\fR\ |\ \fIn\fR}] [{\fB\-x\fR\ |\ \fB\-\-set\-proxy\fR}\ {\fIy\fR\ |\ \fIn\fR}] [{\fB\-c\fR\ |\ \fB\-\-console\-output\fR}\ {\fIy\fR\ |\ \fIn\fR}] [{\fB\-g\fR\ |\ \fB\-\-upgrade_system\fR}\ {\fIy\fR\ |\ \fIn\fR}] [{\fB\-k\fR\ |\ \fB\-\-client_archi\fR}\ {\fI0\fR\ |\ \fI1\fR\ |\ \fI2\fR}] [{\fB\-o\fR\ |\ \fB\-\-client_kernel_from\fR}\ {\fI1\fR\ |\ \fI2\fR}] [{\fB\-s\fR\ |\ \fB\-\-skip\-select\-repository\fR}] [{\fB\-l\fR\ |\ \fB\-\-language\fR}\ {\fI0\fR\ |\ \fI1\fR\ |\ \fI2\fR}] .HP \w'\fBdrblsrv\fR\ 'u \fBdrblsrv\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | {\fB\-v\fR\ |\ \fB\-\-version\fR}] .SH "DESCRIPTION" .PP \fBdrblsrv\fR is a program to build or maintain a DRBL server\&. .SH "OPTIONS" .PP The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&. .PP \fB\-f\fR, \fB\-\-force\-yes\fR .RS 4 force yes, only for Debian\-like distribution\&. It should not be used except in very special situations\&. Using force\-yes can potentially destroy your system! .RE .PP \fB\-i\fR, \fB\-\-install\fR .RS 4 install DRBL\&. .RE .PP \fB\-u\fR, \fB\-\-uninstall\fR .RS 4 uninstall DRBL\&. .RE .PP \fB\-v\fR, \fB\-\-verbose\fR .RS 4 verbose mode\&. .RE .PP \fB\-t \fR\fB\fI[y/n]\fR\fR, \fB\-\-testing \fR\fB\fI[y/n]\fR\fR .RS 4 use packages in testing branch or not\&. .RE .PP \fB\-a \fR\fB\fI[y/n]\fR\fR, \fB\-\-unstable \fR\fB\fI[y/n]\fR\fR .RS 4 use packages in unstable branch or not\&. .RE .PP \fB\-n \fR\fB\fI[y/n]\fR\fR, \fB\-\-netinstall \fR\fB\fI[y/n]\fR\fR .RS 4 install the network installation program or not\&. .RE .PP \fB\-m \fR\fB\fI[y/n]\fR\fR, \fB\-\-smp\-client \fR\fB\fI[y/n]\fR\fR .RS 4 use SMP kernel for DRBL clients or not\&. .RE .PP \fB\-x \fR\fB\fI[y/n]\fR\fR, \fB\-\-set\-proxy \fR\fB\fI[y/n]\fR\fR .RS 4 set proxy or not\&. .RE .PP \fB\-c \fR\fB\fI[y/n]\fR\fR, \fB\-\-console\-output \fR\fB\fI[y/n]\fR\fR .RS 4 set console output for client or not\&. .RE .PP \fB\-g \fR\fB\fI[y/n]\fR\fR, \fB\-\-upgrade_system \fR\fB\fI[y/n]\fR\fR .RS 4 upgrade system or not\&. .RE .PP \fB\-k \fR\fB\fI[0|1|2]\fR\fR, \fB\-\-client_archi \fR\fB\fI[0|1|2]\fR\fR .RS 4 set the client\*(Aqs CPU arch, 0 for i386, 1 for i586, 2 for same level with DRBL server (for x86_64, use 2)\&. .RE .PP \fB\-o \fR\fB\fI[1|2]\fR\fR, \fB\-\-client_kernel_from \fR\fB\fI[1|2]\fR\fR .RS 4 choose client\*(Aqs kernel image from, 1 from DRBL server running kernel (if available), 2 from ayo repository\&. .RE .PP \fB\-s\fR, \fB\-\-skip\-select\-repository\fR .RS 4 skip the question for selecting repository\&. .RE .PP \fB\-l \fR\fB\fI[N]\fR\fR, \fB\-\-language \fR\fB\fI[N]\fR\fR .RS 4 Set the language to be shown, where N: 0: English, 1: Traditional Chinese (Big5) \- Taiwan, 2: Traditional Chinese (UTF\-8, Unicode) \- Taiwan\&. .RE .PP \fB\-h\fR, \fB\-\-help\fR .RS 4 Show summary of options\&. .RE .PP \fB\-v\fR, \fB\-\-version\fR .RS 4 Show version of program\&. .RE .SH "FILES" .PP /etc/drbl/drbl\&.conf .RS 4 The system\-wide configuration file to control the behaviour of drblsrv\&. See \fBdrbl.conf\fR(5) for further details\&. .RE .PP ${HOME}/\&.drbl\&.conf .RS 4 The per\-user configuration file to control the behaviour of drblsrv\&. See \fBdrbl.conf\fR(5) for further details\&. .RE .SH "ENVIRONMENT" .PP \fBDRBL_SCRIPT_PATH\fR .RS 4 If used, the defined path is used to access each of drbl\*(Aqs routine scripts\&. .RE .SH "DIAGNOSTICS" .PP The following diagnostics may be issued on stderr: .PP Any error messages worth to be reported in this manpage? .RS 4 If so, they should be documented here\&. .RE .PP \fBdrblsrv\fR provides some return codes, that can be used in scripts: .\" line length increase to cope w/ tbl weirdness .ll +(\n(LLu * 62u / 100u) .TS ll. \fICode\fR \fIDiagnostic\fR T{ \fB0\fR T} T{ Program exited successfully\&. T} T{ \fB1\fR T} T{ is such documentation useful? If no, erase it\&. T} .TE .\" line length decrease back to previous value .ll -(\n(LLu * 62u / 100u) .sp .SH "KNOWN BUGS" .PP The program is currently limited to only work with \&.\&.\&. [some known bugs?] .SH "SEE ALSO" .PP \fBdrbl.conf\fR(5), \fBdrblpush\fR(8) .SH "AUTHORS" .PP \fBGeorges Khaznadar\fR <\&georgesk@ofset\&.org\&> .RS 4 Wrote this manpage for the Debian system, based on the output of the command "\fBdrblsrv\fR \-h"\&. .RE .PP \fBSteven Shiau\fR <\&steven@nchc\&.org\&.tw\&> .RS 4 Wrote the command \fBdrblsrv\fR, including its short documentation\&. .RE .SH "COPYRIGHT" .br Copyright \(co 2011 Georges Khaznadar .br .PP This manual page was written for the Debian system (and may be used by others)\&. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation\&. .PP On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&. .sp
TARGETS = $(shell for f in *.xml; do section=$$(grep "ENTITY dhsection" $$f|
sed -n 's/[^0-9]*\([1-8]\).*/\1/ p'); g=$${f/.xml/}; echo $$g.$${section}; done)
XP = xsltproc --nonet --param man.charmap.use.subset "0"
DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
all: $(TARGETS)
test:
@echo $(TARGETS)
%.1: %.xml
$(XP) $(DB2MAN) $<
%.8: %.xml
$(XP) $(DB2MAN) $<
signature.asc
Description: Digital signature
