Changeset View
Changeset View
Standalone View
Standalone View
doc/kwrite/index.docbook
| Show All 20 Lines | |||||
| 21 | </authorgroup> | 21 | </authorgroup> | ||
| 22 | 22 | | |||
| 23 | <copyright> | 23 | <copyright> | ||
| 24 | <year>2014</year> | 24 | <year>2014</year> | ||
| 25 | <holder>&TC.Hollingsworth; &TC.Hollingsworth.mail;</holder> | 25 | <holder>&TC.Hollingsworth; &TC.Hollingsworth.mail;</holder> | ||
| 26 | </copyright> | 26 | </copyright> | ||
| 27 | <legalnotice>&FDLNotice;</legalnotice> | 27 | <legalnotice>&FDLNotice;</legalnotice> | ||
| 28 | 28 | | |||
| 29 | <date>2018-03-26</date> | 29 | <date>2018-05-19</date> | ||
| 30 | <releaseinfo>Applications 18.04</releaseinfo> | 30 | <releaseinfo>Applications 18.08</releaseinfo> | ||
| 31 | 31 | | |||
| 32 | <abstract> | 32 | <abstract> | ||
| 33 | <para>&kwrite; is a text editor by &kde; allowing you to edit one file at the time per window.</para> | 33 | <para>&kwrite; is a text editor by &kde; allowing you to edit one file at the time per window.</para> | ||
| 34 | </abstract> | 34 | </abstract> | ||
| 35 | 35 | | |||
| 36 | <keywordset> | 36 | <keywordset> | ||
| 37 | <keyword>KDE</keyword> | 37 | <keyword>KDE</keyword> | ||
| 38 | <keyword>KWrite</keyword> | 38 | <keyword>KWrite</keyword> | ||
| Show All 21 Lines | |||||
| 60 | <para> | 60 | <para> | ||
| 61 | &kwrite; is a simple interface to the &katepart; component also used by &kate;, | 61 | &kwrite; is a simple interface to the &katepart; component also used by &kate;, | ||
| 62 | KDevelop, and other applications from &kde; that require advanced text editing. | 62 | KDevelop, and other applications from &kde; that require advanced text editing. | ||
| 63 | Therefore, complete documentation for all the features of &kwrite; can be found | 63 | Therefore, complete documentation for all the features of &kwrite; can be found | ||
| 64 | in the <ulink url="help:/katepart">&katepart; Handbook</ulink>. | 64 | in the <ulink url="help:/katepart">&katepart; Handbook</ulink>. | ||
| 65 | </para> | 65 | </para> | ||
| 66 | </sect1> | 66 | </sect1> | ||
| 67 | 67 | | |||
| 68 | <sect1 id="command-line-options"> | ||||
| 69 | <title>Command Line Options</title> | ||||
| 70 | | ||||
| 71 | <para> | ||||
| 72 | Though &kwrite; may most often be started from the &plasma; application starter, or | ||||
| 73 | a desktop icon, it can also be opened at the command line prompt of a | ||||
| 74 | terminal window. There are a few useful options that are available when | ||||
| 75 | doing this. | ||||
| 76 | </para> | ||||
| 77 | | ||||
| 78 | <para>Many other applications that use &katepart; offer similar command line | ||||
| 79 | options.</para> | ||||
| 80 | | ||||
| 81 | <sect2 id="specify-a-file"> | ||||
| 82 | <title>Specify a File</title> | ||||
| 83 | | ||||
| 84 | <para>By specifying the path and name of a particular file the user can | ||||
| 85 | have &kwrite; open (or create) that file immediately upon startup. This | ||||
| 86 | option might look something like the following:</para> | ||||
| 87 | | ||||
| 88 | <informalexample><screen> | ||||
| 89 | <prompt>%</prompt> <userinput><command>kwrite</command> | ||||
| 90 | <option><replaceable>/home/myhome/docs/myfile.txt</replaceable></option> | ||||
| 91 | </userinput> | ||||
| 92 | </screen> | ||||
| 93 | </informalexample> | ||||
| 94 | </sect2> | ||||
| 95 | <sect2 id="editing-files-on-the-internet"> | ||||
| 96 | <title>Specify a file on the Internet</title> | ||||
| 97 | | ||||
| 98 | <para>The above-mentioned method could even be used to open files on the | ||||
| 99 | Internet (if the user has an active connection at the time.) An example of | ||||
| 100 | this might look like the following:</para> | ||||
| 101 | | ||||
| 102 | <informalexample><screen> | ||||
| 103 | <prompt>%</prompt> <userinput><command>kwrite</command> | ||||
| 104 | <option><replaceable>ftp://ftp.kde.org/pub/kde/README</replaceable> | ||||
| 105 | </option></userinput> | ||||
| 106 | </screen> | ||||
| 107 | </informalexample> | ||||
| 108 | | ||||
| 109 | </sect2> | ||||
| 110 | | ||||
| 111 | <sect2 id="other-command-line-options"> | ||||
| 112 | <title>Other Command Line Options</title> | ||||
| 113 | | ||||
| 114 | <para>The following command line help options are available</para> | ||||
| 115 | | ||||
| 116 | <variablelist> | ||||
| 117 | | ||||
| 118 | <varlistentry> | ||||
| 119 | <term><userinput><command>kwrite</command> | ||||
| 120 | <option>--help</option></userinput></term> | ||||
| 121 | <listitem><para>This lists the most basic options available at the command | ||||
| 122 | line.</para></listitem> | ||||
| 123 | </varlistentry> | ||||
| 124 | | ||||
| 125 | <varlistentry> | ||||
| 126 | <term><userinput><command>kwrite</command> | ||||
| 127 | <option>--author</option></userinput></term> | ||||
| 128 | <listitem><para>Lists &kwrite;'s authors in the terminal | ||||
| 129 | window</para></listitem> | ||||
| 130 | </varlistentry> | ||||
| 131 | <varlistentry> | ||||
| 132 | | ||||
| 133 | <term><userinput><command>kwrite</command> | ||||
| 134 | <option>-v</option>, <option>--version</option></userinput></term> | ||||
| 135 | <listitem><para>Lists version information for the application.</para></listitem> | ||||
| 136 | </varlistentry> | ||||
| 137 | | ||||
| 138 | <varlistentry> | ||||
| 139 | <term><userinput><command>&kwrite;</command> | ||||
| 140 | <option>--license</option></userinput></term> | ||||
| 141 | <listitem> | ||||
| 142 | <para>Shows license information.</para> | ||||
| 143 | </listitem> | ||||
| 144 | </varlistentry> | ||||
| 145 | | ||||
| 146 | <varlistentry> | ||||
| 147 | <term><userinput><command>kwrite</command> | ||||
| 148 | <option>--desktopfile</option> <parameter>filename</parameter></userinput></term> | ||||
| 149 | <listitem><para>The base file name of the desktop entry for this application.</para> | ||||
| 150 | <para>This is in particular useful for wrapper applications and | ||||
| 151 | applications having in general multiple desktop files. Thus each desktop | ||||
| 152 | file can have its own command line for the <option>Exec</option> entry. | ||||
| 153 | </para></listitem> | ||||
| 154 | </varlistentry> | ||||
| 155 | | ||||
| 156 | <varlistentry> | ||||
| 157 | <term><userinput><command>kwrite</command> | ||||
| 158 | <option>-e</option>, <option>--encoding</option> <parameter>encoding</parameter> | ||||
| 159 | </userinput></term> | ||||
| 160 | <listitem><para>Causes &kwrite; to use the specified encoding for the document. | ||||
| 161 | </para></listitem> | ||||
| 162 | </varlistentry> | ||||
| 163 | | ||||
| 164 | <varlistentry> | ||||
| 165 | <term><userinput><command>kwrite</command> | ||||
| 166 | <option>-l</option>, <option>--line</option> <parameter>line</parameter> | ||||
| 167 | </userinput></term> | ||||
| 168 | <listitem><para>Navigate to the specified line after opening the document. | ||||
| 169 | </para></listitem> | ||||
| 170 | </varlistentry> | ||||
| 171 | | ||||
| 172 | <varlistentry> | ||||
| 173 | <term><userinput><command>kwrite</command> | ||||
| 174 | <option>-c</option>, <option>--column</option> <parameter>column</parameter> | ||||
| 175 | </userinput></term> | ||||
| 176 | <listitem><para>Navigate to the specified column after opening the document. | ||||
| 177 | </para></listitem> | ||||
| 178 | </varlistentry> | ||||
| 179 | | ||||
| 180 | <varlistentry> | ||||
| 181 | <term><userinput><command>kwrite</command> | ||||
| 182 | <option>-i</option>, <option>--stdin</option></userinput></term> | ||||
| 183 | <listitem><para>Causes &kwrite; to read the document content from STDIN. This | ||||
| 184 | is similar to the common option <option>-</option> used in many command line | ||||
| 185 | programs, and allows you to pipe command output into &kwrite;.</para></listitem> | ||||
| 186 | </varlistentry> | ||||
| 187 | | ||||
| 188 | </variablelist> | ||||
| 189 | </sect2> | ||||
| 190 | </sect1> | ||||
| 191 | | ||||
| 68 | <sect1 id="credits"> | 192 | <sect1 id="credits"> | ||
| 69 | <title>Credits and License</title> | 193 | <title>Credits and License</title> | ||
| 70 | 194 | | |||
| 71 | <para>&kwrite; Copyright 2001-2014 by the &kate; team.</para> | 195 | <para>&kwrite; Copyright 2001-2014 by the &kate; team.</para> | ||
| 72 | 196 | | |||
| 73 | <para> | 197 | <para> | ||
| 74 | Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy | 198 | Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy | ||
| 75 | <email>digisnap@cs.tu-berlin.de</email> | 199 | <email>digisnap@cs.tu-berlin.de</email> | ||
| ▲ Show 20 Lines • Show All 75 Lines • Show Last 20 Lines | |||||