~ubuntu-branches/ubuntu/precise/libisoburn/precise

« back to all changes in this revision

Viewing changes to xorriso/xorriso.texi

  • Committer: Package Import Robot
  • Author(s): George Danchev
  • Date: 2011-10-02 09:37:34 UTC
  • mfrom: (9.1.17 sid)
  • Revision ID: package-import@ubuntu.com-20111002093734-auibchjeaecfhofu
Tags: 1.1.6-2
Fix funny typo in xorriso binary package description.
Thanks to Davide Prina (Closes: #643993).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
\input texinfo @c -*-texinfo-*-
2
2
@c %**start of header
3
3
@setfilename xorriso.info
4
 
@settitle GNU xorriso 1.1.2
 
4
@settitle GNU xorriso 1.1.6
5
5
@c %**end of header
6
6
@c
7
7
@c man-ignore-lines begin
50
50
@c man .\" First parameter, NAME, should be all caps
51
51
@c man .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
52
52
@c man .\" other parameters are allowed: see man(7), man(1)
53
 
@c man .TH XORRISO 1 "Version 1.1.2, Jul 08, 2011"
 
53
@c man .TH XORRISO 1 "Version 1.1.6, Sep 27, 2011"
54
54
@c man .\" Please adjust this date whenever revising the manpage.
55
55
@c man .\"
56
56
@c man .\" Some roff macros, for reference:
77
77
@end copying
78
78
@c man-ignore-lines end
79
79
@titlepage
80
 
@title Manual of GNU xorriso 1.1.2
 
80
@title Manual of GNU xorriso 1.1.6
81
81
@author Thomas Schmitt
82
82
@page
83
83
@vskip 0pt plus 1filll
86
86
@contents
87
87
@ifnottex
88
88
@node Top
89
 
@top GNU xorriso 1.1.2
 
89
@top GNU xorriso 1.1.6
90
90
@c man-ignore-lines 1
91
91
 
92
92
@c man .SH NAME
431
431
@*
432
432
Get a list of accessible drives by command
433
433
@*
434
 
  -devices
 
434
  -device_links
435
435
@*
436
436
It might be necessary to do this as
437
437
@strong{superuser}
561
561
that entry exists. Nevertheless the non-listed group members get handled
562
562
according to entry "group::". When removing ACL from a file,
563
563
@command{xorriso} brings "group::" into effect.
 
564
@*
 
565
Recording and restoring of ACLs from and to local files works currently
 
566
only on GNU/Linux and FreeBSD.
564
567
@c man .PP
565
568
@sp 1
566
569
@cindex xattr, _definiton
567
 
@strong{xattr} (aka EA)
 
570
@cindex EA, _definiton
 
571
@cindex extattr, _definiton
 
572
@strong{xattr} (aka EA, or extattr)
568
573
are pairs of name and value which can be attached to file objects. AAIP is
569
574
able to represent them and @command{xorriso} allows to record and restore
570
575
pairs which
577
582
As with ACL, currently only @command{xorriso} is able to retrieve xattr
578
583
from AAIP enhanced images, to restore them to xattr capable file systems,
579
584
or to print them. 
 
585
@*
 
586
Recording and restoring of xattr from and to local files works currently
 
587
only on GNU/Linux and FreeBSD, where they are known as extattr. 
580
588
@c man .SS
581
589
@node Processing, Dialog, Extras, top
582
590
@chapter Command processing
2124
2132
except ACL to the result channel. This is mostly for debugging of
2125
2133
namespace "isofs".
2126
2134
@*
 
2135
@item list_extattr mode
 
2136
prints a script to the result channel, which would use FreeBSD command
 
2137
setextattr to set the file's xattr name-value pairs of user namespace.
 
2138
Parameter mode controls the form of the output of names and values.
 
2139
Default mode "e" prints harmless characters in shell quotation marks,
 
2140
but represents texts with octal 001 to 037 and 0177 to 0377 by an embedded
 
2141
echo -e command.
 
2142
Mode "q" prints any characters in shell quotation marks. This might not be
 
2143
terminal-safe but should work in script files.
 
2144
Mode "r" uses no quotation marks. Not safe.
 
2145
Mode "b" prints backslash encoding. Not suitable for shell parsing.
 
2146
@*
 
2147
E.g. -exec list_extattr e --
 
2148
@*
 
2149
Option -backslash_codes does not affect the output.
 
2150
@*
2127
2151
@item get_md5
2128
2152
prints the MD5 sum, if recorded, together with file path.
2129
2153
@*
2469
2493
@item -list_speeds
2470
2494
@kindex -list_speeds   lists available write speeds
2471
2495
@cindex Media, list write speeds, -list_speeds
2472
 
Put out a list of speed values as reported by the output drive for
2473
 
the loaded media. At the end of the list, "Write speed L" and "Write speed H"
 
2496
Put out a list of speed values as reported by the output drive with
 
2497
the loaded media. This does not necessarily mean that the media is writable
 
2498
or that these speeds are actually achievable. Especially the
 
2499
lists reported with empty drive or with ROM media obviously advertise
 
2500
speeds for other media.
 
2501
@*
 
2502
It is not mandatory to use speed values out of the listed range.
 
2503
The drive is supposed to choose a safe speed that is as near to the desired
 
2504
speed as possible.
 
2505
@*
 
2506
At the end of the list, "Write speed L" and "Write speed H"
2474
2507
are the best guesses for lower and upper speed limit.
2475
 
@*
2476
2508
"Write speed l" and "Write speed h" may appear only with CD
2477
2509
and eventually override the list of other speed offers.
2478
 
@*
2479
 
It is not mandatory to use speed values out of the listed range.
2480
 
The drive is supposed to choose a safe speed that is as near to the desired
2481
 
speed as possible.
2482
2510
@c man .TP
2483
2511
@item -close_damaged "as_needed"|"force"
2484
2512
@kindex -close_damaged   closes damaged track and session
3608
3636
@*
3609
3637
Drives which are occupied by other processes get not shown.
3610
3638
@c man .TP
 
3639
@item -device_links
 
3640
@kindex -device_links   gets list of drives
 
3641
@cindex Drive, get drive list, -device_links
 
3642
Like -devices, but presenting the drives with addresses of symbolic links
 
3643
which point to the actual device files.
 
3644
@*
 
3645
Modern GNU/Linux systems may shuffle drive addresses from boot to boot.
 
3646
The udev daemon is supposed to create links which always point to the
 
3647
same drive, regardless of its system address.
 
3648
The command -device_links shows the addresses of such links if they begin
 
3649
by "/dev/dvd" or "/dev/cd".
 
3650
Precedence is: "dvdrw", "cdrw", "dvd", "cdrom", "cd".
 
3651
@c man .TP
3611
3652
@item -toc
3612
3653
@*
3613
3654
@kindex -toc   shows list of sessions
3902
3943
found files together will occupy in the emerging ISO image.
3903
3944
This does not account for the superblock,
3904
3945
for the directories in the -findx path, or for image padding.
 
3946
@*
 
3947
@item list_extattr mode
 
3948
prints a script to the result channel, which would use FreeBSD command
 
3949
setextattr to set the file's xattr name-value pairs of user namespace.
 
3950
See -find for a description of parameter mode.
 
3951
@*
 
3952
E.g. -exec list_extattr e --
3905
3953
@end table
3906
3954
@c man .TP
3907
3955
@item -compare disk_path iso_rr_path
4055
4103
@item what="disc"
4056
4104
scans the payload range of a media without respecting track gaps.
4057
4105
@*
 
4106
@item what="image"
 
4107
similar to "disc", but restricts scanning to the range of the ISO 9660 image,
 
4108
if present.
 
4109
@*
4058
4110
@item min_lba=limit
4059
4111
omits all blocks with addresses lower than limit.
4060
4112
@*
4220
4272
get acquired while "o_excl_off" will refuse to get blanked, formatted, 
4221
4273
written, or ejected. But be aware that even harmless inquiries can spoil
4222
4274
ongoing burns of CD-R[W] and DVD-R[W].
 
4275
@*
 
4276
Option "strict_acl_off" is default. It tolerates on FreeBSD the presence of
 
4277
directory "default" ACLs in the ISO image. With "strict_acl_on" these
 
4278
GNU/Linux ACLs cause on FreeBSD a FAILURE event during restore with -acl "on".
4223
4279
@c man .TP
4224
4280
@item -extract iso_rr_path disk_path
4225
4281
@kindex -extract   copies file tree to disk
4599
4655
@cindex Program, print version, -version
4600
4656
Print program name and version, component versions, license.
4601
4657
@c man .TP
 
4658
@item -list_extras code
 
4659
@kindex -list_extras   lists compile time extra features
 
4660
@cindex Program, list extra features, -list_extras
 
4661
Tell whether certain extra features were enabled at compile time.
 
4662
Code "all" lists all features and a headline.
 
4663
Other codes pick a single feature.
 
4664
Code "codes" lists them. They share names with related commands
 
4665
(see also there):
 
4666
@*
 
4667
"acl" tells whether xorriso has an adapter for local filesystems ACLs.
 
4668
@*
 
4669
"xattr" tells whether xorriso has an adapter for local filesystems EA.
 
4670
@*
 
4671
"jigdo" tells whether production of Jigdo files is possible.
 
4672
@*
 
4673
"zisofs" tells whether zisofs and built-in gzip filters are enabled.
 
4674
@*
 
4675
"external_filter" tells whether external filter processes are allowed
 
4676
and whether they are allowed if real user id and effective user id differ.
 
4677
@*
 
4678
"dvd_obs" tells whether 64 kB output to DVD media is default.
 
4679
@*
 
4680
"use_readline" tells whether readline may be enabled in dialog mode.
 
4681
@*
 
4682
@c man .TP
4602
4683
@item -history textline
4603
4684
@kindex -history   brings text into readline history
4604
4685
@cindex Dialog, bring text into history, -history
4890
4971
"base,sys_devices" and to give r-permission to user or group.
4891
4972
@*
4892
4973
@sp 1
4893
 
$ xorriso -devices
4894
 
@*
4895
 
0  -dev '/dev/sr0' rwrw@minus{}@minus{} :  '_NEC    ' 'DVD_RW ND-4570A'
4896
 
@*
4897
 
1  -dev '/dev/sr1' rwrw@minus{}@minus{} :  'HL-DT-ST' 'DVDRAM GSA-4082B' 
4898
 
@*
4899
 
2  -dev '/dev/sr2' rwrw@minus{}@minus{} :  'PHILIPS ' 'SPD3300L' 
 
4974
$ xorriso -device_links
 
4975
@*
 
4976
1  -dev '/dev/cdrom1' rwrw@minus{}@minus{} :  'TSSTcorp' 'DVD-ROM SH-D162C
 
4977
@*
 
4978
1  -dev '/dev/cdrw'   rwrw@minus{}@minus{} :  'TSSTcorp' 'CDDVDW SH-S223B'
 
4979
@*
 
4980
2  -dev '/dev/cdrw3'  rwrw@minus{}@minus{} :  'HL-DT-ST' 'BDDVDRW_GGC-H20L'
4900
4981
@c man .SS
4901
4982
@c man .B Blank media and compose a new ISO image as batch run
4902
4983
@node ExCreate, ExDialog, ExDevices, Examples
5564
5645
@c man .TP
5565
5646
@c man MD5 checksums
5566
5647
@c man .BR md5sum(1)
 
5648
@c man .TP
 
5649
@c man On FreeBSD the commands for xattr and MD5 differ
 
5650
@c man .BR getextattr(8),
 
5651
@c man .BR setextattr(8),
 
5652
@c man .BR md5(1)
5567
5653
@c man-ignore-lines begin
5568
5654
@node Seealso, Bugreport, Files, Top 
5569
5655
@chapter See also
5589
5675
setfattr(1)
5590
5676
@item MD5 checksums
5591
5677
md5sum(1)
 
5678
@item On FreeBSD some commands differ:
 
5679
getextattr(8),
 
5680
setextattr(8),
 
5681
md5(1)
5592
5682
@end table
5593
5683
@c man-ignore-lines end
5594
5684
@c man .SH BUGS