<chapter id="insertcommand">
<chapterinfo>

<title>Insert Command</title>

<authorgroup>
<author>
<firstname>Anders</firstname>
<surname>Lund</surname>
<affiliation>
<address><email>anders@alweb.dk</email></address>
</affiliation>
</author>
</authorgroup>
<date>2001-05-15</date>
<releaseinfo>1.00.00</releaseinfo>
<abstract>
<para>
<!-- Note here about insert command -->
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>kate</keyword>
<keyword>insert</keyword>
</keywordset>
</chapterinfo>

<title>Introduction</title>

<para>
The <quote>Insert Command</quote> plugin allows you to insert shell command output into a document open in &kate;.
</para>

<sect1 id="insertcommand-fund">
<title>Onscreen Fundamentals</title>

<para>
<!-- Basics of using this plugin -->
To use the plugin, select <guimenu>Insert Command</guimenu> from the <guimenu>Edit</guimenu> menu, which
will present you with a small dialog for entering the command, choosing a working directory and selecting
whether to include errors (STDERR output) in the inserted text. You can also have the command string
printed above the output.
</para>

<mediaobject>
<imageobject><imagedata format="PNG" fileref="insertcommand.png"/></imageobject>
<textobject>
<phrase>The Insert Command Dialog</phrase>
</textobject>
</mediaobject>

<para>
The plugin can remember a number of commands as chosen in the configuration page. These are used
for autocompletion, and can be selected from a list in the command entry.
</para>
<para>
By default, the command will be run in the working directory of the kate process, which is usually
your home directory. This can be changed in the configuration page for the plugin.
</para>
<para>
Note that any shell command that requires user input (for example passwd) or uses a ncurses
interface or something similar (for example top) will fail to produce the expected output.
</para>
</sect1>
<sect1 id="insertcommand-config">
<title>Configuration</title>


<para>
<!-- Configuration of this plugin, if there is any, else remove this -->
<!-- section -->
To configure the <quote>Insert Command</quote> plugin, open the Kate configuration dialog from the
<guimenu>Settings</guimenu> menu and choose the Plugins/Insert Command page.
</para>
<para>
The following configuration options are available:
</para>

<sect2 id="insertcommand-config-number">
<title>Number of commands to remember</title>
<para>
This setting is presented as a spinbox which you can set to the number of commands to be remembered.
Any number from 0 to 99 is legal.
</para>
</sect2>

<sect2 id="insertcommand-config-wd">
<title>Default Working Directory</title>
<para>
This setting, presented as a set of radio buttons, allows you to decide how the working directory
of a command is chosen. The options are the working directory of the kate process (usually your home
directory when kate is started from the K menu), the directory of the document (if any, otherwise the
above option is used) or the working directory of the last command run in the plugin.
</para>
</sect2>

</sect1>

<sect1 id="insertcommand-thanks-and-acknowledgements">
<title>Thanks and Acknowledgements</title>

<para>
&kate; Plugin <quote>Insert Command</quote> copyright 2001 Anders Lund
<email>anders@alweb.dk</email>.
</para>

<para>
Documentation copyright 2001 Anders Lund <email>anders@alweb.dk</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

<!-- &underFDL; -->
&underGPL;

</sect1>
</chapter>

<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->

