scripts/man/xdg-file-dialog.1

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "XDG-FILE-DIALOG" 1 "" "" "xdg-file-dialog Manual"
.SH NAME
xdg-file-dialog \- command line tool for providing file and directory selection dialogs
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 16
\fBxdg\-file\-dialog\fR openfilename [\fB\-\-title\ \fITITLE\fR\fR] [\fIFILENAME\fR]
.ad
.hy
.ad l
.hy 0
.HP 16
\fBxdg\-file\-dialog\fR openfilenamelist [\fB\-\-title\ \fITITLE\fR\fR] [\fIFILENAME\fR]
.ad
.hy
.ad l
.hy 0
.HP 16
\fBxdg\-file\-dialog\fR savefilename [\fB\-\-title\ \fITITLE\fR\fR] [\fIFILENAME\fR]
.ad
.hy
.ad l
.hy 0
.HP 16
\fBxdg\-file\-dialog\fR directory [\fB\-\-title\ \fITITLE\fR\fR] [\fIDIRNAME\fR]
.ad
.hy
.ad l
.hy 0
.HP 16
\fBxdg\-file\-dialog\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR}
.ad
.hy

.SH "DESCRIPTION"

.PP
The xdg\-file\-dialog program can be used to let the native file selection dialog handle file and directory input\&.

.PP
xdg\-file\-dialog is for use inside a desktop session only\&. It is not recommended to use xdg\-file\-dialog as root\&.

.SH "COMMANDS"

.TP
openfilename
Returns the filename with path for a file to read from\&. \fIFILENAME\fR can optionally be used to specify path and filename of a preselection\&.

.TP
openfilenamelist
Returns one or more filenames with path for files to read from, each on a new line\&. \fIFILENAME\fR can optionally be used to specify path and filename of a preselection\&.

.TP
savefilename
Returns the filename with path for file to write to\&. \fIFILENAME\fR can optionally be used to specify path and filename of a preselection\&.

.TP
directory
Returns the path for an exsiting directory\&. \fIDIRNAME\fR can optionally be used to specify a path of a preselection\&.

.SH "OPTIONS"

.TP
\fB\-\-title\fR \fITITLE\fR
Sets the dialog's title (caption) to the specified text\&.

.TP
\fB\-\-help\fR
Show command synopsis\&.

.TP
\fB\-\-manual\fR
Show this manualpage\&.

.TP
\fB\-\-version\fR
Show the xdg\-utils version information\&.

.SH "EXIT CODES"

.PP
An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned:

.TP
\fB1\fR
Error in command line syntax\&.

.TP
\fB2\fR
One of the files passed on the command line did not exist\&.

.TP
\fB3\fR
A required tool could not be found\&.

.TP
\fB4\fR
The action failed\&.

.SH "EXAMPLES"

.PP
 

.nf

xdg\-file\-dialog savefilename /tmp/foobar\&.png

.fi
 Asks for a save file name starting in directory /tmp and suggesting foobar\&.png as the filename

.PP
 

.nf

xdg\-file\-dialog directory \-\-title "Select a target folder" /tmp

.fi
 Asks for a directory name starting in directory /tmp using the text "Select a target folder" as the dialog's title/caption\&.

.SH AUTHOR
Kevin Krammer.