From 36f7f7729f69062a9a3b47e4e5fcd3295355b301 Mon Sep 17 00:00:00 2001 From: Stefano Rivera Date: Fri, 31 Dec 2010 12:37:52 +0200 Subject: [PATCH] Man page update --- doc/backportpackage.1 | 7 +++++ doc/requestsync.1 | 1 + doc/syncpackage.1 | 60 +++++++++++++++++++++++++++++++++++++----- doc/ubuntu-dev-tools.5 | 2 ++ 4 files changed, 63 insertions(+), 7 deletions(-) diff --git a/doc/backportpackage.1 b/doc/backportpackage.1 index 3ffb615..3a21b36 100644 --- a/doc/backportpackage.1 +++ b/doc/backportpackage.1 @@ -94,6 +94,13 @@ the default of "production". Do not read any configuration files, or configuration from environment variables. .SH ENVIRONMENT +.TP +.BR DEBFULLNAME ", " DEBEMAIL ", " UBUMAIL +Used to determine the uploader (if not supplied as options). +See +.BR ubuntu\-dev\-tools (5) +for details. +.P All of the \fBCONFIGURATION VARIABLES\fR below are also supported as environment variables. Variables in the environment take precedence to those in configuration diff --git a/doc/requestsync.1 b/doc/requestsync.1 index c2863e2..a6593e8 100644 --- a/doc/requestsync.1 +++ b/doc/requestsync.1 @@ -121,6 +121,7 @@ The default value for \fB--lpinstance\fR. .SH SEE ALSO .BR rmadison (1), +.BR syncpackage (1), .BR ubuntu\-dev\-tools (5) .SH AUTHOR diff --git a/doc/syncpackage.1 b/doc/syncpackage.1 index 7677860..22f10dc 100644 --- a/doc/syncpackage.1 +++ b/doc/syncpackage.1 @@ -12,7 +12,8 @@ primary archive or PPA starting from a pristine Debian package. Debian ones, as the common script used by Ubuntu archive administrators does, this way you can preserve source files integrity between the two distributions. .PP -\fBsyncpackage\fR will detect source tarballs with mismatching checksums and will automatically create fake syncs instead. +\fBsyncpackage\fR will detect source tarballs with mismatching checksums +and will automatically create fake syncs instead. .SH WARNING The use of \fBsyncpackage\fR is discouraged by the Ubuntu Archive Administrators, as it introduces an unnecessary window for error. @@ -40,12 +41,15 @@ Specify the version to sync from. Specify the component to sync from. .TP \fB\-v\fR, \fB\-\-verbose\fR -print more information +Display more progress information. .TP -\fB\-n\fI UPLOADER\fR, \fB\-\-uploader\fR=\fIUPLOADER\fR -Use UPLOADER as the name and email address of the -maintainer for this upload instead of evaluating -DEBFULLNAME and DEBEMAIL. +\fB\-n\fI UPLOADER_NAME\fR, \fB\-\-uploader\-name\fR=\fIUPLOADER_NAME\fR +Use UPLOADER_NAME as the name of the maintainer for this upload instead +of evaluating DEBFULLNAME and UBUMAIL. +.TP +\fB\-e\fI UPLOADER_EMAIL\fR, \fB\-\-uploader\-email\fR=\fIUPLOADER_EMAIL\fR +Use UPLOADER_EMAIL as the email address of the maintainer for this +upload instead of evaluating DEBEMAIL and UBUMAIL. .TP \fB\-k\fI KEYID\fR, \fB\-\-key\fR=\fIKEYID\fR Specify the key ID to be used for signing. @@ -55,7 +59,49 @@ Do not sign the upload. .TP \fB\-b\fI BUG\fR, \fB\-\-bug\fR=\fIBUG\fR Mark a Launchpad bug as being fixed by this upload. -.PP +.TP +.B \-d \fIDEBIAN_MIRROR\fR, \fB\-\-debian\-mirror\fR=\fIDEBIAN_MIRROR\fR +Use the specified mirror. +Should be in the form \fBhttp://ftp.debian.org/debian\fR. +If the package isn't found on this mirror, \fBsyncpackage\fR will fall +back to the default mirror. +.TP +.B \-s \fIUBUNTU_MIRROR\fR, \fB\-\-debsec\-mirror\fR=\fIUBUNTU_MIRROR\fR +Use the specified Debian security mirror. +Should be in the form \fBhttp://archive.ubuntu.com/ubuntu\fR. +If the package isn't found on this mirror, \fBsyncpackage\fR will fall +back to the default mirror. +.TP +.B \-\-no\-conf +Do not read any configuration files, or configuration from environment +variables. +.SH ENVIRONMENT +.TP +.BR DEBFULLNAME ", " DEBEMAIL ", " UBUMAIL +Used to determine the uploader (if not supplied as options). +See +.BR ubuntu\-dev\-tools (5) +for details. +.P +All of the \fBCONFIGURATION VARIABLES\fR below are also supported as +environment variables. +Variables in the environment take precedence to those in configuration +files. +.SH CONFIGURATION VARIABLES +The following variables can be set in the environment or in +.BR ubuntu\-dev\-tools (5) +configuration files. +In each case, the script\-specific variable takes precedence over the +package\-wide variable. +.TP +.BR SYNCPACKAGE_DEBIAN_MIRROR ", " UBUNTUTOOLS_DEBIAN_MIRROR +The default value for \fB\-\-debian\-mirror\fR. +.TP +.BR SYNCPACKAGE_UBUNTU_MIRROR ", " UBUNTUTOOLS_DEBSEC_MIRROR +The default value for \fB\-\-ubuntu\-mirror\fR. +.SH SEE ALSO +.BR requestsync (1), +.BR ubuntu\-dev\-tools (5) .SH AUTHOR \fBsyncpackage\fR was written by Martin Pitt and Benjamin Drung . .PP diff --git a/doc/ubuntu-dev-tools.5 b/doc/ubuntu-dev-tools.5 index 2c17596..adbd70f 100644 --- a/doc/ubuntu-dev-tools.5 +++ b/doc/ubuntu-dev-tools.5 @@ -43,6 +43,8 @@ In addition, several scripts use the following environment variables: .B UBUMAIL Overrides \fBDEBEMAIL\fR and \fBDEBFULLNAME\fR when the target is clearly Ubuntu. +Can either contain an e-mail address or \fBFull Name +\fR. .TP .BR DEBEMAIL ", " DEBFULLNAME