summaryrefslogtreecommitdiff
path: root/help/C
diff options
context:
space:
mode:
Diffstat (limited to 'help/C')
-rw-r--r--help/C/index.docbook314
1 files changed, 133 insertions, 181 deletions
diff --git a/help/C/index.docbook b/help/C/index.docbook
index c363df9f..5961f617 100644
--- a/help/C/index.docbook
+++ b/help/C/index.docbook
@@ -21,21 +21,21 @@
<copyright its:translate="no">
<year>2015-2020</year>
- <holder>MATE Documentation Project</holder>
+ <holder>MATE Documentation Project</holder>
</copyright>
<copyright its:translate="no">
<year>2007</year>
- <holder>GNOME Documentation Project</holder>
+ <holder>GNOME Documentation Project</holder>
</copyright>
<copyright its:translate="no">
<year>2002</year>
<year>2003</year>
<year>2004</year>
- <holder>Sun Microsystems</holder>
+ <holder>Sun Microsystems</holder>
</copyright>
<copyright its:translate="no">
<year>2000</year>
- <holder>Eric Baudais</holder>
+ <holder>Eric Baudais</holder>
</copyright>
<publisher>
@@ -88,7 +88,7 @@
<affiliation>
<orgname its:translate="yes">GNOME Documentation Project</orgname>
</affiliation>
- <email>[email protected]</email>
+ <email>[email protected]</email>
</author>
<othercredit role="other">
<personname>
@@ -277,7 +277,7 @@
<imageobject>
<imagedata fileref="figures/pluma_window.png" format="PNG"/>
</imageobject>
- <textobject>
+ <textobject>
<phrase its:translate="yes">Shows pluma main window.</phrase>
</textobject>
</mediaobject>
@@ -286,25 +286,25 @@
<para>The <application>pluma</application> window contains the following elements:</para>
<variablelist>
- <varlistentry>
+ <varlistentry>
<term>Menubar</term>
<listitem>
<para>The menus on the menubar contain all the commands you need to work with files in <application>pluma</application>.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>Toolbar</term>
<listitem>
<para>The toolbar contains a subset of the commands that you can access from the menubar.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>Display area</term>
<listitem>
<para>The display area contains the text of the file that you are editing.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>Statusbar</term>
<listitem>
<para>The statusbar displays information about current <application>pluma</application> activity and contextual information about the menu items. The statusbar also displays the following information:</para>
@@ -318,14 +318,14 @@
</itemizedlist>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>Side Pane</term>
<listitem>
<para>The side pane displays a list of open documents, and other information depending on which plugins are enabled.</para>
<para>By default, the side pane is not shown. To show it, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Side Pane</guimenuitem> </menuchoice>.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>Bottom Pane</term>
<listitem>
<para>The bottom pane is used by programming tools such as the <application>Python Console</application> plugin to display output.</para>
@@ -472,13 +472,13 @@
<info>
<title>Finding Text</title>
</info>
-
+
<para>To search a file for a string of text, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
- <para>Choose <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Find</guimenuitem>
+ <para>Choose <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Find</guimenuitem>
</menuchoice> to display the <guilabel>Find</guilabel> dialog.</para>
</listitem>
<listitem>
@@ -488,25 +488,25 @@
<para>Click <guibutton>Find</guibutton> to search the file for the first occurrence of the string after your current cursor position. If <application>pluma</application> finds the string, the application selects first occurrence of the string. Other occurrences of the string are highlighted.</para>
</listitem>
<listitem>
- <para>To find the next occurrence of the string, click <guibutton>Find</guibutton> or choose <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Find Next</guimenuitem>
- </menuchoice>. To find the previous occurrence of the text, choose <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Find Previous</guimenuitem>
+ <para>To find the next occurrence of the string, click <guibutton>Find</guibutton> or choose <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Find Next</guimenuitem>
+ </menuchoice>. To find the previous occurrence of the text, choose <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Find Previous</guimenuitem>
</menuchoice>.</para>
</listitem>
</orderedlist>
- <para>After you have closed the <guilabel>Find</guilabel> dialog, you can still move the selection to other occurrences of the text by choosing <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Find Next</guimenuitem>
- </menuchoice> and <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Find Previous</guimenuitem>
+ <para>After you have closed the <guilabel>Find</guilabel> dialog, you can still move the selection to other occurrences of the text by choosing <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Find Next</guimenuitem>
+ </menuchoice> and <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Find Previous</guimenuitem>
</menuchoice>.</para>
- <para>To remove the highlighting from the text, choose <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Clear Highlight</guimenuitem>
+ <para>To remove the highlighting from the text, choose <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Clear Highlight</guimenuitem>
</menuchoice>.</para>
<para>Refer to the <link xlink:href="man:pcrepattern"> <citerefentry> <refentrytitle>pcrepattern</refentrytitle> <manvolnum>3</manvolnum> </citerefentry> </link> for more information about the syntax and the semantics of the regular expressions supported on <guilabel>Find</guilabel> dialog.</para>
</section>
@@ -515,12 +515,12 @@
<info>
<title>Incremental Search</title>
</info>
-
+
<para>Incremental search highlights matching text in the document as you type it letter by letter. (This is similar to the search feature in several web browsers.)</para>
- <para>To start an incremental search, choose <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Incremental Search</guimenuitem>
+ <para>To start an incremental search, choose <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Incremental Search</guimenuitem>
</menuchoice>. The search box appears at the top of the display area. </para>
<para>Begin typing, and text that matches will be highlighted in the document. The first instance after the cursor position is also selected.</para>
<para>To advance the selection to the next match while keeping the incremental search box open, press <keycombo>
@@ -544,9 +544,9 @@
<para>To search a file for a string, and replace the string with an alternative string, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
- <para>Choose <menuchoice>
- <guimenu>Search</guimenu>
- <guimenuitem>Replace</guimenuitem>
+ <para>Choose <menuchoice>
+ <guimenu>Search</guimenu>
+ <guimenuitem>Replace</guimenuitem>
</menuchoice> to display the <guilabel>Replace</guilabel> dialog.</para>
</listitem>
<listitem>
@@ -566,7 +566,7 @@
<info>
<title>Find and Replace Options</title>
</info>
-
+
<para>The <guilabel>Find</guilabel> dialog and the <guilabel>Replace</guilabel> dialog both have the following options:</para>
<itemizedlist>
<listitem>
@@ -589,7 +589,7 @@
<info>
<title>Special Characters</title>
</info>
-
+
<para>You can include the following escape sequences in the text to find or replace to represent special characters:</para>
<variablelist>
<varlistentry>
@@ -662,23 +662,23 @@
<title>General Tabbed Section</title>
</info>
<variablelist>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Print syntax highlighting</guilabel>
+ <guilabel>Print syntax highlighting</guilabel>
</term>
<listitem>
<para>Select this option to print syntax highlighting. For more information about syntax highlighting, see <xref linkend="pluma-set-highlightmode"/>.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Print page headers</guilabel>
+ <guilabel>Print page headers</guilabel>
</term>
<listitem>
<para>Select this option to include a header on each page that you print. You cannot configure the header. </para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
<guilabel>Line Numbers</guilabel>
</term>
@@ -687,9 +687,9 @@
<para>Use the <guilabel>Number every ... lines </guilabel> spin box to specify how often to print the line numbers, for example every 5 lines, every 10 lines, and so on.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Text Wrapping</guilabel>
+ <guilabel>Text Wrapping</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Enable text wrapping</guilabel> option to wrap text onto the next line, at a character level, when you print a file. The application counts wrapped lines as one line for line numbering purposes.</para>
@@ -704,15 +704,15 @@
<title>Fonts</title>
</info>
<variablelist>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Body</guilabel>
+ <guilabel>Body</guilabel>
</term>
<listitem>
<para>Click on this button to select the font used to print the body text of a file.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
<guilabel>Line numbers</guilabel>
</term>
@@ -720,9 +720,9 @@
<para>Click on this button to select the font used to print line numbers.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Headers and footers</guilabel>
+ <guilabel>Headers and footers</guilabel>
</term>
<listitem>
<para>Click on this button to select the font to use to print the headers and footers in a file. </para>
@@ -757,9 +757,9 @@
<title>Job Tabbed Section</title>
</info>
<variablelist>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Print range</guilabel>
+ <guilabel>Print range</guilabel>
</term>
<listitem>
<para>Select one of the following options to determine how many pages to print:</para>
@@ -785,9 +785,9 @@
</itemizedlist>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Copies</guilabel>
+ <guilabel>Copies</guilabel>
</term>
<listitem>
<para>Use the <guilabel>Number of copies</guilabel> spin box to specify the number of copies of the file that you want to print.</para>
@@ -801,28 +801,28 @@
<info>
<title>Printer Tabbed Section</title>
</info>
-
+
<variablelist>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Printer</guilabel>
+ <guilabel>Printer</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the printer to which you want to print the file.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Settings</guilabel>
+ <guilabel>Settings</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the printer settings.</para>
<para>To configure the printer, click <guibutton>Configure</guibutton>. For example, you can enable or disable duplex printing, or schedule delayed printing, if this functionality is supported by the printer.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Location</guilabel>
+ <guilabel>Location</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select one of the following print destinations:</para>
@@ -867,25 +867,25 @@
</variablelist>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>State</guilabel>
+ <guilabel>State</guilabel>
</term>
<listitem>
<para>This functionality is not supported in this version of pluma.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Type</guilabel>
+ <guilabel>Type</guilabel>
</term>
<listitem>
<para>This functionality is not supported in this version of pluma.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Comment</guilabel>
+ <guilabel>Comment</guilabel>
</term>
<listitem>
<para>This functionality is not supported in this version of pluma.</para>
@@ -898,62 +898,62 @@
<info>
<title>Paper Tabbed Section</title>
</info>
-
+
<variablelist>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Paper size</guilabel>
+ <guilabel>Paper size</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the size of the paper to which you want to print the file.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Width</guilabel>
+ <guilabel>Width</guilabel>
</term>
<listitem>
<para>Use this spin box to specify the width of the paper. Use the adjacent drop-down list to change the measurement unit.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Height</guilabel>
+ <guilabel>Height</guilabel>
</term>
<listitem>
<para>Use this spin box to specify the height of the paper.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Feed orientation</guilabel>
+ <guilabel>Feed orientation</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the orientation of the paper in the printer.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Page orientation</guilabel>
+ <guilabel>Page orientation</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the page orientation.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Layout</guilabel>
+ <guilabel>Layout</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the page layout. A preview of each layout that you select is displayed in the <guilabel>Preview</guilabel> area.</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <guilabel>Paper tray</guilabel>
+ <guilabel>Paper tray</guilabel>
</term>
<listitem>
- <para>Use this drop-down list to select the paper tray.</para>
+ <para>Use this drop-down list to select the paper tray.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -972,7 +972,7 @@
<info>
<title>Syntax Highlighting</title>
</info>
-
+
<para>Syntax highlighting makes source code easier to read by showing different parts of the text in different colors.</para>
<para><application>pluma</application> chooses an appropriate syntax highlighting mode based on a document's type. To override the syntax highlighting mode, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Highlight Mode</guimenuitem> </menuchoice>, then choose one of the following menu items:</para>
<variablelist>
@@ -1270,6 +1270,38 @@
</row>
<row valign="top">
<entry>
+ <para>Ctrl + U</para>
+ </entry>
+ <entry>
+ <para>Change case to uppercase.</para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>
+ <para>Ctrl + L</para>
+ </entry>
+ <entry>
+ <para>Change case to lowercase.</para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>
+ <para>Alt + U</para>
+ </entry>
+ <entry>
+ <para>Toggle case of each character.</para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>
+ <para>Alt + L</para>
+ </entry>
+ <entry>
+ <para>Capitalize each word.</para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>
<para>Alt + Up</para>
</entry>
<entry>
@@ -1541,7 +1573,7 @@
<variablelist>
<varlistentry>
<term>
- <guilabel>Text Wrapping</guilabel>
+ <guilabel>Text Wrapping</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Enable text wrapping</guilabel> option to have long lines of text flow into paragraphs instead of running off the edge of the text window. This avoids having to scroll horizontally</para>
@@ -1591,7 +1623,7 @@
<variablelist>
<varlistentry>
<term>
- <guilabel>Tabs</guilabel>
+ <guilabel>Tabs</guilabel>
</term>
<listitem>
<para>Use the <guilabel>Tab width</guilabel> spin box to specify the width of the space that <application> pluma</application> inserts when you press the <keycap>Tab</keycap> key. </para>
@@ -1600,7 +1632,7 @@
</varlistentry>
<varlistentry>
<term>
- <guilabel>Auto Indentation</guilabel>
+ <guilabel>Auto Indentation</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Enable auto indentation</guilabel> option to specify that the next line starts at the indentation level of the current line. </para>
@@ -1608,7 +1640,7 @@
</varlistentry>
<varlistentry>
<term>
- <guilabel>File Saving</guilabel>
+ <guilabel>File Saving</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Create a backup copy of files before saving</guilabel> option to create a backup copy of a file each time you save the file. The backup copy of the file contains a ~ at the end of the filename.</para>
@@ -1622,11 +1654,11 @@
<info>
<title>Font &amp; Colors Preferences</title>
</info>
-
+
<variablelist>
<varlistentry>
<term>
- <guilabel>Font</guilabel>
+ <guilabel>Font</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Use default theme font</guilabel> option to use the default system font for the text in the <application>pluma</application> text window. </para>
@@ -1721,7 +1753,7 @@
<info>
<title>Disabling a Plugin</title>
</info>
-
+
<para>A plugin remains enabled when you quit <application>pluma</application>. </para>
<para>To disable a <application>pluma</application> plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
@@ -1763,11 +1795,6 @@
<itemizedlist>
<listitem>
<para>
- <xref linkend="pluma-change-case-plugin"/> allows you to change the case of the selected text.
- </para>
- </listitem>
- <listitem>
- <para>
<xref linkend="pluma-document-statistics-plugin"/> shows the number of lines, words, and characters in the document.
</para>
</listitem>
@@ -1832,81 +1859,6 @@
</note>
</section>
- <section xml:id="pluma-change-case-plugin">
- <info>
- <title>Change Case Plugin</title>
- </info>
- <para>The <application>Change Case</application> plugin changes the case of the selected text.</para>
- <para>The following items are added to the <guimenu>Edit</guimenu> menu when the <application>Change Case</application> plugin is enabled:</para>
- <informaltable frame="all">
- <tgroup cols="3" colsep="1" rowsep="1">
- <colspec colname="COLSPEC0" colwidth="33*"/>
- <colspec colname="COLSPEC1" colwidth="33*"/>
- <colspec colname="COLSPEC2" colwidth="33*"/>
- <thead>
- <row valign="top">
- <entry colname="COLSPEC0">
- <para>Menu Item</para>
- </entry>
- <entry colname="COLSPEC1">
- <para>Action</para>
- </entry>
- <entry colname="COLSPEC2">
- <para>Example</para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row valign="top">
- <entry>
- <para><menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Change Case</guisubmenu> <guimenuitem>All Upper Case</guimenuitem> </menuchoice></para>
- </entry>
- <entry>
- <para>Change each character to uppercase. </para>
- </entry>
- <entry>
- <para><literal>This text</literal> becomes <literal>THIS TEXT</literal></para>
- </entry>
- </row>
- <row valign="top">
- <entry>
- <para><menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Change Case</guisubmenu> <guimenuitem>All Lower Case</guimenuitem> </menuchoice></para>
- </entry>
- <entry>
- <para>Change each character to lowercase. </para>
- </entry>
- <entry>
- <para><literal>This Text</literal> becomes <literal>this text</literal></para>
- </entry>
- </row>
- <row valign="top">
- <entry>
- <para><menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Change Case</guisubmenu> <guimenuitem>Invert Case</guimenuitem> </menuchoice></para>
- </entry>
- <entry>
- <para>Change each lowercase character to uppercase, and change each uppercase character to lowercase. </para>
- </entry>
- <entry>
- <para><literal>This Text</literal> becomes <literal>tHIS tEXT</literal></para>
- </entry>
- </row>
- <row valign="top">
- <entry>
- <para><menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Change Case</guisubmenu> <guimenuitem>Title Case</guimenuitem> </menuchoice></para>
- </entry>
- <entry>
- <para>Change the first character of each word to uppercase. </para>
- </entry>
- <entry>
- <para><literal>this text</literal> becomes <literal>This Text</literal></para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
-
- </section>
-
<section xml:id="pluma-document-statistics-plugin">
<info>
<title>Document Statistics Plugin</title>
@@ -2148,19 +2100,19 @@
</info>
<para>To configure the Insert Date/Time plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
- <listitem>
+ <listitem>
<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>.</para>
</listitem>
- <listitem>
+ <listitem>
<para>Select the <guilabel>Plugins</guilabel> tab.</para>
</listitem>
- <listitem>
+ <listitem>
<para>Select the <guilabel>Insert Date/Time</guilabel> plugin.</para>
</listitem>
- <listitem>
+ <listitem>
<para>Click <guibutton>Configure Plugin</guibutton> to display the <guilabel>Configure insert date/time plugin</guilabel> dialog.</para>
</listitem>
- <listitem>
+ <listitem>
<para>Select one of the options, as follows: </para>
<itemizedlist>
<listitem>
@@ -2180,11 +2132,11 @@
</listitem>
</itemizedlist>
</listitem>
- <listitem>
+ <listitem>
<para>Click <guibutton>OK</guibutton> to close the <guilabel>Configure insert date/time plugin</guilabel> dialog.
</para>
</listitem>
- <listitem>
+ <listitem>
<para>To close the <guilabel>Preferences</guilabel> dialog, click <guibutton>Close</guibutton>.</para>
</listitem>
</orderedlist>
@@ -2264,7 +2216,7 @@
<listitem>
<para>When your document is ready, save it.</para>
</listitem>
- <listitem>
+ <listitem>
<para>You will see that any trailing whitespaces has been stripped after the document has been saved.</para>
</listitem>
</orderedlist>