diff options
Diffstat (limited to 'help/en_GB/progress.page')
-rw-r--r-- | help/en_GB/progress.page | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/help/en_GB/progress.page b/help/en_GB/progress.page new file mode 100644 index 00000000..1db90862 --- /dev/null +++ b/help/en_GB/progress.page @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="progress" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--progress</cmd> option.</desc> + </info> + <title>Progress Dialogue</title> + <p> + Use the <cmd>--progress</cmd> option to create a progress dialog. + </p> + + <p> + <app>Zenity</app> reads data from standard input line by line. If a line is prefixed with #, the text is updated with the text on that line. If a line contains only a number, the percentage is updated with that number. + </p> + + <p>The progress dialogue supports the following options:</p> + + <terms> + + <item> + <title><cmd>--text</cmd>=<var>text</var></title> + <p>Specifies the text that is displayed in the progress dialogue.</p> + </item> + + <item> + <title><cmd>--percentage</cmd>=<var>percentage</var></title> + <p>Specifies the initial percentage that is set in the progress dialogue.</p> + </item> + + <item> + <title><cmd>--auto-close</cmd></title> + <p>Closes the progress dialogue when 100% has been reached.</p> + </item> + + <item> + <title><cmd>--pulsate</cmd></title> + <p>Specifies that the progress bar pulsates until an EOF character is read from standard input.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a progress dialog: + </p> + +<code> +#!/bin/sh +( +echo "10" ; sleep 1 +echo "# Updating mail logs" ; sleep 1 +echo "20" ; sleep 1 +echo "# Resetting cron jobs" ; sleep 1 +echo "50" ; sleep 1 +echo "This line will just be ignored" ; sleep 1 +echo "75" ; sleep 1 +echo "# Rebooting system" ; sleep 1 +echo "100" ; sleep 1 +) | +zenity --progress \ + --title="Update System Logs" \ + --text="Scanning mail logs..." \ + --percentage=0 + +if [ "$?" = -1 ] ; then + zenity --error \ + --text="Update canceled." +fi +</code> + + + <figure> + <title>Progress Dialogue Example</title> + <desc><app>Zenity</app> progress dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-progress-screenshot.png"/> + </figure> +</page> |