[Debburn-changes] r618 - cdrkit/trunk/genisoimage
Peter Samuelson
peters-guest at alioth.debian.org
Wed Dec 13 11:00:04 CET 2006
Author: peters-guest
Date: 2006-12-13 11:00:01 +0100 (Wed, 13 Dec 2006)
New Revision: 618
Added:
cdrkit/trunk/genisoimage/genisoimagerc.5
Modified:
cdrkit/trunk/genisoimage/CMakeLists.txt
cdrkit/trunk/genisoimage/genisoimage.1
Log:
genisoimage.1 cleanup:
Move config file info to a new manpage, genisoimagerc.5.
The theory is that genisoimage.1 is waaaaay too long.
Also add concise copyright information to the headers of both manpages,
based on the copyright history described in genisoimage.1.
Note: on some systems, config file manpages go in section 4 rather than
section 5. I don't think cmake is prepared to detect this.
Modified: cdrkit/trunk/genisoimage/CMakeLists.txt
===================================================================
--- cdrkit/trunk/genisoimage/CMakeLists.txt 2006-12-13 06:35:57 UTC (rev 617)
+++ cdrkit/trunk/genisoimage/CMakeLists.txt 2006-12-13 10:00:01 UTC (rev 618)
@@ -62,3 +62,4 @@
diag/isoinfo.1
diag/isovfy.1
DESTINATION share/man/man1)
+INSTALL(FILES genisoimagerc.5 DESTINATION share/man/man5)
Modified: cdrkit/trunk/genisoimage/genisoimage.1
===================================================================
--- cdrkit/trunk/genisoimage/genisoimage.1 2006-12-13 06:35:57 UTC (rev 617)
+++ cdrkit/trunk/genisoimage/genisoimage.1 2006-12-13 10:00:01 UTC (rev 618)
@@ -1,9 +1,14 @@
'\" t
-.\" To print, first run through tbl
-.\" -*- nroff -*-
-.\" @(#)genisoimage.8 1.109 05/05/01 joerg
+.\" genisoimage.1 -*- nroff -*- To render, first run through tbl
+.\" Copyright 1993-1998 by Yggdrasil Computing
+.\" Copyright 1996-1997 by Robert Leslie
+.\" Copyright 1997-2001 by James Pearson
+.\" Copyright 1999-2006 by Joerg Schilling
+.\" Copyright 2002-2003 by Jungshik Shin
+.\" Copyright 2003 by Jaakko Heinonen
+.\" Copyright 2006 by the Cdrkit maintainers
.\"
-.TH GENISOIMAGE 1 "24 Aug 2006" "Version 2.01"
+.TH GENISOIMAGE 1 "13 Dec 2006"
.\" ----------------------------------------
.SH NAME
genisoimage \- create ISO9660/Joliet/HFS filesystem with optional Rock Ridge attributes
@@ -23,8 +28,7 @@
.B genisoimage
is capable of generating the
.B System Use Sharing Protocol records (SUSP)
-specified
-by the
+specified by the
.BR "Rock Ridge Interchange Protocol" .
This is used to further describe the
files in the ISO9660 filesystem to a Unix host, and provides information such
@@ -158,25 +162,30 @@
.IR Win32 .
.\" ----------------------------------------
.SH OPTIONS
+.PP
+Several options can be specified as defaults in a
+.I .genisoimagerc
+configuration file, as well as on the command line. If a parameter is
+specified in both places, the setting from the command line is used.
+For details on the format and possible locations of this file, see
+.BR genisoimagerc (5).
.TP
.BI \-abstract " file"
-Specifies the abstract filename.
-There is space for 37 characters of information.
-This parameter can also be set in the file
+Specifies the abstract filename. There is space for 37 characters.
+Equivalent to
+.B ABST
+in the
.I .genisoimagerc
-with
-.IR ABST=filename .
-If specified in both places, the command-line version is used.
+file.
.TP
.BI \-A " application_id"
Specifies a text string that will be written into the volume header.
This should describe the application that will be on the disc. There
-is space for 128 characters of information. This parameter can
-also be set in the file
+is space for 128 characters. Equivalent to
+.B APPI
+in the
.I .genisoimagerc
-with
-.IR APPI=id .
-If specified in both places, the command-line version is used.
+file.
.TP
.B \-allow\-leading\-dots
.TP
@@ -203,13 +212,12 @@
Use with caution.
.TP
.BI \-biblio " file"
-Specifies the bibliographic filename.
-There is space for 37 characters of information.
-This parameter can also be set in the file
+Specifies the bibliographic filename. There is space for 37 characters.
+Equivalent to
+.B BIBL
+in the
.I .genisoimagerc
-with
-.IR BIBLO=filename .
-If specified in both places, the command line version is used.
+file.
.TP
.B \-cache\-inodes
.TP
@@ -472,13 +480,12 @@
.BR \-M .
.TP
.BI \-copyright " file"
-Specifies a filename that contains copyright information. The contents
-of the file, up to 37 characters, will be stored.
-This parameter can also be set in the file
+Specifies copyright information, typically a filename on the disc.
+There is space for 37 characters. Equivalent to
+.B COPY
+in the
.I .genisoimagerc
-with
-.IR COPY=filename .
-If specified in both places, the command-line version is used.
+file.
.TP
.B \-d
Do not append a period to files that do not have one.
@@ -937,22 +944,22 @@
.BI \-publisher " publisher_id"
Specifies a text string that will be written into the volume header.
This should describe the publisher of the CD-ROM, usually with a
-mailing address and phone number. There is space for 128
-characters. This parameter can also be set in the file
+mailing address and phone number. There is space for 128 characters.
+Equivalent to
+.B PUBL
+in the
.I .genisoimagerc
-with
-.IR PUBL=publisher_id .
-If specified in both places, the command-line version is used.
+file.
.TP
.BI \-p " preparer_id"
Specifies a text string that will be written into the volume header.
This should describe the preparer of the CD-ROM, usually with a mailing
-address and phone number. There is space on the disc for 128
-characters of information. This parameter can also be set in the file
+address and phone number. There is space for 128 characters.
+Equivalent to
+.B PREP
+in the
.I .genisoimagerc
-with
-.IR PREP=preparer_id .
-If specified in both places, the command-line version is used.
+file.
.TP
.B \-print\-size
Print estimated filesystem size in multiples of the sector size (2048 bytes)
@@ -1180,12 +1187,12 @@
.BR \-sunx86-boot .
.TP
.BI \-sysid " ID"
-Specifies the system ID.
-There is space on the disc for 32 characters of information.
-This parameter can also be set in the file
+Specifies the system ID. There is space for 32 characters.
+Equivalent to
+.B SYSI
+in the
.I .genisoimagerc
-with SYSI=system_id.
-If specified in both places, the command line version is used.
+file.
.TP
.B \-T
Generate a file TRANS.TBL in each directory on the CD-ROM, which can be used
@@ -1261,23 +1268,21 @@
.TP
.BI \-V " volid"
Specifies the volume ID (volume name or label) to be written into the
-master block.
-There is space on the disc for 32 characters of information.
-This parameter can also be set in the file
+master block. There is space for 32 characters. Equivalent to
+.B VOLI
+in the
.I .genisoimagerc
-with VOLI=id.
-If specified in both places, the command line version is used. Note that
-if you assign a volume ID, this is the name that will be used as the mount
-point used by the Solaris volume management system and the name that is
-assigned to the disc on a Microsoft Win32 or Apple Mac platform.
+file. The volume ID is used as the mount point by the Solaris volume
+manager and as a label assigned to a disc on various other platforms
+such as Windows and Apple Mac OS.
.TP
.BI \-volset " ID"
-Specifies the volset ID.
-There is space on the disc for 128 characters of information.
-This parameter can also be set in the file
+Specifies the volume set ID. There is space for 128 characters.
+Equivalent to
+.B VOLS
+in the
.I .genisoimagerc
-with VOLS=volset_id.
-If specified in both places, the command line version is used.
+file.
.TP
.BI \-volset\-size " #"
Sets the volume set size to #.
@@ -2445,111 +2450,6 @@
.I Debian:<file>
in the output jigdo file.
.\" ----------------------------------------
-.SH CONFIGURATION
-.B genisoimage
-looks for the
-.I .genisoimagerc
-file,
-first in the current working directory,
-then in the user's home directory,
-then in the directory in which the
-.B genisoimage
-binary is stored. This file is assumed to contain a series of lines
-of the form
-.BI TAG= value
-, and in this way you can specify certain options.
-The case of the tag is not significant.
-Some fields in the volume header
-are not settable on the command line, but can be altered through this
-facility.
-Comments may be placed in this file,
-using lines which start with a hash (#) character.
-.TP
-.B APPI
-The application identifier
-should describe the application that will be on the disc.
-There is space on the disc for 128 characters of information.
-May be overridden using the
-.B \-A
-command line option.
-.TP
-.B COPY
-The copyright information,
-often the name of a file on the disc containing the copyright notice.
-There is space in the disc for 37 characters of information.
-May be overridden using the
-.B \-copyright
-command line option.
-.TP
-.B ABST
-The abstract information,
-often the name of a file on the disc containing an abstract.
-There is space in the disc for 37 characters of information.
-May be overridden using the
-.B \-abstract
-command line option.
-.TP
-.B BIBL
-The bibliographic information,
-often the name of a file on the disc containing a bibliography.
-There is space in the disc for 37 characters of information.
-May be overridden using the
-.B \-bilio
-command line option.
-.TP
-.B PREP
-This should describe the preparer of the CD-ROM,
-usually with a mailing address and phone number.
-There is space on the disc for 128 characters of information.
-May be overridden using the
-.B \-p
-command line option.
-.TP
-.B PUBL
-This should describe the publisher of the CD-ROM,
-usually with a mailing address and phone number.
-There is space on the disc for 128 characters of information.
-May be overridden using the
-.B \-publisher
-command line option.
-.TP
-.B SYSI
-The System Identifier.
-There is space on the disc for 32 characters of information.
-May be overridden using the
-.B \-sysid
-command line option.
-.TP
-.B VOLI
-The Volume Identifier.
-There is space on the disc for 32 characters of information.
-May be overridden using the
-.B \-V
-command line option.
-.TP
-.B VOLS
-The Volume Set Name.
-There is space on the disc for 128 characters of information.
-May be overridden using the
-.B \-volset
-command line option.
-.TP
-.B HFS_TYPE
-The default TYPE for Macintosh files. Must be exactly 4 characters.
-May be overridden using the
-.B \-hfs\-type
-command line option.
-.TP
-.B HFS_CREATOR
-The default CREATOR for Macintosh files. Must be exactly 4 characters.
-May be overridden using the
-.B \-hfs\-creator
-command line option.
-.PP
-.B genisoimage
-can also be configured at compile time with defaults for many of these fields.
-See the file defaults.h.
-.\" ----------------------------------------
.SH EXAMPLES
.PP
To create a vanilla ISO9660 filesystem image in the file
@@ -2855,6 +2755,7 @@
been fully tested.
.\" ----------------------------------------
.SH "SEE ALSO"
+.BR genisoimagerc (5),
.BR wodim (1),
.BR mkzftree (8),
.BR magic (5).
@@ -2919,14 +2820,12 @@
.fi
.PP
.nf
-James Pearson (HFS MKHYBRID MAINTAINER)
+James Pearson (mkhybrid maintainer)
j.pearson at ge.ucl.ac.uk
.PP
-If you have support questions, send them to:
+If you have support questions, send them to
+.IR debburn-devel at lists.alioth.debian.org .
.PP
-.B
-debburn-devel at lists.alioth.debian.org
-.PP
Note that Cdrkit and Cdrtools are not affiliated.
.\" ----------------------------------------
.SH ACKNOWLEDGEMENTS
Added: cdrkit/trunk/genisoimage/genisoimagerc.5
===================================================================
--- cdrkit/trunk/genisoimage/genisoimagerc.5 2006-12-13 06:35:57 UTC (rev 617)
+++ cdrkit/trunk/genisoimage/genisoimagerc.5 2006-12-13 10:00:01 UTC (rev 618)
@@ -0,0 +1,137 @@
+.\" genisoimagerc.5 -*- nroff -*-
+.\" Derived from genisoimage.1
+.\" Copyright 1993-1998 by Yggdrasil Computing
+.\" Copyright 1996-1997 by Robert Leslie
+.\" Copyright 1997-2001 by James Pearson
+.\" Copyright 1999-2006 by Joerg Schilling
+.\" Copyright 2002-2003 by Jungshik Shin
+.\" Copyright 2003 by Jaakko Heinonen
+.\" Copyright 2006 by the Cdrkit maintainers
+.\"
+.TH GENISOIMAGERC 5 "13 Dec 2006"
+.\" ----------------------------------------
+.SH NAME
+genisoimagerc \- startup configuration file for genisoimage
+.SH DESCRIPTION
+.BR genisoimage (1)
+searches for a configuration file in several places. First, if the
+.B MKISOFSRC
+environment variable is set, the value of that variable is used as the
+filename. Otherwise,
+.B genisoimage
+looks for a file named
+.I .genisoimagerc
+first in the current working directory, then in the user's home
+directory, then in the directory where
+.B genisoimage
+itself is stored.
+.PP
+The
+.I .genisoimagerc
+file contains lines of the form
+.IP
+.BI TAG= value
+.PP
+where
+.B TAG
+is one of the settings defined below. The case of the tag is not
+significant. All settings have command-line equivalents; if the
+command-line parameter is specified, it takes priority over the
+configuration file.
+.PP
+Blank lines and lines beginning with `#' are ignored.
+.\" ----------------------------------------
+.SH "CONFIGURATION SETTINGS"
+.IP ABST
+The abstract information, typically the name of a file on the disc
+containing an abstract. There is space for 37 characters.
+Equivalent to the
+.B \-abstract
+command-line option.
+.IP APPI
+The application identifier should describe the application that will be
+on the disc. There is space for 128 characters. Equivalent to the
+.B \-A
+command-line option.
+.IP BIBL
+The bibliographic information, often the name of a file on the disc
+containing a bibliography. There is space for 37 characters.
+Equivalent to the
+.B \-biblio
+command-line option.
+.IP COPY
+The copyright information, typically the name of a file on the disc
+containing the copyright notice. There is space for 37 characters.
+Equivalent to the
+.B \-copyright
+command-line option.
+.IP HFS_TYPE
+The default
+.B TYPE
+for Macintosh files. Must be exactly 4 characters. Equivalent to the
+.B \-hfs\-type
+command-line option. The default value is
+.IR TEXT .
+.IP HFS_CREATOR
+The default
+.B CREATOR
+for Macintosh files. Must be exactly 4 characters. Equivalent to the
+.B \-hfs\-creator
+command-line option. The default value is
+.IR Unix .
+.IP PREP
+This should describe the preparer of the CD-ROM, usually with a mailing
+address and phone number. There is space for 128 characters.
+Equivalent to the
+.B \-p
+command-line option.
+.IP PUBL
+This should describe the publisher of the CD-ROM, usually with a
+mailing address and phone number. There is space for 128 characters.
+Equivalent to the
+.B \-publisher
+command-line option.
+.IP SYSI
+The System Identifier. There is space for 32 characters.
+Equivalent to the
+.B \-sysid
+command-line option.
+.IP VOLI
+The Volume Identifier. There is space for 32 characters.
+Equivalent to the
+.B \-V
+command-line option.
+.IP VOLS
+The Volume Set Name. There is space for 128 characters.
+Equivalent to the
+.B \-volset
+command-line option.
+.PP
+.B genisoimage
+can also be configured at compile time with defaults for many of these
+fields. See the file
+.IR defaults.h .
+.\" ----------------------------------------
+.SH EXAMPLES
+The following file
+.IP
+.nf
+COPY=src/COPYING
+SYSI=Multics 75
+.fi
+.PP
+is equivalent to the
+.B genisoimage
+command-line parameters
+.IP
+.I "\-copyright src/COPYING \-sysid \(dqMultics 75\(dq"
+.\" ----------------------------------------
+.SH "SEE ALSO"
+.BR genisoimage (1).
+.\" ----------------------------------------
+.SH AUTHORS
+See the
+.BR genisoimage (1)
+manual page for credits for the
+.B genisoimage
+program and documentation.
More information about the Debburn-changes
mailing list