File: pycdlib-explorer.html

package info (click to toggle)
python-pycdlib 1.12.0%2Bds1-7
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 3,748 kB
  • sloc: python: 36,118; makefile: 63
file content (278 lines) | stat: -rw-r--r-- 7,940 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<!-- Creator     : groff version 1.22.4 -->
<!-- CreationDate: Tue Aug 10 21:51:38 2021 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
       h1      { text-align: center }
</style>
<title>PYCDLIB-EXPLORER</title>

</head>
<body>

<h1 align="center">PYCDLIB-EXPLORER</h1>

<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#COMMANDS">COMMANDS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#AUTHOR">AUTHOR</a><br>

<hr>


<h2>NAME
<a name="NAME"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em">pycdlib-explorer
- tool to examine and modify ISOs using pycdlib</p>

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><b>pycdlib-explorer
&lt;iso-file&gt;</b></p>

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">This is a tool
to examine and modify existing ISO files on disk. Using this
tool, the files, directories, and metadata on an ISO can be
examined, new files can be added, and old files can be
deleted. Note that due to the nature of the ISO standard,
files or directories on the ISO cannot be modified in place
in a general way. To accomplish this, remove the file and
then re-add it with new contents.</p>

<p style="margin-left:11%; margin-top: 1em">The commands
that change the contents of the ISO only modify the
in-memory copy. Changes are written out to a new ISO file
when the <b>write</b> command is issued.</p>


<p style="margin-left:11%; margin-top: 1em">pycdlib-explorer
has no command-line options; instead, it is controlled
entirely at runtime through commands. The following section
describes the available commands in pycdlib-explorer.</p>

<h2>COMMANDS
<a name="COMMANDS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em"><b>add_file
&lt;iso_path&gt; &lt;src_filename&gt;
[rr_name=&lt;rr_name&gt;] <br>
[joliet_path=&lt;joliet_path&gt;]</b></p>

<p style="margin-left:22%;">Add the contents of
<b>src_filename</b> to the ISO at the location specified in
<b>iso_path</b>. If the ISO is a Rock Ridge ISO,
<b>rr_name</b> must be specified; otherwise, it must not be.
If the ISO is not a Joliet ISO, <b>joliet_path</b> must not
be specified. If the ISO is a Joliet ISO, <b>joliet_path</b>
is optional, but highly recommended to supply.</p>

<p style="margin-left:11%;"><b>cd &lt;iso_dir&gt;</b></p>

<p style="margin-left:22%;">Change the current working
directory to relative or absolute ISO path
<b>iso_dir</b>.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p><b>cwd</b></p></td>
<td width="5%"></td>
<td width="53%">


<p>Show the current working directory.</p></td>
<td width="25%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p><b>exit</b></p></td>
<td width="5%"></td>
<td width="53%">


<p>Exit out of pycdlib-explorer.</p></td>
<td width="25%">
</td></tr>
</table>

<p style="margin-left:11%;"><b>get &lt;iso_file&gt;
&lt;out_file&gt;</b></p>

<p style="margin-left:22%;">Copy the contents of the
relative or absolute ISO path <b>iso_file</b> into
<b>out_file</b>.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p><b>help</b></p></td>
<td width="5%"></td>
<td width="78%">


<p>Print the available commands. Use &quot;help
&lt;cmd&gt;&quot; for a more detailed description of the
commands, including the command-line arguments they
require.</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p><b>ls</b></p></td>
<td width="5%"></td>
<td width="78%">


<p>Show the contents of the current working directory. The
format of the output is: TYPE(F=file, D=directory) NAME.</p></td></tr>
</table>

<p style="margin-left:11%;"><b>mkdir &lt;iso_path&gt;
[rr_name=&lt;rr_name&gt;]
[joliet_path=&lt;joliet_path&gt;]</b></p>

<p style="margin-left:22%;">Make a new directory called
<b>iso_path</b>. If the ISO is a Rock Ridge ISO,
<b>rr_name</b> must be specified; otherwise, it must not be.
If the ISO is not a Joliet ISO, <b>joliet_path</b> must not
be specified. If the ISO is a Joliet ISO, <b>joliet_path</b>
is optional, but highly recommended to supply.</p>

<p style="margin-left:11%;"><b>print_mode
[iso9660|rr|joliet|udf]</b></p>

<p style="margin-left:22%;">Change which &rsquo;mode&rsquo;
of filenames are printed out. There are four main modes:
ISO9660 (iso9660, the default), Rock Ridge (rr), Joliet
(joliet), and UDF (udf). The original iso9660 mode only
allows filenames of 8 characters, plus 3 for the extension.
The Rock Ridge extensions allow much longer filenames and
much deeper directory structures. The Joliet extensions also
allow longer filenames and deeper directory structures, but
in an entirely different context (though in most
circumstances, the Joliet context will mirror the
ISO9660/Rock Ridge context). The UDF Bridge extensions add
an entirely parallel UDF context to the ISO as well. Any
given ISO will always have ISO9660 mode, but may have any
combination of Rock Ridge, Joliet, and UDF (including none
of them). Running this command with no arguments prints out
the current mode. Passing &rsquo;iso9660&rsquo; as an
argument sets it to the original ISO9660 mode. Passing
&rsquo;rr&rsquo; as an argument sets it to Rock Ridge mode.
Passing &rsquo;joliet&rsquo; as an argument sets it to
Joliet mode. Passing &rsquo;udf&rsquo; as an argument sets
it to UDF mode.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p><b>quit</b></p></td>
<td width="5%"></td>
<td width="44%">


<p>Exit out of pycdlib-explorer.</p></td>
<td width="34%">
</td></tr>
</table>

<p style="margin-left:11%;"><b>rm_file
&lt;iso_path&gt;</b></p>

<p style="margin-left:22%;">Remove the file named
<b>iso_path</b> from the ISO. Note that this must be a file;
to remove a directory, use <b>rmdir</b>.</p>

<p style="margin-left:11%;"><b>rmdir
&lt;iso_path&gt;</b></p>

<p style="margin-left:22%;">Remove the directory named
<b>iso_path</b> from the ISO. Note that this must be a
directory; to remove a file, use <b>rm_file</b>.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p><b>tree</b></p></td>
<td width="5%"></td>
<td width="78%">


<p>List the contents of the ISO in a tree-like format,
similar to the bash <b>tree</b> command.</p></td></tr>
</table>

<p style="margin-left:11%;"><b>write
&lt;out_file&gt;</b></p>

<p style="margin-left:22%;">Write a valid ISO9660 file out
to <b>out_file</b>, taking into account any changes made
while running the program. This is also sometimes referred
to as &quot;mastering&quot; the ISO. Note that the
<b>out_file</b> must NOT be the same file as the input file,
or the resulting ISO will not work properly.</p>

<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em">pycdlib-extract-files(1),
pycdlib-genisoimage(1)</p>

<h2>AUTHOR
<a name="AUTHOR"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">Chris
Lalancette &lt;clalancette@gmail.com&gt;</p>
<hr>
</body>
</html>