libisoburn/xorriso/xorriso-tcltk.1

135 lines
4.5 KiB
Groff

.\" Hey, EMACS: -*- nroff -*-
.\"
.\" IMPORTANT NOTE:
.\"
.\" The original of this file is kept in xorriso/xorriso-tcltk.texi
.\" This here was generated by program xorriso/make_xorriso_1
.\"
.\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH XORRISO-TCLTK 1 "Version 1.5.1, Sep 16, 2018"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.nh
.SH NAME
xorriso\-tcltk \- Educational GUI frontend for xorriso
.SH SYNOPSIS
.B xorriso-tcltk
[ options ]
.br
.SH DESCRIPTION
.PP
\fBxorriso\-tcltk\fR
demonstrates xorriso use cases by a collection of GUI components.
.br
.PP
It creates a window with buttons, editable text fields, and list boxes.
For exploration simply start
\fBxorriso\-tcltk\fR
without any options.
.br
.PP
Click on the "Help" button at the upper right edge to get an overview help
text in a separate window. It explains the three main parts of the GUI window
and it gives examples for a few main use cases of xorriso.
.br
.PP
Click by the rightmost mouse button on any button, list box, or text field,
to get a specific help text in another window.
.br
.PP
\fBxorriso\fR
is a program which copies file objects from POSIX compliant
filesystems into Rock Ridge enhanced ISO 9660 filesystems and performs
session\-wise manipulation of such filesystems. It can load the management
information of existing ISO images and it writes the session results to
optical media or to filesystem objects.
.br
Vice versa \fBxorriso\fR is able to copy file objects out of ISO 9660
filesystems.
.SS
.br
.SH OPTIONS
.br
.PP
Normally, no program options are needed when
\fBxorriso\-tcltk\fR
gets started. Some of the options are for demonstration of program development.
This man page lists only those options which may be helpful for end users.
.PP
.TP
\fB--help\fR
Print a help text with the complete list of start options and exit.
.TP
\fB--no_extract\fR
Do not allow extraction of files from ISO filesystem to
hard disk. This is not revokable during the program run.
.TP
\fB--geometry\fR {+|-}X{+|-}Y
Set the position of the main window on the screen. +0X is the left edge,
\-0X is the right edge, +0Y is the upper edge, \-0Y is the lower edge.
.TP
\fB--click_to_focus\fR
Chooses that input fields and list boxes get the keyboard
focus only when being clicked by the mouse. This is the default.
.TP
\fB--auto_focus\fR
Chooses that the keyboard focus is where the mouse pointer is.
.SH EXAMPLES
Just run
\fBxorriso\-tcltk\fR
in a shell terminal without any further arguments
.SH FILES
.SS
.B Startup files:
.br
When starting xorriso, its normal startup files get read and their text lines
get executed as commands. See section FILES in the man page of xorriso or
chapter Files in the info document of xorriso.
.SH SEE ALSO
.TP
.BR xorriso(1)
.SH BUGS
To report bugs, request help, or suggest enhancements for \fBxorriso\fR
or \fBxorriso\-tcltk\fR,
please send electronic mail to the public list <bug\-xorriso@gnu.org>.
If more privacy is desired, mail to <scdbackup@gmx.net>.
.br
Please describe what you expect the program to do,
the program arguments, GUI components, or dialog commands by which you
tried to achieve it,
the messages of \fBxorriso\fR, and the undesirable outcome of your
program run.
.br
Expect to get asked more questions before solutions can be proposed.
.SH AUTHOR
Thomas Schmitt <scdbackup@gmx.net>
.br
for libburnia\-project.org
.SH COPYRIGHT
Copyright (c) 2011 \- 2018 Thomas Schmitt
.br
Permission is granted to distribute this text freely. It shall only be
modified in sync with the technical properties of xorriso\-tcltk.
If you make use of the license to derive modified versions of xorriso\-tcltk
then you are entitled to modify this text under that same license.
.SH CREDITS
\fBxorriso\fR is in part based on work by Vreixo Formoso who provides
libisofs together with Mario Danic who also leads the libburnia team.
Thanks to Andy Polyakov who invented emulated growing,
to Derek Foreman and Ben Jansens who once founded libburn.
.br
Compliments towards Joerg Schilling whose cdrtools served me for ten years.