diff options
Diffstat (limited to 'gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml')
| -rw-r--r-- | gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml | 402 |
1 files changed, 402 insertions, 0 deletions
diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml new file mode 100644 index 0000000..65cdcff --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml @@ -0,0 +1,402 @@ + <sect2 id="mini-commander"> + <title>Mini-Commander Applet</title> + + <para> + <application>Mini-Commander</application> applet, shown in <xref + linkend="mini-commander-applet-fig">, adds a command line to your + <interface>Panel</interface>. It features command completion, + command history, changeable macros and an optional built-in clock. + Because of the changeable macros you can use it for many different + tasks. You can simply start a program (or a short macro) or view a + web page or search for a man/info page + etc. <application>Mini-Commander</application> can be detached from + your <interface>Panel</interface> using an optional handler on the + side, which is especially usefull for people who use vertical + panels. + </para> + <para> + To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Mini-Commander</guimenuitem> + </menuchoice>. + </para> + + <figure id="mini-commander-applet-fig"> + <title>Mini-Commander Applet</title> + <screenshot> + <screeninfo>Mini-Commander Applet</screeninfo> + <graphic format="png" fileref="figures/mini-commander_applet" + srccredit="Martin Baulig"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="APPLET-usage"> + <title>Usage</title> + + <para> + To start a program or run a command, simply enter the program or + command and press return. Or, to browse for an application or command + in your filesystem, click on the small <guiicon>circle</guiicon> + in the lower corner. + </para> + <para> + <application>Mini-Commander</application> has command + completion (similar to many other user shells). Thus, you often + have not to enter the full name but only the first few characters + followed by the <keycap>tab</keycap> + key. <application>Mini-Commander</application> will try to + complete the program name in the same way most UNIX shells do. + </para> + <para> + <application>Mini-Commander</application> also has command + history, which allows you to recall previous commands by pressing + the <keycap>arrow-up</keycap> or <keycap>arrow-down</keycap> + key. This works like the command history in most UNIX shells. Note + that commands are not stored in the history if it is already + present in the history in order to avoid duplication. You may + also access the history list by pressing the small <guibutton>down + arrow icon</guibutton> in the applet and selecting a command from + the history list. + </para> + <para> + <application>Mini-Commander</application> has the ability to use + macros. It has some predefined macros. For example if + you enter + <command>term:<replaceable>command</replaceable></command> then + <command><replaceable>command</replaceable></command> is executed + in a terminal window. Or if you enter an URL then your web browser is + used to view it. Additionally you can define your own macros or + change the predefined ones. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="mini-commander-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Mini-commander + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="mini-commander-prefs"> + <title>Customization</title> + <para> + You can customize <application>Mini-Commander</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="mini-commander-settings-fig-1">), which allows you to + change various settings. + </para> + + <figure id="mini-commander-settings-fig-1"> + <title>Properties dialog: General Tab</title> + <screenshot> + <screeninfo>Properties dialog: General Tab</screeninfo> + <graphic format="png" fileref="figures/mini-commander_settings_general" + srccredit="Martin Baulig"> + </graphic> + </screenshot> + </figure> + + <para> + The properties in the <guilabel>General</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Show time — If this button is checked, the time will be + shown in the lower corner of the applet. + </para> + </listitem> + + <listitem> + <para> + Show date — If this button is checked, the date will be + shown in the lower corner of the applet. + </para> + </listitem> + + <listitem> + <para> + Show handle — If this button is checked, a handle will + be attached to the edge of the applet, allowing you to detach + the applet from the <interface>Panel</interface>. You may + re-attach the applet on the <interface>Panel</interface> by + dragging it back into place. + </para> + </listitem> + + <listitem> + <para> + Show frame — If this button is checked, a thin black + frame will be drawn around the applet. + </para> + </listitem> + + <listitem> + <para> + Enable history based auto completion — If this button is + selected, <application>Mini-Commander</application> will + automatically complete commands using the history list. + </para> + </listitem> + + <listitem> + <para> + Applet width — Enter the desired applet width here. + </para> + </listitem> + + <listitem> + <para> + Applet height — Enter the desired applet height here. + </para> + </listitem> + + <listitem> + <para> + Command line height — (This feature is disabled.) + </para> + </listitem> + + <listitem> + <para> + Command line foreground — Select the foreground color, + used for the text you enter. + </para> + </listitem> + + <listitem> + <para> + Command line background — Selecting the background + color, used for the background behind the text in the entry. + </para> + </listitem> + + </itemizedlist> + </para> + +<!-- + <figure id="mini-commander-settings-fig-2"> + <title>Properties dialog: Macros Tab</title> + <screenshot> + <screeninfo>Properties dialog: Macros Tab</screeninfo> + <graphic format="png" fileref="figures/mini-commander_settings_macros" + srccredit="Martin Baulig"> + </graphic> + </screenshot> + </figure> +--> + + <para> + The <guilabel>Macros</guilabel> tab consists of a list of up to + 99 macros, each of which is a regular expression + (<guilabel>Regex</guilabel>) and a macro + (<guilabel>Macro</guilabel>). Enter the regular expression for + <application>Mini-Commander</application> to match in the left + column, and the corresponding macro which should be executed in + the right column. The default setting has many useful macros + already defined, which may be helpful in learning to write your + own macros. + </para> + + <para> + After you have made all the changes you want, click on + <guibutton>OK</guibutton> to apply the changes and close the + <interface>Properties</interface> dialog. To cancel the changes + and return to previous values, click the + <guibutton>Close</guibutton> button. + </para> + </sect3> + + + <!-- ============= Freq. Asked Questions ==================== --> + <sect3 id="faq"> + <title>Frequently Asked Questions</title> + + <para> + Here are listed some frequently asked questions and the answers to + them. + </para> + + <qandaset> + <qandaentry> + <question> + <para> + Why am I not able to give + <application>Mini-Commander</application> keyboard focus? + </para> + </question> + <answer> + <para> + This is a confusing problem which seems to have several reasons + and which occurs only under certain conditions. + </para> + + <para> + If you cannot give <application>Mini-Commander</application> + applet keyboard focus at all then this could be a problem with + you window manager. If this is true for you it would helpful + if you write me a short mail and tell me what window manager + you are using (name and version). + </para> + + <para> + Sometimes it happens that you can give keyboard focus to + <application>Mini-Commander</application> applet only for the + first time. After this it is impossible + to focus it again. Currently the reason for this bug is + unknown. + </para> + + </answer> + </qandaentry> + + </qandaset> + </sect3> + + + <!-- ============= Bugs ================================== --> + <!-- This section should describe known bugs and limitations of + the program if there are any - please be frank and list all + problems you know of --> + <sect3 id="mini-commander-bugs"> + <title>Known Bugs and Limitations</title> + <para> + In some instances, it is impossible to give + <application>Mini-Commander</application> focus after the first + time. + </para> + </sect3> + + + <!-- ============= Further Information ==================== --> + <sect3 id="furtherinfo"> + <title>Further Information</title> + <para> + For more information on <application>Mini-Commander</application> + applet, check out its web page at <ulink + url="http://www.maruhn.com/mini-commander/"> + http://www.maruhn.com/mini-commander/</ulink>. + </para> + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="mini-commander-authors"> + <title>Authors</title> + <para> + <application>Mini-Commander</application> was written by Oliver Maruhn + (<email>oliver@maruhn.com</email>). Please send all comments, + suggestions, and bug + reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME + bug tracking database</ulink>. (Instructions for submitting bug + reports can be found <ulink + url="http://bugs.gnome.org/Reporting.html" type="http"> + on-line</ulink>. If you are using + GNOME 1.1 or later, you can also use <application>Bug Report + Tool</application> (<command>bug-buddy</command>), available in the + <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main + Menu</guimenu>, for submitting bug reports. + </para> + + <para> + This manual was written by Oliver Maruhn + (<email>oliver@maruhn.com</email>). Minor modifications and + updates were made by Dan Mueth + (<email>d-mueth@uchicago.edu</email>). Please send all comments and + suggestions regarding this manual to the <ulink type="http" + url="http://www.gnome.org/gdp">GNOME Documentation Project</ulink> + by sending an email to <email>docs@gnome.org</email>. You can also + submit comments online by using the <ulink type="http" + url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status + Table</ulink>. + </para> + + <!-- For translations: uncomment this: + + <para> + Latin translation was done by ME + (<email>MYNAME@MYADDRESS</email>). Please send all comments and + suggestions regarding this translation to SOMEWHERE. + </para> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <citetitle>GNU General Public + License</citetitle> as published by the Free Software Foundation; + either version 2 of the License, or (at your option) any later + version. + </para> + <para> + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + <citetitle>GNU General Public License</citetitle> for more details. + </para> + <para> + A copy of the <citetitle>GNU General Public License</citetitle> is + included as an appendix to the <citetitle>GNOME Users + Guide</citetitle>. You may also obtain a copy of the + <citetitle>GNU General Public License</citetitle> from the Free + Software Foundation by visiting <ulink type="http" + url="http://www.fsf.org">their Web site</ulink> or by writing to + <address> + Free Software Foundation, Inc. + <street>59 Temple Place</street> - Suite 330 + <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode> + <country>USA</country> + </address> + </para> + </sect3> + + --> + </sect2> + + + + |