home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 6 / Sonderheft_6-96.iso / pd / disktools / mkisofs.105 / mkisofs.doc < prev    next >
Text File  |  1996-11-03  |  16KB  |  398 lines
  1.  
  2.  
  3.  
  4. MKISOFS(8)                                             MKISOFS(8)
  5.  
  6.  
  7. NAME
  8.        mkisofs  -  create a iso9660 filesystem with optional Rock
  9.        Ridge attributes.
  10.  
  11. SYNOPSIS
  12.        mkisofs [ -R ] [ -r ] [ -T ] [ -v ] [ -z ] [ -a ] [ -f ] [ -d ]
  13.      [ -D ] [ -l ] [ -L ] [ -L ] [ -V ] [ -V volid ] 
  14.      [ -i include-list ] [ -p preparer ]  [  -P  publisher  ]
  15.      [  -A applicationid ] [ -x path ] -o filename path
  16.  
  17. DESCRIPTION
  18.        mkisofs is effectively a pre-mastering program to generate
  19.        the iso9660 filesystem - it takes a snapshot  of  a  given
  20.        directory  tree,  and  generates a binary image which will
  21.        correspond to an iso9660  filesystem  when  written  to  a
  22.        block device.
  23.  
  24.        mkisofs is also capable of generating the System Use Shar­
  25.        ing Protocol records specified by the  Rock  Ridge  Inter­
  26.        change  Protocol.   This  is  used to further describe the
  27.        files in the iso9660 filesystem to a unix host,  and  pro­
  28.        vides information such as longer filenames, uid/gid, posix
  29.        permissions, and block and character devices.
  30.  
  31.        Each file written to the iso9660 filesystem  must  have  a
  32.        filename  in the 8.3 format (8 characters, period, 3 char­
  33.        acters, all upper case), even if Rock  Ridge  is  in  use.
  34.        This filename is used on systems that are not able to make
  35.        use of the Rock Ridge extensions  (such  as  MS-DOS),  and
  36.        each filename in each directory must be different from the
  37.        other filenames in the same directory.  mkisofs  generally
  38.        tries  to  form correct names by forcing the unix filename
  39.        to upper case and truncating as required, but often  times
  40.        this  yields  unsatisfactory  results when there are cases
  41.        where the truncated names are  not  all  unique.   mkisofs
  42.        assigns weightings to each filename, and if two names that
  43.        are otherwise the same are found the name with  the  lower
  44.        priority  is renamed to have a 3 digit number as an exten­
  45.        sion (where the number is guaranteed to  be  unique).   An
  46.        example of this would be the files foo.bar and foo.bar.~1~
  47.        - the file foo.bar.~1~ would be written as  FOO.000;1  and
  48.        the file foo.bar would be written as FOO.BAR;1
  49.  
  50.        Note  that mkisofs is not designed to communicate with the
  51.        writer directly.  Most writers  have  proprietary  command
  52.        sets  which vary from one manufacturer to another, and you
  53.        need a specialized tool to actually burn  the  disk.   The
  54.        ccddwwrriittee utility that comes with mkisofs is capable of com­
  55.        municating with Phillips drives (newer versions of cdwrite
  56.        should  be  available  from Yggdrasil).  Most writers come
  57.        with some version of DOS software  that  allows  a  direct
  58.        image copy of an iso9660 image to the writer.  The current
  59.        version  of  cdwrite  is  available  from   ftp.storm.net:
  60.        /pub/cdwrite-2.0beta1.tar.gz
  61.  
  62.  
  63.  
  64. Version 1.05               January 1995                         1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MKISOFS(8)                                             MKISOFS(8)
  71.  
  72.  
  73.        Also you should know that most cd writers are very partic­
  74.        ular about timing.  Once you start to  burn  a  disc,  you
  75.        cannot  let their buffer empty before you are done, or you
  76.        will end up with a corrupt disc.  Thus it is critical that
  77.        you  be  able  to maintain an uninterrupted data stream to
  78.        the writer for the entire time  that  the  disc  is  being
  79.        written.
  80.  
  81.        ppaatthh  is  the path of the directory tree to be copied into
  82.        the iso9660 filesystem.
  83.  
  84. OPTIONS
  85.        -a     Include all files on the iso9660 filesystem.   Nor­
  86.               mally  files that contain the characters '~' or '#'
  87.               will not be included (these  are  typically  backup
  88.               files for editors under unix).
  89.  
  90.        -A application_id
  91.               Specifies  a  text string that will be written into
  92.               the volume header.  This should describe the appli­
  93.               cation that will be on the disc.  There is space on
  94.               the disc for 128 characters of  information.   This
  95.               parameter  can  also  be set in the file .mkisofsrc
  96.               with APPI=id.  If specified  in  both  places,  the
  97.               command line version is used.
  98.  
  99.        -d     Omit  trailing period from files that do not have a
  100.               period.  This violates the ISO9660 standard, but it
  101.               happens to work on many systems.  Use with caution.
  102.  
  103.        -D     Do not use deep directory relocation,  and  instead
  104.               just  pack  them in the way we see them.  This vio­
  105.               lates the ISO9660 standard, but it  works  on  many
  106.               systems.  Use with caution.
  107.  
  108.        -f     Follow  symbolic links when generating the filesys­
  109.               tem.  When this option  is  not  in  use,  symbolic
  110.               links  will be entered using Rock Ridge if enabled,
  111.               otherwise the file will be ignored.
  112.  
  113.        -i include-list
  114.               Use the specified file as a list of files to add to
  115.               the  directory  tree.   This  is useful for quickly
  116.               repacking a CD while adding files to it.  The  for­
  117.               mat of this file is path1/file=path2 where path1 is
  118.               the directory in the ISO9660 file system where file
  119.               should  appear  and  path2 is the where to find the
  120.               file.
  121.  
  122.        -l     Allow full 32 character  filenames.   Normally  the
  123.               ISO9660  filename will be in an 8.3 format which is
  124.               compatible with MS-DOS,  even  though  the  ISO9660
  125.               standard  allows  filenames of up to 32 characters.
  126.               If you use this option, the disc may  be  difficult
  127.  
  128.  
  129.  
  130. Version 1.05               January 1995                         2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MKISOFS(8)                                             MKISOFS(8)
  137.  
  138.  
  139.               to  use on a MS-DOS system, but this comes in handy
  140.               on some other systems (such  as  the  Amiga).   Use
  141.               with caution.
  142.  
  143.        -L     Allow filenames to begin with a period.  Usually, a
  144.               leading dot is replaced with an underscore in order
  145.               to maintain MS-DOS compatibility.
  146.  
  147.        -N     Omit version numbers from ISO9660 file names.  This
  148.               may violate the ISO9660 standard, but no one really
  149.               uses the version numbers anyway.  Use with caution.
  150.  
  151.        -o filename
  152.               is the name  of  the  file  to  which  the  iso9660
  153.               filesystem  image should be written.  This can be a
  154.               disk file, a  tape  drive,  or  it  can  correspond
  155.               directly  to  the  device  name of the optical disc
  156.               writer.  If not specified, stdout  is  used.   Note
  157.               that  the output can also be a block special device
  158.               for a regular disk drive, in which  case  the  disk
  159.               partition  can  be  mounted  and examined to ensure
  160.               that the premastering was done correctly.
  161.  
  162.        -P publisherid
  163.               Specifies a text string that will be  written  into
  164.               the  volume  header.  This should describe the pub­
  165.               lisher of the CDROM, usually with a mailing address
  166.               and  phone  number.  There is space on the disc for
  167.               128 characters of information.  This parameter  can
  168.               also  be set in the file .mkisofsrc with PUBL=.  If
  169.               specified in both places, the command line  version
  170.               is used.
  171.  
  172.        -p preparerid
  173.               Specifies  a  text string that will be written into
  174.               the volume header.  This should describe  the  pre­
  175.               parer  of the CDROM, usually with a mailing address
  176.               and phone number.  There is space on the  disc  for
  177.               128  characters of information.  This parameter can
  178.               also be set in the file .mkisofsrc with PREP=.   If
  179.               specified  in both places, the command line version
  180.               is used.
  181.  
  182.        -R     Generate SUSP and RR records using the  Rock  Ridge
  183.               protocol  to  further  describe  the  files  on the
  184.               iso9660 filesystem.
  185.  
  186.        -r     This is like the -R option, but file ownership  and
  187.               modes  are  set to more useful values.  The uid and
  188.               gid are set to zero, because they are usually  only
  189.               useful  on  the  author's system, and not useful to
  190.               the client.  All the file read bits are  set  true,
  191.               so that files and directories are globally readable
  192.               on the client.  If any execute bit  is  set  for  a
  193.  
  194.  
  195.  
  196. Version 1.05               January 1995                         3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. MKISOFS(8)                                             MKISOFS(8)
  203.  
  204.  
  205.               file, set all of the execute bits, so that executa­
  206.               bles are globally executable on the client.  If any
  207.               search  bit  is set for a directory, set all of the
  208.               search  bits,  so  that  directories  are  globally
  209.               searchable  on  the  client.   All  write  bits are
  210.               cleared, because the CD-Rom will be  mounted  read-
  211.               only  in any case.  If any of the special mode bits
  212.               are set, clear them, because  file  locks  are  not
  213.               useful  on a read-only file system, and set-id bits
  214.               are not desirable for uid 0 or gid 0.
  215.  
  216.        -T     Generate a file TRANS.TBL in each directory on  the
  217.               CDROM,  which can be used on non-Rock Ridge capable
  218.               systems to help establish the correct  file  names.
  219.               There  is also information present in the file that
  220.               indicates the major and minor numbers for block and
  221.               character devices, and each symlink has the name of
  222.               the link file given.
  223.  
  224.        -V volid
  225.               Specifies the volume ID to be written into the mas­
  226.               ter  block.   This parameter can also be set in the
  227.               file .mkisofsrc with VOLI=id.  If specified in both
  228.               places, the command line version is used.
  229.  
  230.        -v     Verbose execution.
  231.  
  232.        -x path
  233.               Exclude  path  from  being  written to CDROM.  path
  234.               must be the complete  pathname  that  results  from
  235.               concatenating  the  pathname  given as command line
  236.               argument and the path relative to  this  directory.
  237.               Multiple paths may be excluded (up to 1000).  Exam­
  238.               ple:
  239.  
  240.               mkisofs -o cd -x /local/dir1 -x /local/dir2 /local
  241.  
  242.        -z     Generate special  SUSP  records  for  transparently
  243.               compressed files.  This is only of use and interest
  244.               for hosts that support  transparent  decompression.
  245.               This  is  an experimental feature, and no hosts yet
  246.               support this, but there are ALPHA patches for Linux
  247.               that can make use of this feature.
  248.  
  249. CONFIGURATION
  250.        mkisofs  looks  for the .mkisofsrc file, first in the cur­
  251.        rent working directory, then in the user's home directory,
  252.        and  then  in the directory in which the mkisofs binary is
  253.        stored.  This file is assumed to contain a series of lines
  254.        of  the  form "TAG=value", and in this way you can specify
  255.        certain options.  The case of the tag is not  significant.
  256.        Some  fields  in the volume header are not settable on the
  257.        command line, but can be altered  through  this  facility.
  258.        Comments  may  be  placed  in this file, using lines which
  259.  
  260.  
  261.  
  262. Version 1.05               January 1995                         4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. MKISOFS(8)                                             MKISOFS(8)
  269.  
  270.  
  271.        start with a hash (#) character.
  272.  
  273.        APPI   The  application  identifier  should  describe  the
  274.               application  that  will  be  on the disc.  There is
  275.               space on the disc for 128  characters  of  informa­
  276.               tion.   May be overridden using the -A command line
  277.               option.
  278.  
  279.        COPY   The copyright information, often the name of a file
  280.               on the disc containing the copyright notice.  There
  281.               is space in the disc for 37 characters of  informa­
  282.               tion.
  283.  
  284.        ABST   The  abstract information, often the name of a file
  285.               on the disc containing an abstract.  There is space
  286.               in the disc for 37 characters of information.
  287.  
  288.        BIBL   The  bibliographic information, often the name of a
  289.               file on the disc containing a bibliography.   There
  290.               is  space in the disc for 37 characters of informa­
  291.               tion.
  292.  
  293.        PREP   This should describe the  preparer  of  the  CDROM,
  294.               usually  with  a  mailing address and phone number.
  295.               There is space on the disc for  128  characters  of
  296.               information.   May  be overridden using the -p com­
  297.               mand line option.
  298.  
  299.        PUBL   This should describe the publisher  of  the  CDROM,
  300.               usually  with  a  mailing address and phone number.
  301.               There is space on the disc for  128  characters  of
  302.               information.   May  be overridden using the -P com­
  303.               mand line option.
  304.  
  305.        SYSI   The System Identifier.  There is space on the  disc
  306.               for 32 characters of information.
  307.  
  308.        VOLI   The  Volume Identifier.  There is space on the disc
  309.               for 32 characters of information.  May be  overrid­
  310.               den using the -V command line option.
  311.  
  312.        VOLS   The  Volume  Set  Name.  There is space on the disc
  313.               for 278 characters of information.
  314.  
  315.        mkisofs can  also  be  configured  at  compile  time  with
  316.        defaults   for   many  of  these  fields.   See  the  file
  317.        defaults.h.
  318.  
  319. AUTHOR
  320.        mkisofs is not based on the standard mk*fs tools for unix,
  321.        because  we  must generate a complete  copy of an existing
  322.        filesystem on a disk in the  iso9660 filesystem.  The name
  323.        mkisofs is probably a bit of a misnomer, since it not only
  324.        creates the filesystem, but it also populates it as  well.
  325.  
  326.  
  327.  
  328. Version 1.05               January 1995                         5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. MKISOFS(8)                                             MKISOFS(8)
  335.  
  336.  
  337.        Eric   Youngdale   <eric@aib.com>  wrote  both  the  Linux
  338.        isofs9660 filesystem and the mkisofs utility, and is  cur­
  339.        rently  maintaining  them.   The copyright for the mkisofs
  340.        utility is held by Yggdrasil Computing, Incorporated.
  341.  
  342. BUGS
  343.        Any files that have hard links to files not  in  the  tree
  344.        being copied to the iso9660 filessytem will have an incor­
  345.        rect file reference count.
  346.  
  347.        There may be some other ones.  Please, report them to  the
  348.        author.
  349.  
  350. FUTURE IMPROVEMENTS
  351.        Allow  specification of multiple paths on the command line
  352.        to be included in iso9660 filesystem.   Can  be  tricky  -
  353.        directory  entries  in the root directory need to be prop­
  354.        erly sorted.
  355.  
  356. AVAILABILITY
  357.        mkisofs is available for anonymous ftp from tsx-11.mit.edu
  358.        in  /pub/linux/BETA/cdrom/mkisofs  and  many  other mirror
  359.        sites.  With the 1.0 release, it is no  longer  considered
  360.        to  be  in  beta testing.  Most of the bugs that are being
  361.        discovered now are very minor  (and  interestingly  enough
  362.        also  seem  to  be  present  in the YM software).  Reports
  363.        indicate that people are gearing up  for  production  runs
  364.        using version 1.00.
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. Version 1.05               January 1995                         6
  395.  
  396.  
  397. 1H
  398.