summaryrefslogtreecommitdiff
path: root/data
diff options
context:
space:
mode:
authorLogan Rathbone <poprocks@gmail.com>2022-01-11 23:39:40 -0500
committerLogan Rathbone <poprocks@gmail.com>2022-01-11 23:39:40 -0500
commitf139f34c514baa09100f3fd9ad556428c7d33e6f (patch)
tree8c6426934cfcbfd56408fe859ba4a77474b0e3eb /data
parent2b75b2f9a11fabff670e15139bba4b781362eca1 (diff)
downloadzenity-f139f34c514baa09100f3fd9ad556428c7d33e6f.tar.gz
help/docs: update; notification: bugfixes.
Diffstat (limited to 'data')
-rw-r--r--data/zenity.1351
1 files changed, 15 insertions, 336 deletions
diff --git a/data/zenity.1 b/data/zenity.1
index 465b580..d876044 100644
--- a/data/zenity.1
+++ b/data/zenity.1
@@ -1,4 +1,4 @@
-.TH ZENITY 1 "December 2011"
+.TH ZENITY 1 "January 2022"
.SH NAME
zenity \- display GTK+ dialogs
.SH SYNOPSIS
@@ -12,342 +12,32 @@ from the user, from all manner of shell scripts.
.PP
For example, \fBzenity \-\-question\fP will return either 0, 1 or 5,
depending on whether the user pressed \fIOK\fP, \fICancel\fP or timeout
-has been reached. \fBzenity --entry\fP will output on standard output
+has been reached. \fBzenity \-\-entry\fP will output on standard output
what the user typed into the text entry field.
.PP
-Comprehensive documentation is available in the GNOME Help Browser.
+Comprehensive documentation is also available in the GNOME Help Browser.
+
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
-.PP
-Dialog options
-
-.TP
-.B \-\-calendar
-Display calendar dialog
-.TP
-.B \-\-entry
-Display text entry dialog
-.TP
-.B \-\-error
-Display error dialog
-.TP
-.B \-\-file\-selection
-Display file selection dialog
-.TP
-.B \-\-info
-Display info dialog
-.TP
-.B \-\-list
-Display list dialog
-.TP
-.B \-\-notification
-Display notification
-.TP
-.B \-\-progress
-Display progress indication dialog
-.TP
-.B \-\-question
-Display question dialog
-.TP
-.B \-\-text-info
-Display text information dialog
-.TP
-.B \-\-warning
-Display warning dialog
-.TP
-.B \-\-scale
-Display scale dialog
-.TP
-.B \-\-color-selection
-Display color selection dialog
-.TP
-.B \-\-password
-Display password dialog
-.TP
-.B \-\-forms
-Display forms dialog
-
-.PP
-General options
-
-.TP
-.B \-\-title=TITLE
-Set the dialog title
-.TP
-.B \-\-width=WIDTH
-Set the dialog width
-.TP
-.B \-\-height=HEIGHT
-Set the dialog height
-.TP
-.B \-\-timeout=TIMEOUT
-Set the dialog timeout in seconds
-.PP
-Calendar options
-
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-day=INT
-Set the calendar day
-.TP
-.B \-\-month=INT
-Set the calendar month
-.TP
-.B \-\-year=INT
-Set the calendar year
-.TP
-.B \-\-date-format=PATTERN
-Set the format for the returned date. The default depends on the user locale or be set with the strftime style. For example %A %d/%m/%y
-
-.PP
-Text entry options
-
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-entry-text=STRING
-Set the entry text
-.TP
-.B \-\-hide-text
-Hide the entry text
-
-.PP
-Error options
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-no\-wrap
-Do not enable text wrapping
-.TP
-.B \-\-no\-markup
-Do not enable pango markup
-
-.PP
-File selection options
-.TP
-.B \-\-filename=FILENAME
-Set the file or directory to be selected by default
-.TP
-.B \-\-multiple
-Allow selection of multiple filenames in file selection dialog
-.TP
-.B \-\-directory
-Activate directory-only selection
-.TP
-.B \-\-save
-Activate save mode
-.TP
-.B \-\-separator=SEPARATOR
-Specify separator character when returning multiple filenames
-.TP
-.B \-\-confirm\-overwrite
-Confirm file selection if filename already exists
-.TP
-.B \-\-file\-filter=NAME | PATTERN1 PATTERN2
-Sets a filename filter
-
-
-.PP
-Info options
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-no\-wrap
-Do not enable text wrapping
-.TP
-.B \-\-no\-markup
-Do not enable pango markup
-
-.PP
-List options
-
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-column=STRING
-Set the column header
-.TP
-.B \-\-checklist
-Use check boxes for first column
-.TP
-.B \-\-radiolist
-Use radio buttons for first column
-.TP
-.B \-\-separator=STRING
-Set output separator character
-.TP
-.B \-\-multiple
-Allow multiple rows to be selected
-.TP
-.B \-\-editable
-Allow changes to text
-.TP
-.B \-\-print-column=NUMBER
-Specify what column to print to standard output. The default is to return
-the first column. 'ALL' may be used to print all columns.
-.TP
-.B \-\-hide\-column=NUMBER
-Hide a specific column
-.TP
-.B \-\-hide\-header
-Hides the column headers
-
-.PP
-Notification options
-
-.TP
-.B \-\-text=STRING
-Set the notification text
-.TP
-.B \-\-listen
-Listen for commands on stdin. Commands include 'message', 'tooltip', 'icon', and 'visible' separated by a colon. For example, 'message: Hello world', or 'visible: false'.
-
-.PP
-Progress options
-
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-percentage=INT
-Set initial percentage
-.TP
-.B \-\-auto\-close
-Close dialog when 100% has been reached
-.TP
-.B \-\-auto\-kill
-Kill parent process if cancel button is pressed
-.TP
-.B \-\-pulsate
-Pulsate progress bar
-.TP
-.B \-\-no\-cancel
-Hides the cancel button
+.SS
+Dialog Options
.PP
-Question options
-
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-no\-wrap
-Do not enable text wrapping
-.TP
-.B \-\-no\-markup
-Do not enable pango markup
-.TP
-.B \-\-ok\-label
-Set the text of the OK button
-.TP
-.B \-\-cancel\-label
-Set the text of the cancel button
+Options can be used in various combinations in order to craft many different
+types of dialogs.
.PP
-Text options
-
-.TP
-.B \-\-filename=FILENAME
-Open file
-.TP
-.B \-\-editable
-Allow changes to text
-.TP
-.B \-\-checkbox=TEXT
-Enable a checkbox for use like a 'I read and accept the terms.'
-.TP
-.B \-\-ok\-label
-Set the text of the OK button
-.TP
-.B \-\-cancel\-label
-Set the text of the cancel button
+For a summary of options, run \fBzenity \-\-help\fP. This will display the
+first hierarchy of options available. A separate series of help sub-categories
+for each of these options will be displayed.
.PP
-Warning options
-
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-no\-wrap
-Do not enable text wrapping
-.TP
-.B \-\-no\-markup
-Do not enable pango markup
+For a full and complete list of all options for your build and an explanation
+of these options, run \fBzenity \-\-help\-all\fP
-.PP
-Scale options
-
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-value=VALUE
-Set initial value
-.TP
-.B \-\-min\-value=VALUE
-Set minimum value
-.TP
-.B \-\-max\-value=VALUE
-Set maximum value
-.TP
-.B \-\-step=VALUE
-Set step size
-.TP
-.B \-\-print\-partial
-Print partial values
-.TP
-.B \-\-hide\-value
-Hide value
-
-.PP
-Color selection options
-
-.TP
-.B \-\-color=VALUE
-Set the initial color
-.TP
-.B \-\-show\-palette
-Show the palette
-
-.PP
-Password dialog options
-
-.TP
-.B \-\-username
-Display the username field
-
-.PP
-Forms dialog options
-
-.TP
-.B \-\-add\-entry=FIELDNAME
-Add a new Entry in forms dialog
-.TP
-.B \-\-add\-password=FIELDNAME
-Add a new Password Entry in forms dialog
-.TP
-.B \-\-add\-calendar=FIELDNAME
-Add a new Calendar in forms dialog
-.TP
-.B \-\-text=STRING
-Set the dialog text
-.TP
-.B \-\-separator=STRING
-Set output separator character
-.TP
-.B \-\-forms\-date-format=PATTERN
-Set the format for the returned date. The default depends on the user locale or be set with the strftime style. For example %A %d/%m/%y
-
-.PP
+.SS
Miscellaneous options
.TP
@@ -360,17 +50,6 @@ Display an about dialog.
.B \-\-version
Show version of program.
-.PP
-Also the standard GTK+ options are accepted. For more information about the GTK+ options, execute following command.
-.IP
-zenity \-\-help\-gtk
-
-.SH ENVIRONMENT
-
-Normally, zenity detects the terminal window from which it was launched and
-keeps itself above that window. This behavior can be disabled by unsetting the
-WINDOWID environment variable.
-
.SH EXAMPLES
Display a file selector with the title \fISelect a file to
@@ -395,7 +74,7 @@ and the text \fIFinding all header files...\fP.
.IP
find . \-name '*.h' | zenity \-\-list \-\-title "Search Results" \-\-text "Finding all header files.." \-\-column "Files"
.PP
-Show a notification in the message tray
+Show a passive notification
.IP
zenity \-\-notification \-\-icon=update.png \-\-text "System update necessary!"
.PP