/
index.docbook
1984 lines (1864 loc) · 103 KB
/
index.docbook
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY appversion "1.10">
<!ENTITY manrevision "3.0">
<!ENTITY date "July 2015">
<!ENTITY app "pluma">
]>
<!--
(Do not remove this comment block.)
Maintained by the MATE Documentation Project
http://wiki.mate-desktop.org/dev-doc:doc-team-guide
Template version: 2.0 beta
Template last modified Jan 30, 2002
-->
<!-- =============Document Header ============================= -->
<?db.chunk.max_depth 2?>
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
<articleinfo>
<title>Pluma Manual<!-- not using app entity because of lowercase ugliness --></title>
<copyright>
<year>2015</year>
<holder>MATE Documentation Project</holder> </copyright>
<copyright>
<year>2007</year>
<holder>GNOME Documentation Project</holder> </copyright>
<copyright>
<year>2002</year>
<year>2003</year>
<year>2004</year>
<holder>Sun Microsystems</holder> </copyright>
<copyright>
<year>2000</year>
<holder>Eric Baudais</holder> </copyright>
<!-- translators: uncomment this:
<copyright>
<year>2003</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
<publisher role="maintainer">
<publishername>MATE Documentation Project</publishername>
</publisher>
<publisher>
<publishername>GNOME Documentation Project</publishername>
</publisher>
<xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<authorgroup>
<author>
<firstname>MATE Documentation Project</firstname>
<surname></surname>
<affiliation>
<orgname>MATE Desktop</orgname>
</affiliation>
</author>
<author>
<firstname>Joachim</firstname>
<surname>Noreiko</surname>
</author>
<author>
<firstname>GNOME Documentation Project</firstname>
<surname></surname>
<affiliation>
<orgname>GNOME</orgname>
</affiliation>
</author>
<author>
<firstname>Hal</firstname>
<surname>Canary</surname>
<contrib>Added the Shortcut Keys Table</contrib>
</author>
<author>
<firstname>Sun Java Desktop System Documentation Team</firstname>
<surname></surname>
<affiliation>
<orgname>Sun Microsystems</orgname>
<address><email>gdocteam@sun.com</email></address>
</affiliation>
</author>
<author>
<firstname>Eric</firstname>
<surname>Baudais</surname>
<affiliation>
<orgname>GNOME Documentation Project</orgname>
<address> <email>baudais@okstate.edu</email> </address>
</affiliation>
</author>
<othercredit role="reviewer">
<firstname>Baris</firstname>
<surname>Cicek provided information from earlier revisions of the pluma application.</surname>
<contrib>Acknowledgments</contrib>
</othercredit>
<othercredit role="reviewer">
<firstname>Ajit</firstname>
<surname>George provided information about plugins.</surname>
<contrib>Acknowledgments</contrib>
</othercredit>
<!-- This is appropriate place for other contributors: translators,
maintainers, etc. Commented out by default.
<othercredit role="translator">
<firstname>Latin</firstname>
<surname>Translator 1</surname>
<affiliation>
<orgname>Latin Translation Team</orgname>
<address> <email>translator@gnome.org</email> </address>
</affiliation>
<contrib>Latin translation</contrib>
</othercredit>
-->
</authorgroup>
<!-- According to GNU FDL, revision history is mandatory if you are -->
<!-- modifying/reusing someone else's document. If not, you can omit it. -->
<revhistory>
<!-- Remember to remove the &manrevision; entity from the revision entries other
than the current revision. -->
<revision>
<revnumber>pluma V1.0</revnumber>
<date>2000</date>
<revdescription>
<para role="author">Eric Baudais <email>baudais@okstate.edu</email>
</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.0</revnumber>
<date>March 2002</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.1</revnumber>
<date>June 2002</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.2</revnumber>
<date>August 2002</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.3</revnumber>
<date>September 2002</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.4</revnumber>
<date>January 2003</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.5</revnumber>
<date>March 2003</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.6</revnumber>
<date>September 2003</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>pluma Manual V2.7</revnumber>
<date>March 2004</date>
<revdescription>
<para role="author">Sun GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>&app; Manual V2.8</revnumber>
<date>&date;</date>
<revdescription>
<para role="author">Sun Java Desktop System Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>&app; Manual V2.9;</revnumber>
<date>July 2006;</date>
<revdescription>
<para role="author">GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>&app; Manual V&manrevision;</revnumber>
<date>&date;</date>
<revdescription>
<para role="author">MATE Documentation Team</para>
<para role="publisher">MATE Documentation Project</para>
</revdescription>
</revision>
</revhistory>
<releaseinfo> This manual describes version &appversion; of &app;.
</releaseinfo>
<legalnotice>
<title>Feedback</title>
<para>To report a bug or make a suggestion regarding the <application>&app;</application> application or this manual, follow the directions in the <ulink url="help:mate-user-guide/feedback" type="help">MATE Feedback Page</ulink>.
</para>
<!-- Translators may also add here feedback address for translations -->
</legalnotice>
<abstract role="description">
<para>&app; is a text editor for the MATE Desktop featuring basic yet
robust capabilities such as printing, spell checking, find and replace,
and syntax highlighting. More advanced features are available as plugins.</para>
</abstract>
</articleinfo>
<indexterm><primary>pluma</primary></indexterm>
<indexterm><primary>text editor</primary></indexterm>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<sect1 id="pluma-intro">
<title>Introduction</title>
<!-- removed ids, here as anchors to prevent possible breakage -->
<anchor id="pluma-customize-toolbar"/>
<para>The <application>&app;</application> application enables you to create and edit text files.</para>
<para>The aim of <application>&app;</application> is to be a simple and easy to use text editor. More powerful features can be enabled with different <firstterm>plugins</firstterm>, allowing a variety of tasks related to text-editing.</para>
</sect1>
<!-- ============= Getting Started =========================== -->
<sect1 id="pluma-getting-started">
<title>Getting Started</title>
<!-- ============= To Start pluma ============================ -->
<sect2 id="pluma-to-start">
<title>Starting &app;</title>
<para>You can start <application>&app;</application> in the following ways:</para>
<variablelist>
<varlistentry>
<term><guimenu>Applications</guimenu> menu</term>
<listitem>
<para>Choose <menuchoice><guisubmenu>Accessories</guisubmenu><guimenuitem>Text Editor</guimenuitem></menuchoice>. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>Command line</term>
<listitem>
<para>Execute the following command: <command>pluma</command></para>
</listitem>
</varlistentry>
</variablelist>
<para>By default, when you open a text document in the file manager, pluma will start, and display the document.</para>
</sect2>
<sect2 id="pluma-when-you-start">
<title>The &app; Window</title>
<para>When you start <application>&app;</application>, the following window is displayed:</para>
<figure id="pluma-window">
<title>&app; Window</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/pluma_window.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Shows pluma main window.</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>The <application>&app;</application> window contains the following
elements: </para>
<variablelist>
<varlistentry> <term>Menubar</term>
<listitem>
<para>The menus on the menubar contain all the commands you need to work with files in <application>&app;</application>.</para>
</listitem>
</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> <term>Display area</term>
<listitem>
<para> The display area contains the text of the file that you are editing. </para>
</listitem>
</varlistentry>
<varlistentry> <term>Statusbar</term>
<listitem>
<para>The statusbar displays information about current <application>&app;</application> activity and contextual information about the menu items. The statusbar also displays the following information:</para>
<itemizedlist>
<listitem>
<para>Cursor position: the line number and column number where the cursor is located.</para>
</listitem>
<listitem>
<para>Edit mode: If the editor is in insert mode, the statusbar contains the text <guilabel>INS</guilabel>. If the editor is in overwrite mode, the statusbar contains the text <guilabel>OVR</guilabel>. Press the <keycap>Insert</keycap> key to change edit mode.</para>
</listitem>
</itemizedlist>
</listitem>
</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> <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>
<para>By default, the bottom pane is not shown. To show it, choose <menuchoice><guimenu>View</guimenu><guimenuitem>Bottom Pane</guimenuitem></menuchoice>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>When you right-click in the <application>&app;</application> window, the application displays a popup menu. The popup menu contains the most common text editing commands. </para>
<para>Like other MATE applications, actions in <application>&app;</application> can be performed in several ways: with the menu, with the toolbar, or with shortcut keys. Shortcuts keys common to all applications are listed in the <ulink type="help" url="help:mate-user-guide/shortcuts-apps">User Guide</ulink>.</para>
</sect2>
<!-- ============= To Open Multiple Files from the Command Line ========= -->
<sect2 id="pluma-run-from-cmd-line">
<title>Running &app; from a Command Line</title>
<para>You can run <application>&app;</application> from a command line and open a single file or multiple files. To open multiple files from a command line, type the following command, then press <keycap>Return</keycap>:</para>
<para><command>pluma <replaceable>file1.txt file2.txt file3.txt</replaceable></command></para>
<para>Alternatively, you can specify a URI instead of a filename.</para>
<para>Refer to the <ulink url="man:pluma" type="man"><citerefentry><refentrytitle>&app;</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> man page for more information on how to run <application>&app;</application> from a command line.</para>
</sect2>
</sect1>
<!-- ================ Usage ================================ -->
<sect1 id="pluma-usage">
<title>Working with Files</title>
<!-- ============= To Create a New File ======================== -->
<sect2 id="pluma-create-new-file">
<title>Creating a New Document</title>
<para>To create a new document, choose <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>. The application displays a new blank document in the <application>&app;</application> window.</para>
</sect2>
<!-- ============= To Open a File ============================= -->
<sect2 id="pluma-open-file">
<title>Opening a File</title>
<para>To open a file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice> to display the <guilabel>Open File</guilabel> dialog. Select the file that you want to open, then click <guibutton>Open</guibutton>. The file is displayed in the <application>&app;</application> window. </para>
<para>The application records the paths and filenames of the five most recent files that you edited and displays the files as menu items on the <menuchoice><guimenu>File</guimenu></menuchoice> menu. You can also click on the <inlinemediaobject><imageobject><imagedata fileref="figures/pluma_recent_files_menu_icon.png" format="PNG"/></imageobject><textobject><phrase>Shows Recent Files menu icon.</phrase></textobject></inlinemediaobject> icon on the toolbar to display the list of recent files. </para>
<note><para>You can open multiple files in <application>&app;</application>. The application adds a tab for each open file to the window. For more on this see <xref linkend="pluma-tabs"/>.</para></note>
</sect2>
<!-- ============= To Save a File ============================== -->
<sect2 id="pluma-save-file">
<title>Saving a File</title>
<para>You can save files in the following ways:</para>
<itemizedlist>
<listitem><para>To save changes to an existing file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice>. </para>
</listitem>
<listitem><para>To save a new file or to save an existing file under a new filename, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Save As</guimenuitem> </menuchoice>. Enter a name for the file in the <guilabel>Save As</guilabel> dialog, then click <guibutton>Save</guibutton>. </para>
</listitem>
<listitem><para>To save all the files that are currently open in <application>&app;</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Save All</guimenuitem> </menuchoice>.</para>
</listitem>
</itemizedlist>
<para>To close all the files that are currently open in <application>&app;</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Close All</guimenuitem> </menuchoice>.</para>
</sect2>
<!-- ============= Working with tabs ======================== -->
<sect2 id="pluma-tabs">
<title>Working With Tabs</title>
<para>When more than one file is open, <application>&app;</application> shows a <firstterm>tab</firstterm> for each document above the display area. To switch to another document, click on its tab.</para>
<para>To move a document to another <application> &app;</application> window, drag the tab corresponding to the file to the window you want to move it to.</para>
<para>To move a document to a new <application> &app;</application> window, either drag its tab to the desktop, or choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Move to New Window</guimenuitem> </menuchoice>.</para>
</sect2>
</sect1>
<sect1 id="working-with-text">
<title>Working with Text</title>
<!-- ============= To Edit Text ================================ -->
<sect2 id="pluma-edit-text">
<title>Editing Text</title>
<para>You can edit the text of a file in the following ways:</para>
<itemizedlist>
<listitem><para>Type new text from the keyboard. The blinking <firstterm>insertion cursor</firstterm> marks the point where new text appears. To change this, use the arrow keys on the keyboard or click with the mouse.</para>
</listitem>
<listitem><para>To copy the selected text to the clipboard, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Copy</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem><para>To delete the selected text from the file and move the selected text to the clipboard, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Cut</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem><para>To permanently delete the selected text from the file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Delete</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem><para>To insert the contents of the clipboard at the cursor position, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem> </menuchoice>. You must cut or copy text before you can paste text into the file, either from &app; or another application.</para>
</listitem>
<listitem><para>To select all the text in a file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Select All</guimenuitem> </menuchoice>. </para>
</listitem>
</itemizedlist>
</sect2>
<!-- ============== To Undo or Redo Edits ====================== -->
<sect2 id="pluma-undo-redo-edits">
<title>Undoing and Redoing Changes</title>
<para>To undo a change you have made, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem> </menuchoice>. To reverse this action, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Redo</guimenuitem> </menuchoice>.</para>
</sect2>
</sect1>
<sect1 id="pluma-find">
<title>Finding and Replacing</title>
<para>In <application>&app;</application>, there are two ways of searching for text. You can use the <guilabel>Find</guilabel> dialog to search for a specific piece of text, or <guilabel>Incremental Search</guilabel> to highlight matching text as you type it.
</para>
<!-- ============= To Find Text ================================ -->
<sect2 id="pluma-find-text">
<title>Finding Text</title>
<para>To search a file for a string of text, perform the following steps:</para>
<orderedlist>
<listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Find</guimenuitem> </menuchoice> to display the <guilabel>Find</guilabel> dialog.</para>
</listitem>
<listitem><para>Type the string that you want to find in the <guilabel>Search for</guilabel> field. You can include special characters such as a new line or tab: see <xref linkend="pluma-find-escapes"/>.</para>
</listitem>
<listitem><para>Click <guibutton>Find</guibutton> to search the file for the first occurrence of the string after your current cursor position. If <application>&app;</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> </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> </menuchoice>.</para>
<para>To remove the highlighting from the text, choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Clear Highlight</guimenuitem> </menuchoice>.</para>
</sect2>
<sect2 id="pluma-find-incremental">
<title>Incremental Search</title>
<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> </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><keycap>Ctrl</keycap><keycap>G</keycap></keycombo>. Press <keycombo><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>G</keycap></keycombo> to go back to the previous match.</para>
<tip><para>You can also use the up and down arrow keys or the mouse wheel to move the selection between matches.</para></tip>
</sect2>
<!-- ============= To Find and Replace Text =================== -->
<sect2 id="pluma-find-replace-text">
<title>Replacing Text</title>
<para>To search a file for a string, and replace the string with an alternative string, perform the following steps:</para>
<orderedlist>
<listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Replace</guimenuitem> </menuchoice> to display the <guilabel>Replace</guilabel> dialog.</para>
</listitem>
<listitem><para>Type the string that you want to find, in the <guilabel>Search for</guilabel> field. You can include special characters such as a new line or tab: see <xref linkend="pluma-find-escapes"/>.</para></listitem>
<listitem><para>Type the string that you want to use to replace the string that you find, in the <guilabel>Replace with</guilabel> field.</para>
</listitem>
</orderedlist>
<para>To examine each occurrence of the string before replacing it, click <guibutton>Find</guibutton>. If <application>&app;</application> finds the string, the application selects the string. Click <guibutton>Replace</guibutton> to replace the selected occurrence of the string. To find the next occurrence of the string, click <guibutton>Find</guibutton> again.</para>
<para>To replace all occurrences of the string throughout the document, click <guibutton>Replace All</guibutton>.</para>
</sect2>
<!-- ============= Find and Replace Options ============================ -->
<sect2 id="pluma-find-options">
<title>Find and Replace Options</title>
<para>The <guilabel>Find</guilabel> dialog and the <guilabel>Replace</guilabel> dialog both have the following options:</para>
<itemizedlist>
<listitem><para>Select the <guilabel>Match case</guilabel> option to only find occurrences of the string that match the case of the text that you type. For example, with <guilabel>Match case</guilabel> selected, "TEXT" will not match "text".</para>
</listitem>
<listitem><para>Select the <guilabel>Match entire word only</guilabel> option to only find occurrences of the string that match the entire words of the text that you type. For example, with <guilabel>Match entire word only</guilabel> selected, "text" will not match "texture". <!-- translators, please make up your own example ;) --></para>
</listitem>
<listitem><para>Select the <guilabel>Search backwards</guilabel> option to search backwards towards the beginning of the document. </para>
</listitem>
<listitem><para>Select the <guilabel>Wrap around</guilabel> option to search to one end of the document and then continue the search from the other end of the file. </para>
</listitem>
</itemizedlist>
</sect2>
<!-- ============= Special Characters ============================ -->
<sect2 id="pluma-find-escapes">
<title>Special Characters</title>
<para>You can include the following escape sequences in the text to find or replace to represent special characters:</para>
<variablelist>
<varlistentry>
<term><literal>\n</literal></term>
<listitem>
<para>Specifies a new line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\t</literal></term>
<listitem>
<para>Specifies a tab character.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\r</literal></term>
<listitem>
<para>Specifies a carriage return.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\\</literal></term>
<listitem>
<para>The backslash character itself must be escaped if it is being searched for.
For example, if you are looking for the "<literal>\n</literal>" literal, you will
have to type "\\n" in the <guilabel>Search for</guilabel> field. Or if you are
looking for a sequence of backslashes, you will have to double the number of
searched backslashes.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<!-- ============= To Position the Cursor on a Specific Line ======================= -->
<sect2 id="pluma-goto-line">
<title>Positioning the Cursor on a Specific Line</title>
<para>To position the cursor on a specific line in the current file, choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Go to Line</guimenuitem> </menuchoice>. The line number box appears at the top of the display area.</para>
<para>Begin typing the number of the line that you want to move the cursor to and the document will scroll to the specified line.</para>
<para>To dismiss the box and move the cursor to the specified line, press <keycap>Return</keycap>.</para>
</sect2>
</sect1>
<sect1 id="pluma-printing">
<title>Printing</title>
<!-- ============= To Set the Page Options ============================ -->
<sect2 id="pluma-page-setup">
<title>Setting the Page Options</title>
<para>To set the page options, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Page Setup</guimenuitem> </menuchoice> to display the <guilabel>Page Setup</guilabel> dialog.</para>
<para>The <guilabel>Page Setup</guilabel> dialog enables you to specify the following print options:</para>
<sect3 id="pluma-page-setup-general">
<title>General Tabbed Section</title>
<variablelist>
<varlistentry> <term><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> <term><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> <term><guilabel>Line Numbers</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Print line numbers</guilabel> option to include line numbers when you print a file. </para>
<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> <term><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>
<para>Select the <guilabel>Do not split words over two lines</guilabel> option to wrap text onto the next line, at a word level, when you print a file.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="pluma-page-setup-fonts">
<title>Fonts</title>
<variablelist>
<varlistentry> <term><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> <term><guilabel>Line numbers</guilabel>
</term>
<listitem>
<para>Click on this button to select the font used to print line numbers.</para>
</listitem>
</varlistentry>
<varlistentry> <term><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>
</listitem>
</varlistentry>
</variablelist>
<para>To reset the fonts to the default fonts for printing a file from <application>&app;</application>, click <guibutton>Restore Default Fonts</guibutton>.</para>
</sect3>
</sect2>
<!-- ============= To Print a File ============================ -->
<sect2 id="pluma-print-file">
<title>Printing a Document</title>
<para>You can use <application>&app;</application> to perform the following print operations:</para>
<itemizedlist>
<listitem><para>Print a document to a printer. </para>
</listitem>
<listitem><para>Print the output of the print command to a file.</para>
</listitem>
</itemizedlist>
<para>If you print to a file, <application>&app;</application> sends the output of the file to a pre-press format file. The most common pre-press formats are PostScript and Portable Document Format (PDF).</para>
<para>To preview the pages that you want to print, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print Preview</guimenuitem> </menuchoice>.</para>
<para>To print the current file to a printer or a file, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem> </menuchoice> to display the <guilabel>Print</guilabel> dialog.</para>
<para>The <guilabel>Print</guilabel> dialog enables you to specify the following print options:</para>
<sect3 id="print-dialog-job">
<title>Job Tabbed Section</title>
<variablelist>
<varlistentry> <term><guilabel>Print range</guilabel> </term>
<listitem>
<para>Select one of the following options to determine how many pages to print:</para>
<itemizedlist>
<listitem>
<para><guilabel>All</guilabel></para>
<para>Select this option to print all the pages in the file.</para>
</listitem>
<listitem>
<para><guilabel>Lines</guilabel></para>
<para>Select this option to print the specified lines only. Use the <guilabel>From</guilabel> and <guilabel>To</guilabel> spin boxes to specify the line range.</para>
</listitem>
<listitem>
<para><guilabel>Selection</guilabel></para>
<para>Select this option to print the selected text only. This option is only available if you select text.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry> <term><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>
<para>If you print multiple copies of the file, select the <guilabel>Collate</guilabel> option to collate the printed copies.</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="print-dialog-printer">
<title>Printer Tabbed Section</title>
<variablelist>
<varlistentry> <term><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> <term><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> <term><guilabel>Location</guilabel> </term>
<listitem>
<para>
Use this drop-down list to select one of the following print destinations:
</para>
<variablelist>
<varlistentry>
<term><guilabel>CUPS</guilabel></term>
<listitem>
<para>
Print the file to a CUPS printer.
</para>
<note>
<para>
If the selected printer is a CUPS printer, <guilabel>CUPS</guilabel> is the only entry in this drop-down list.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>lpr</guilabel></term>
<listitem>
<para>
Print the file to a printer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>File</guilabel></term>
<listitem>
<para>
Print the file to a PostScript file.
</para>
<para>
Click <guibutton>Save As</guibutton> to display a dialog where you specify the name and location of the PostScript file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Custom</guilabel></term>
<listitem>
<para>
Use the specified command to print the file.
</para>
<para>
Type the name of the command in the text box. Include all command-line arguments.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry> <term><guilabel>State</guilabel> </term>
<listitem>
<para>This functionality is not supported in this version of &app;.
</para>
</listitem>
</varlistentry>
<varlistentry> <term><guilabel>Type</guilabel> </term>
<listitem>
<para>This functionality is not supported in this version of &app;.
</para>
</listitem>
</varlistentry>
<varlistentry> <term><guilabel>Comment</guilabel> </term>
<listitem>
<para>This functionality is not supported in this version of &app;.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="print-dialog-paper">
<title>Paper Tabbed Section</title>
<variablelist>
<varlistentry> <term><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> <term><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> <term><guilabel>Height</guilabel> </term>
<listitem>
<para>Use this spin box to specify the height of the paper.</para>
</listitem>
</varlistentry>
<varlistentry> <term><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> <term><guilabel>Page orientation</guilabel> </term>
<listitem>
<para>Use this drop-down list to select the page orientation.</para>
</listitem>
</varlistentry>
<varlistentry> <term><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> <term><guilabel>Paper tray</guilabel> </term>
<listitem>
<para>Use this drop-down list to select the paper tray.
</para> </listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
<sect1 id="pluma-programming-features">
<title>Programming Features</title>
<para>Several of <application>&app;</application>'s features for programming are provided with plugins. For example, the Tag List plugin provides a list of commonly-used tags for different markup languages: see <xref linkend="pluma-tag-list-plugin"/>.</para>
<!-- ============= Syntax Highlighting =================== -->
<sect2 id="pluma-set-highlightmode">
<title>Syntax Highlighting</title>
<para>Syntax highlighting makes source code easier to read by showing different parts of the text in different colors.</para>
<para><application>&app;</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>
<varlistentry>
<term><guimenuitem>Normal</guimenuitem></term>
<listitem>
<para>Do not display any syntax highlighting.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guisubmenu>Sources</guisubmenu></term>
<listitem>
<para>Display syntax highlighting to edit source code. Use the <guisubmenu>Sources</guisubmenu> submenu to select the source code type.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guisubmenu>Markup</guisubmenu></term>
<listitem>
<para>Display syntax highlighting to edit markup code. Use the <guisubmenu>Markup</guisubmenu> submenu to select the markup code type.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guisubmenu>Scripts</guisubmenu></term>
<listitem>
<para>Display syntax highlighting to edit script code. Use the <guisubmenu>Scripts</guisubmenu> submenu to select the script code type.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guisubmenu>Others</guisubmenu></term>
<listitem>
<para>Display syntax highlighting to edit other types of code. Use the <guisubmenu>Others</guisubmenu> submenu to select the code type.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<!-- ============= To Pipe the Output of a Command to a File ======= -->
<sect2 id="pluma-pipe-output">
<title>Piping the Output of a Command to a File</title>
<para>You can use <application>&app;</application> to pipe the output of a command to a text file. For example, to pipe the output of an <command>ls</command> command to a text file, type <command>ls | pluma</command>, then press <keycap>Return</keycap>.</para>
<para>The output of the <command>ls</command> command is displayed in a new text file in the <application>&app;</application> window.</para>
<para>Alternatively, you can use the <application>External tools</application> plugin to pipe command output to the current file. <!-- fixme: xref needed! --></para>
</sect2>
</sect1>
<!-- ================ Shortcut Keys ============================= -->
<sect1 id="pluma-shortcutkeys">
<title>Shortcut Keys</title>
<para>Use shortcut keys to perform common tasks more quickly than with the mouse and menus. The following tables list all of <application>&app;</application>'s shortcut keys.</para>
<para>For more on shortcut keys, see the <ulink type="help" url="help:mate-user-guide/keyboard-skills">Desktop User Guide</ulink>.</para>
<!-- ============= Tabs ======================== -->
<bridgehead>Tabs</bridgehead>
<para>Shortcuts for tabs:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para></entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para>Ctrl + Alt + PageUp</para></entry>
<entry><para>Switches to the next tab to the left.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + Alt + PageDown</para></entry>
<entry><para>Switches to the next tab to the right.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + W</para></entry>
<entry><para>Close tab.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + Shift + L</para></entry>
<entry><para>Save all tabs.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + Shift + W</para></entry>
<entry><para>Close all tabs. </para></entry>
</row>
<row valign="top">
<entry><para>Alt + n</para></entry>
<entry><para>Jump to nth tab.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Files ======================== -->
<bridgehead>Files</bridgehead>
<para>Shortcuts for working with files:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para></entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para>Ctrl + N</para></entry>
<entry><para>Create a new document.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + O</para></entry>
<entry><para>Open a document.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + L</para></entry>
<entry><para>Open a location.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + S</para></entry>
<entry><para>Save the current document to disk.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + Shift + S</para></entry>
<entry><para>Save the current document with a new filename.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + P</para></entry>
<entry><para>Print the current document.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + Shift + P</para></entry>
<entry><para>Print preview.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + W</para></entry>
<entry><para>Close the current document.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + Q</para></entry>
<entry><para>Quit Pluma.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Edit ======================= -->
<bridgehead>Edit</bridgehead>
<para>Shortcuts for editing documents:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para></entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para>Ctrl + Z</para></entry>
<entry><para>Undo the last action.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + Shift + Z</para></entry>
<entry><para>Redo the last undone action .</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + X</para></entry>
<entry><para>Cut the selected text or region and place it on the clipboard.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + C</para></entry>
<entry><para>Copy the selected text or region onto the clipboard.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + V</para></entry>
<entry><para>Paste the contents of the clipboard.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + A</para></entry>
<entry><para>Select all.</para></entry>
</row>
<row valign="top">
<entry><para>Ctrl + D</para></entry>
<entry><para>Delete current line.</para></entry>
</row>
<row valign="top">