Accessories

Browse Download file Permalink

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY firstname "Pierre">

<!ENTITY surname "Pronchery">

<!ENTITY username "khorben">

<!ENTITY email "khorben@defora.org">

<!ENTITY section "1">

<!ENTITY title "Accessories User Manual">

<!ENTITY package "DeforaOS Accessories">

<!ENTITY name "progress">

<!ENTITY purpose "Generic progress bar utility">

<title>&title;</title>

<productname>&package;</productname>

<firstname>&firstname;</firstname>

<surname>&surname;</surname>

<contrib>Code and documentation.</contrib>

<email>&email;</email>

</address>

</author>

</authorgroup>

<holder>&firstname; &surname; <&email;></holder>

</copyright>

<para>This manual page was written for the DeforaOS Project (and may be

used by others).</para>

<para>Permission is granted to copy, distribute and/or modify this

document under the terms of the GNU General Public License,

Version 3 as published by the Free Software Foundation.</para>

</legalnotice>

</refentryinfo>

<manvolnum>&section;</manvolnum>

</refmeta>

<refpurpose>&purpose;</refpurpose>

</refnamediv>

<replaceable>buffersize</replaceable></arg>

<replaceable>length</replaceable></arg>

<replaceable>prefix</replaceable></arg>

<replaceable>title</replaceable></arg>

<arg choice="plain"><replaceable>command</replaceable></arg>

</cmdsynopsis>

</refsynopsisdiv>

<title>Description</title>

<para><command>&name;</command> can be used to report on the progress of

Input/Output (I/O) operations, like when manipulating files and

devices. It expects data either from the standard input or from a file, and

forwards it over to a separate process through the standard input

again. It reports continuously on data throughput while doing so.</para>

<para>Additionally, it can be embedded within an existing window, like in the

notification area of a panel window.</para>

</refsect1>

<title>Options</title>

<para>The following options are available:</para>

<para>Enforce the size of the intermediate buffer.</para>

</listitem>

</varlistentry>

<para>Ignored for compatibility reasons.</para>

</listitem>

</varlistentry>

<para>File to use for incoming data instead of the standard input.</para>

</listitem>

</varlistentry>

<para>Specify or override the estimation of the data size.</para>

</listitem>

</varlistentry>

<para>Text to display before the progress bar.</para>

</listitem>

</varlistentry>

<para>Sets the title of the progress window.</para>

</listitem>

</varlistentry>

<para>Uncompress the input on the fly using

<command>gunzip<manvolnum>1</manvolnum></command>.</para>

</listitem>

</varlistentry>

</variablelist>

<para>A command to execute must be provided on the command line, with an

arbitrary number of arguments. It is then executed, with the incoming data

forwarded to this sub-process over the standard input.</para>

</refsect1>

<para>Issues can be listed and reported at <ulink

url="http://www.defora.org/os/project/bug_list/235/Accessories"/>.</para>

</refsect1>

<para>

</citerefentry>,

<refentrytitle>gunzip</refentrytitle>

</citerefentry>,

<refentrytitle>panel-embed</refentrytitle>

</citerefentry>,

</citerefentry>

</para>

</refsect1>

</refentry>