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

SEE ALSO

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

AUTHOR

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