doc/kwrite/index.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
0003 "dtd/kdedbx45.dtd" [
0004 <!ENTITY kappname "&kwrite;">
0005 <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0006 ]>
0007
0008 <article id="kwrite" lang="&language;">
0009
0010 <articleinfo>
0011 <title>The &kwrite; Handbook</title>
0012 <authorgroup>
0013 <author>&TC.Hollingsworth; &TC.Hollingsworth.mail;</author>
0014 <othercredit role="developer">
0015 &Christoph.Cullmann; &Christoph.Cullmann.mail;
0016 <!-- <contrib>Core Developer and Maintainer</contrib> -->
0017 </othercredit>
0018
0019 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0020
0021 </authorgroup>
0022
0023 <copyright>
0024 <year>2014</year>
0025 <holder>&TC.Hollingsworth; &TC.Hollingsworth.mail;</holder>
0026 </copyright>
0027 <legalnotice>&FDLNotice;</legalnotice>
0028
0029 <date>2021-09-02</date>
0030 <releaseinfo>KDE Gear 21.12</releaseinfo>
0031
0032 <abstract>
0033 <para>&kwrite; is a text editor by &kde; allowing you to edit one file at the time per window.</para>
0034 </abstract>
0035
0036 <keywordset>
0037 <keyword>KDE</keyword>
0038 <keyword>KWrite</keyword>
0039 <keyword>text</keyword>
0040 <keyword>editor</keyword>
0041 </keywordset>
0042
0043 </articleinfo>
0044
0045 <sect1 id="introduction">
0046 <title>Introduction</title>
0047
0048 <para>
0049 &kwrite; is more than a text editor by &kde;. It is meant
0050 to be a programmer's editor, and could be considered as at least a
0051 partial alternative to more powerful editors.  It may be best used in
0052 conjunction with &konqueror; or &dolphin; for source file browsing for different
0053 languages. &kwrite; also works very well as a simple text editor.  One
0054 of &kwrite;'s main features is the colorized syntax, customized for many
0055 different programming languages such as: C/C++, &Java;, Python, Perl,
0056 Bash, Modula 2, &HTML;, and Ada.  &kwrite; has a single document interface
0057 (<acronym>SDI</acronym>) allowing you to edit one file at the time per window.
0058 </para>
0059
0060 <para>
0061 &kwrite; is a simple interface to the &katepart; component also used by &kate;,
0062 &kdevelop;, and other applications from &kde; that require advanced text editing.
0063 Therefore, complete documentation for all the features of &kwrite; can be found
0064 in the <ulink url="help:/katepart">&katepart; Handbook</ulink>.
0065 </para>
0066 </sect1>
0067
0068 <sect1 id="command-line-options">
0069 <title>Command Line Options</title>
0070
0071 <para>
0072 Though &kwrite; may most often be started from the &plasma; application starter, or
0073 a desktop icon, it can also be opened at the command line prompt of a
0074 terminal window.  There are a few useful options that are available when
0075 doing this.
0076 </para>
0077
0078 <para>Many other applications that use &katepart; offer similar command line
0079 options.</para>
0080
0081 <sect2 id="specify-a-file">
0082 <title>Specify a File</title>
0083
0084 <para>By specifying the path and name of a particular file the user can
0085 have &kwrite; open (or create) that file immediately upon startup.  This
0086 option might look something like the following:</para>
0087
0088 <informalexample><screen>
0089 <prompt>%</prompt> <userinput><command>kwrite</command>
0090 <option><replaceable>/home/myhome/docs/myfile.txt</replaceable></option>
0091 </userinput>
0092 </screen>
0093 </informalexample>
0094 </sect2>
0095 <sect2 id="editing-files-on-the-internet">
0096 <title>Specify a file on the Internet</title>
0097
0098 <para>The above-mentioned method could even be used to open files on the
0099 Internet (if the user has an active connection at the time.)  An example of
0100 this might look like the following:</para>
0101
0102 <informalexample><screen>
0103 <prompt>%</prompt> <userinput><command>kwrite</command>
0104 <option><replaceable>ftp://ftp.kde.org/pub/kde/README</replaceable>
0105 </option></userinput>
0106 </screen>
0107 </informalexample>
0108
0109 </sect2>
0110
0111 <sect2 id="other-command-line-options">
0112 <title>Other Command Line Options</title>
0113
0114 <para>The following command line help options are available</para>
0115
0116 <variablelist>
0117
0118 <varlistentry>
0119 <term><userinput><command>kwrite</command>
0120 <option>--help</option></userinput></term>
0121 <listitem><para>This lists the most basic options available at the command
0122 line.</para></listitem>
0123 </varlistentry>
0124
0125 <varlistentry>
0126 <term><userinput><command>kwrite</command>
0127 <option>--author</option></userinput></term>
0128 <listitem><para>Lists &kwrite;'s authors in the terminal
0129 window.</para></listitem>
0130 </varlistentry>
0131 <varlistentry>
0132
0133 <term><userinput><command>kwrite</command>
0134 <option>-v</option>, <option>--version</option></userinput></term>
0135 <listitem><para>Lists version information for the application.</para></listitem>
0136 </varlistentry>
0137
0138 <varlistentry>
0139 <term><userinput><command>kwrite</command>
0140 <option>--license</option></userinput></term>
0141 <listitem>
0142 <para>Shows license information.</para>
0143 </listitem>
0144 </varlistentry>
0145
0146 <varlistentry>
0147 <term><userinput><command>kwrite</command>
0148 <option>--desktopfile</option> <parameter>filename</parameter></userinput></term>
0149 <listitem><para>The base file name of the desktop entry for this application.</para>
0150 <para>This is in particular useful for wrapper applications and
0151 applications having in general multiple desktop files. Thus each desktop
0152 file can have its own command line for the <option>Exec</option> entry.
0153 </para></listitem>
0154 </varlistentry>
0155
0156 <varlistentry>
0157 <term><userinput><command>kwrite</command>
0158 <option>-e</option>, <option>--encoding</option> <parameter>encoding</parameter>
0159 </userinput></term>
0160 <listitem><para>Causes &kwrite; to use the specified encoding for the document.
0161 </para></listitem>
0162 </varlistentry>
0163
0164 <varlistentry>
0165 <term><userinput><command>kwrite</command>
0166 <option>-l</option>, <option>--line</option> <parameter>line</parameter>
0167 </userinput></term>
0168 <listitem><para>Navigate to the specified line after opening the document.
0169 </para></listitem>
0170 </varlistentry>
0171
0172 <varlistentry>
0173 <term><userinput><command>kwrite</command>
0174 <option>-c</option>, <option>--column</option> <parameter>column</parameter>
0175 </userinput></term>
0176 <listitem><para>Navigate to the specified column after opening the document.
0177 </para></listitem>
0178 </varlistentry>
0179
0180 <varlistentry>
0181 <term><userinput><command>kwrite</command>
0182 <option>-i</option>, <option>--stdin</option></userinput></term>
0183 <listitem><para>Causes &kwrite; to read the document content from STDIN. This
0184 is similar to the common option <option>-</option> used in many command line
0185 programs, and allows you to pipe command output into &kwrite;.</para></listitem>
0186 </varlistentry>
0187
0188 </variablelist>
0189 </sect2>
0190 </sect1>
0191
0192 <sect1 id="credits">
0193 <title>Credits and License</title>
0194
0195 <para>&kwrite; Copyright 2001-2014 by the &kate; team.</para>
0196
0197 <para>
0198 Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy
0199 <email>digisnap@cs.tu-berlin.de</email>
0200 </para>
0201
0202 <para>Contributions:</para>
0203
0204 <itemizedlist>
0205 <listitem>
0206 <para>&Christoph.Cullmann; &Christoph.Cullmann.mail;</para>
0207 </listitem>
0208
0209 <listitem>
0210 <para>Michael Bartl <email>michael.bartl1@chello.at</email></para>
0211 </listitem>
0212
0213 <listitem>
0214 <para>Phlip <email>phlip_cpp@my-deja.com</email></para>
0215 </listitem>
0216
0217 <listitem>
0218 <para>&Anders.Lund; &Anders.Lund.mail;</para>
0219 </listitem>
0220
0221 <listitem>
0222 <para>Matt Newell <email>newellm@proaxis.com</email></para>
0223 </listitem>
0224
0225 <listitem>
0226 <para>&Joseph.Wenninger; &Joseph.Wenninger.mail;</para>
0227 </listitem>
0228
0229 <listitem>
0230 <para>Jochen Wilhelmy <email>digisnap@cs.tu-berlin.de</email></para>
0231 </listitem>
0232
0233 <listitem>
0234 <para>&Michael.Koch; &Michael.Koch.mail;</para>
0235 </listitem>
0236
0237 <listitem>
0238 <para>&Christian.Gebauer; &Christian.Gebauer.mail;</para>
0239 </listitem>
0240
0241 <listitem>
0242 <para>&Simon.Hausmann; &Simon.Hausmann.mail;</para>
0243 </listitem>
0244
0245 <listitem>
0246 <para>Glen Parker <email>glenebob@nwlink.com</email></para>
0247 </listitem>
0248
0249 <listitem>
0250 <para>Scott Manson <email>sdmanson@altel.net</email></para>
0251 </listitem>
0252
0253 <listitem>
0254 <para>&John.Firebaugh; &John.Firebaugh.mail;</para>
0255 </listitem>
0256 </itemizedlist>
0257
0258 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0259
0260 &underFDL;
0261 &underGPL;
0262 </sect1>
0263
0264 </article>
0265 <!--
0266 Local Variables:
0267 mode: sgml
0268 sgml-namecase-general: t
0269 sgml-namecase-entity: nil
0270 sgml-general-insert-case: lower
0271 sgml-minimize-attributes: nil
0272 sgml-omittag: nil
0273 End:
0274 -->