1PYCDLIB-EXPLORER(1)         General Commands Manual        PYCDLIB-EXPLORER(1)
2
3
4

NAME

6       pycdlib-explorer - tool to examine and modify ISOs using pycdlib
7
8

SYNOPSIS

10       pycdlib-explorer <iso-file>
11
12

DESCRIPTION

14       This is a tool to examine and modify existing ISO files on disk.  Using
15       this tool, the files, directories, and metadata on an ISO can be  exam‐
16       ined,  new files can be added, and old files can be deleted.  Note that
17       due to the nature of the ISO standard, files or directories on the  ISO
18       cannot  be modified in place in a general way.  To accomplish this, re‐
19       move the file and then re-add it with new contents.
20
21       The commands that change the contents of the ISO only  modify  the  in-
22       memory  copy.  Changes are written out to a new ISO file when the write
23       command is issued.
24
25       pycdlib-explorer has no command-line options; instead, it is controlled
26       entirely  at runtime through commands.  The following section describes
27       the available commands in pycdlib-explorer.
28
29

COMMANDS

31       add_file      <iso_path>       <src_filename>       [rr_name=<rr_name>]
32       [joliet_path=<joliet_path>]
33              Add  the  contents  of  src_filename  to the ISO at the location
34              specified in iso_path.  If the ISO is a Rock Ridge ISO,  rr_name
35              must be specified; otherwise, it must not be.  If the ISO is not
36              a Joliet ISO, joliet_path must not be specified.  If the ISO  is
37              a Joliet ISO, joliet_path is optional, but highly recommended to
38              supply.
39
40       cd <iso_dir>
41              Change the current working directory to relative or absolute ISO
42              path iso_dir.
43
44       cwd    Show the current working directory.
45
46       exit   Exit out of pycdlib-explorer.
47
48       get <iso_file> <out_file>
49              Copy  the contents of the relative or absolute ISO path iso_file
50              into out_file.
51
52       help   Print the available commands.  Use "help <cmd>" for a  more  de‐
53              tailed  description  of the commands, including the command-line
54              arguments they require.
55
56       ls     Show the contents of the current working directory.  The  format
57              of the output is: TYPE(F=file, D=directory) NAME.
58
59       mkdir <iso_path> [rr_name=<rr_name>] [joliet_path=<joliet_path>]
60              Make  a  new  directory  called  iso_path.  If the ISO is a Rock
61              Ridge ISO, rr_name must be specified; otherwise, it must not be.
62              If  the  ISO is not a Joliet ISO, joliet_path must not be speci‐
63              fied.  If the ISO is a Joliet ISO, joliet_path is optional,  but
64              highly recommended to supply.
65
66       print_mode [iso9660|rr|joliet|udf]
67              Change  which  'mode'  of  filenames are printed out.  There are
68              four main modes: ISO9660  (iso9660,  the  default),  Rock  Ridge
69              (rr), Joliet (joliet), and UDF (udf).  The original iso9660 mode
70              only allows filenames of 8 characters, plus 3 for the extension.
71              The  Rock  Ridge extensions allow much longer filenames and much
72              deeper directory structures.  The Joliet extensions  also  allow
73              longer  filenames and deeper directory structures, but in an en‐
74              tirely different context  (though  in  most  circumstances,  the
75              Joliet context will mirror the ISO9660/Rock Ridge context).  The
76              UDF Bridge extensions add an entirely parallel  UDF  context  to
77              the  ISO  as well.  Any given ISO will always have ISO9660 mode,
78              but may have any combination of Rock Ridge, Joliet, and UDF (in‐
79              cluding  none  of them).  Running this command with no arguments
80              prints out the current mode.  Passing 'iso9660' as  an  argument
81              sets  it to the original ISO9660 mode.  Passing 'rr' as an argu‐
82              ment sets it to Rock Ridge mode.  Passing 'joliet' as  an  argu‐
83              ment  sets it to Joliet mode.  Passing 'udf' as an argument sets
84              it to UDF mode.
85
86       quit   Exit out of pycdlib-explorer.
87
88       rm_file <iso_path>
89              Remove the file named iso_path from the  ISO.   Note  that  this
90              must be a file; to remove a directory, use rmdir.
91
92       rmdir <iso_path>
93              Remove  the  directory  named  iso_path from the ISO.  Note that
94              this must be a directory; to remove a file, use rm_file.
95
96       tree   List the contents of the ISO in a tree-like format,  similar  to
97              the bash tree command.
98
99       write <out_file>
100              Write  a valid ISO9660 file out to out_file, taking into account
101              any changes made while running the program.  This is also  some‐
102              times  referred  to  as  "mastering"  the  ISO.   Note  that the
103              out_file must NOT be the same file as the input file, or the re‐
104              sulting ISO will not work properly.
105
106

SEE ALSO

108       pycdlib-extract-files(1), pycdlib-genisoimage(1)
109
110

AUTHOR

112       Chris Lalancette <clalancette@gmail.com>
113
114
115
116pycdlib-explorer                   Jan 2018                PYCDLIB-EXPLORER(1)
Impressum