1
<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
2
<!ENTITY version "0.9.0">
11
<year>1998, 1999, 2000</year>
12
<holder>Alex Roberts and Evan Lawrence</holder>
16
<holder>Eric Baudais (Documentation Author)</holder>
19
<!-- translators: uncomment this:
23
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
30
Permission is granted to copy, distribute and/or modify this
31
document under the terms of the <citetitle>GNU Free Documentation
32
License</citetitle>, Version 1.1 or any later version published
33
by the Free Software Foundation with no Invariant Sections, no
34
Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy
35
of the <citetitle>GNU Free Documentation License</citetitle> from
36
the Free Software Foundation by visiting <ulink type="http"
37
url="http://www.fsf.org">their Web site</ulink> or by writing to:
38
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
39
Boston, MA 02111-1307, USA.
42
Many of the names used by companies to distinguish their products and
43
services are claimed as trademarks. Where those names appear in any
44
GNOME documentation, and those trademarks are made aware to the members
45
of the GNOME Documentation Project, the names have been printed in caps
50
<!-- this is version of manual, not application -->
52
This is version 1.0 of the gedit manual.
58
<title>Introduction</title>
61
<application>Gedit</application> is a light-weight text editor. It has
62
all the basic features you come to expect from a simple text editor, but
63
<application>gedit</application> has a native graphic user interface (GUI).
64
<application>Gedit</application> also has command line arguments available to
65
users to quickly and easily view and edit files from a <systemitem>terminal</systemitem>.
66
Overall, <application>gedit</application> is an easy to use text editor with
67
utilizing the powerful capabilities of the <systemitem>GNOME desktop</systemitem>.
71
<application>Gedit</application> has a verastile plug-in architecture to extend its
72
capablilties. This allows you to perform functions you don't normally except from a text
73
editor, such as piping the outputing of a shell command to the screen.
74
The plug-in architecture also lets you email people,
75
browse the internet, or produce a <command>diff</command> from <application>gedit</application>.
79
<application>Gedit</application> provides a variety of ways to accomplish all your
80
text editing needs. <application>Gedit</application> has the traditional menu,
81
with all the commands, tools, and options. It also has a toolbar, where the commands
82
you use most often will be found. You can also place the menu and the toolbar anywhere on
83
the desktop you choose, for quick access. <application>Gedit</application> also has
84
a menu in the <interface>text window</interface>. You need to click the right mouse button
85
to access the menu. Inside you'll see the common editing commands you use the most.
86
<application>Gedit</application> provides a <interface>menu</interface>,
87
<interface>toolbar</interface>, and <interface>right click menu</interface> in order to
88
give you the quickest and easiest access to <application>gedit's</application> commands.
92
To run <application>gedit</application>, select
93
<guimenuitem>gedit</guimenuitem> from the
94
<guisubmenu>Applications</guisubmenu> submenu of the <guimenu>Main
95
Menu</guimenu>, or type <command>gedit</command> on the
100
<application>Gedit</application> is a basic application of the
101
GNOME desktop environment. This document describes version
102
&version; of <application>gedit</application>.
107
<title>Using gedit</title>
110
A text editor is an essential tool for your GNOME desktop. From
111
writing a small document, editing a configuration file, or composing
112
a webpage, <application>gedit</application> will fill your
113
need. <!--Another useful feature is <application>gedit's</application>
114
<link linkend="plugins">plug-ins</link>. They extend the functionality
115
of the basic text editor.-->
119
Starting <application>gedit</application> opens
120
the <interface>Main window</interface>.
122
<figure id="mainwindow-fig">
123
<title>gedit Main Window</title>
125
<screeninfo>gedit Main Window</screeninfo>
126
<graphic fileref="images/gedit" format="png"
127
srccredit="Eric Baudais">
132
From here you see the <link linkend="menubar">menu bar</link>
133
which has all the options and tools for <application>gedit</application>.
134
You also see the toolbar with all
135
the basic commands you will probably use the most in
136
<application>gedit</application>. If you right-click on the text window,
137
under the toolbar, a <link linkend="pop-up-menu">pop-up menu</link>
138
will appear displaying some common editing and file commands.
142
<application>Gedit</application> has <link linkend="plugins">plug-ins</link>
143
so you can send a quick email to a friend, lookup a
144
webpage if you need help with your work, or produce a file that tells
145
the difference between two other files, using the <command>diff</command> command.
146
The shell output plugin inserts the output of any shell command into
147
<application>gedit</application>. <application>Gedit's</application>
148
plug-ins will let you insert the current time in your document, as it
149
appears in <command>date</command>, insert the phrase <quote>Hello World</quote>
150
in your current document, reverse the letters in the current document
151
you're editing, or convert a decimal number to either a hexidecimal
155
Decimal, hexidecimal, and octal numbers are number with a different base.
156
A decimal number has a base of 10, these are numbers you see everyday,
157
hexidecimal number has a base of 16, and octal numbers have a base of 8.
158
So, a decimal number of 45 would be 2D in hexidecimal, and 55 in octal.
164
<sect2 id="usage-commandline">
165
<title>Using gedit from the Command line</title>
168
<application>Gedit</application> can also be started from the command line,
169
by typing <command>gedit</command> with the name of the file you want to
170
edit. This will open a new <interface>Main Window</interface> of
171
<application>gedit</application> with the file you typed in the command line.
172
You can also open multiple files in <application>gedit</application> from
173
the command line. You type <command>gedit</command> with each file's
174
name, separated by a space, after the command <command>gedit</command>.
175
So, to open the three files <filename>file1.txt</filename>,
176
<filename>file2.txt</filename>, and <filename>file3.txt</filename>, you
177
need to type <command>gedit</command> <filename>file1.txt</filename>
178
<filename>file2.txt</filename> <filename>file3.txt</filename> in a terminal
179
and <application>gedit</application> will open the three file listed above.
180
This feature is very handy to quickly edit a configuration file or script
181
while you are using your favorite shell.
184
If you open a file using <application>gedit</application> from a
185
<systemitem>X terminal</systemitem> and then kill the
186
<systemitem>X terminal</systemitem>, the <application>gedit</application>
187
you opened will also be killed. This happens because
188
<application>gedit</application> is a child process of the
189
<systemitem>X terminal</systemitem>, the parent process. In the
190
Unix environment if you kill the parent process, all the child processes
191
that are spawned by the parent process are killed. Killing all the
192
<quote>children</quote> of the parent process is very useful in
193
a Unix environment. It's really okay if you don't understand the above
194
explanation. Just remember if you open gedit in a
195
<systemitem>X terminal</systemitem> and kill the <systemitem>X terminal</systemitem>,
196
<application>gedit</application> will also be killed.
202
<application>Gedit</application> also has support for pipes when you use it
203
in a <systemitem>console</systemitem> or <systemitem>X terminal</systemitem>.
204
When you use a pipe with <application>gedit</application>, on the command line,
205
<application>Gedit</application> is opened and the output of the other
206
command that is piped to <application>gedit</application> is displayed as
207
a text file in <application>gedit's</application> <interface>Main Window</interface>.
208
For example if you want to display a listing of what files are in a specific
209
directory using the <command>ls</command> command, you will type <command>ls</command>
210
<command>|</command> <command>gedit</command>.
213
The | (pipe) character varies from keyboard to keyboard, but it will, most often, be
214
underneath the \ (backslash)character. Some common places to look for the pipe
215
character is: to the right on the shift key on the right side of the keyboard, to
216
the right of the ] (square bracket) key or above the enter key on the right side
217
of the keyboard, or to the left of the backspace key on the right side of the keyboard.
220
The output of <command>ls</command>,
221
that is normally displayed on the <systemitem>console</systemitem> or
222
<systemitem>X terminal</systemitem>, will be displayed in
223
<application>gedit</application> as a new text file. This option is very useful
224
for commands that display their output too fast or if you want to use the output
228
<!-- ***FIXME: Need to write something about the toolbar?*** -->
229
<!-- <sect2 id="toolbar">
230
<title>Toolbar</title>
232
<figure id="toolbar-fig">
233
<title>gedit Toolbar</title>
235
<screeninfo>gedit toolbar</screeninfo>
236
<graphic fileref="images/toolbar" format="png"
247
<title>Plug-ins</title>
250
There are many plugins that come with <application>gedit</application>. They are meant
251
to extend and enhance the abilities of <application>gedit</application>. The plugins are
252
separate from the main program and thus supplement <application>gedit</application> while
253
only adding the capabilities and size to <application>gedit</application> that you want.
256
<figure id="manager-fig">
257
<title>Plugin Manager</title>
259
<screeninfo>plugin manager</screeninfo>
260
<graphic fileref="images/manager" format="png"
261
srccredit="Eric Baudais">
267
When <application>gedit</application> starts, you will see in the <guimenu>Plugins</guimenu>
268
menu a menu item for each of the installed plugins. You need to open the
269
<guimenuitem>Manager…</guimenuitem> to choose which plugins
270
you want to enable in <application>gedit</application>. The plugin manager lets you choose
271
only the plugins you want to use. You will notice only the plugins you install will be shown
272
in the <guimenu>Plugin</guimenu> menu. Click on which plugin you want to install,
273
in the left window, and then press the <guibutton>Add</guibutton> button. This will install one plugin in
274
<application>gedit</application> and put the plugin in the <guimenu>Plugin</guimenu> menu, so
275
you can run the plugin. If you want to install all the plugins, just press the
276
<guibutton>Add All</guibutton> button. To uninstall a plugin in <application>gedit</application>,
277
click on the plugin you want to uninstall, in the right window, and press the <guibutton>Remove</guibutton>
278
button. If you want to disable all the plugins, just press the <guibutton>Remove All</guibutton>
283
<title>The Browse Plugin</title>
285
<figure id="browse-fig">
286
<title>Browse Plugin</title>
288
<screeninfo>browse plugin</screeninfo>
289
<graphic fileref="images/browse" format="png"
290
srccredit="Eric Baudais">
296
The <guimenuitem>browse</guimenuitem> plugin has a text window to enter the url of the webpage
297
you want to visit. When you enter the url, <application>gedit</application> displays the
298
webpage in the <systemitem>main window</systemitem>. If <application>Lynx</application> does
299
not have the correct path, at the bottom
300
of the dialog, you can change it by clicking the <guibutton>Change</guibutton> button.
301
<figure id="mlynx-fig">
302
<title>Change Lynx Path</title>
304
<screeninfo>change lynx path</screeninfo>
305
<graphic fileref="images/lynx" format="png"
306
srccredit="Eric Baudais">
310
You then need to enter the correct path for your system in the text window or click the
311
<guibutton>Browse</guibutton> button to find <filename>lynx</filename> on your system.
312
After you have all the correct fields filled in, press the <guibutton>OK</guibutton> to
318
<title>The Diff Plugin</title>
320
<figure id="diff-fig">
321
<title>Diff Plugin</title>
323
<screeninfo>diff plugin</screeninfo>
324
<graphic fileref="images/diff" format="png"
325
srccredit="Eric Baudais">
331
The <guimenuitem>diff</guimenuitem> plugin has two ways to select the file you want to
332
determine its difference. You can select the original file from the list of files you have opened
333
in <application>gedit</application>. You can also enter the original file in
334
the first text window (the one on the left). You then enter the revised file in the second text
335
window (the one on the right) or by selecting the file from the list of opened files in
336
<application>gedit</application> (on the right). The difference of the files will then be seen in the
337
<systemitem>Main Window</systemitem>.
341
<application>Gedit</application> runs the <command>diff</command> command on the two files
342
you enter in the dialog. The output is then displayed in <application>gedit's</application>
343
<systemitem>Main Window</systemitem>. If the first file entered is <filename>file1.txt</filename>
344
and the second file entered is <filename>file2.txt</filename>, then the gedit will display the
345
output of the command <prompt>$</prompt><command>diff</command> <filename>file1.txt</filename>
346
<filename>file2.txt</filename>.
353
<title>The Email Plugin</title>
355
<figure id="email-fig">
356
<title>Email Plugin</title>
358
<screeninfo>email plugin</screeninfo>
359
<graphic fileref="images/email" format="png"
360
srccredit="Eric Baudais">
366
The <guimenuitem>email</guimenuitem> plugin lets you send the text file you are editing as the body of
367
the email. The subject will automatically be the filename, but can be changed in the dialog.
368
The <guilabel>From:</guilabel> text window will automatically have the email address provided by
369
your system. You can also change it, if you wish the receiving party to send a reply to a different
370
email address. You need to enter the receiver's email address in the <guilabel>To:</guilabel>
371
text window. If the path to your sendmail compatible mailer
374
A sendmail compatible mailer is a program that delivers your email to the correct server on the
375
internet, so your email will reach its destination. The program uses SMTP
376
(Simple Mail Transfer Protocol) to send your email. The distinction between a sendmail
377
compatible mailer and a non-sendmail compatible mailer is the command line arguments.
378
A sendmail compatible mailer will have the same command line arguments as
379
<application>sendmail</application>, even if the way it handles everything else is completely
383
is not displayed at the bottom
384
of the dialog, you can change it by clicking the <guibutton>Change</guibutton> button.
385
<figure id="mta-fig">
386
<title>Change sendmail directory</title>
388
<screeninfo>change sendmail</screeninfo>
389
<graphic fileref="images/mta" format="png"
390
srccredit="Eric Baudais">
394
You then need to enter the correct path of your sendmail compatible mailer, for your system,
395
in the text window or click the
396
<guibutton>Browse</guibutton> button to find the sendmail compatible mailer on your system.
397
If you do not have a sendmail compatible mailer, you need one to use the email plugin.
398
After you have all the correct fields filled in, press the <guibutton>OK</guibutton> to send
399
the email or press the <guibutton>Cancel</guibutton> to not send the email.
404
<title>The Insert Time Plugin</title>
407
The <guimenuitem>insert time</guimenuitem> plugin puts the date and time into the document. It
408
uses the <command>date</command> command and inserts the output into the text.
413
<title>The Hello World Plugin</title>
416
The <guimenuitem>hello world</guimenuitem> plugin puts the text <quote>Hello World</quote> into
417
the document. It is meant to be a template for all the other plugins. If you are interested in
418
writing a plugin for <application>gedit</application>, take a look at the source code for the
419
<guimenuitem>hello world</guimenuitem> plugin and contact the <link linkend="authors">maintainers</link>
420
, so your work isn't duplicated.
425
<title>The Reverse Plugin</title>
428
This plugin is still in development. Write about it when it is done.
433
<title>The Shell Output Plugin</title>
435
<figure id="shell-fig">
436
<title>Shell Output Plugin</title>
438
<screeninfo>shell output plugin</screeninfo>
439
<graphic fileref="images/shell" format="png"
440
srccredit="Eric Baudais">
446
The <guimenuitem>shell output</guimenuitem> plugin executes the command in the directory that is
447
displayed and puts the output in the <systemitem>Main Window</systemitem>.The shell output
448
plugin is designed for inserting text resulting from the execution of a console based command.
449
However, <application>gedit</application> will not stop you if you try to launch another
450
application, such as <application>gnumeric</application>. So, should only execute commands
451
displaying text on the console and commands which are not interactive.
454
The shell you are using
455
will stay the same for the shell output plugin. So, if you use <application>bash</application> as your shell,
456
<application>gedit</application> will execute the command in <application>bash</application>. This lets
457
you put output you would normally see in a console or terminal in the middle of the text file
465
<title>Customization</title>
468
To change the application settings, select
469
<guimenuitem>Preferences…</guimenuitem> from the
470
<guimenu>Settings</guimenu> menu. This opens the
471
<interface>Preferences</interface> dialog.
475
You can make gedit your default editor. The default editor will start when a
476
document opens, you need to edit, by another application. To make
477
<application>gedit</application> your default editor, enter <command>export</command>
478
EDITOR='gedit' in the terminal. This will only change your
479
system settings until you reboot again. To make the change permanent, edit your
480
<filename>.bash_profile</filename>, if you are using <application>bash</application>.
481
Add the line <quote><command>export</command> EDITOR='gedit'</quote>
482
to <filename>.bash_profile</filename>. If you are using another shell, you need to find
483
out what file to change and change the environment variable $EDITOR to gedit.
487
<title>General</title>
489
<figure id="preferences-fig">
490
<title>The Preferences Dialog with the General Tab Highlighted</title>
492
<screeninfo>Preferences dialog with General tab</screeninfo>
493
<graphic fileref="images/prefs-general" format="png"
494
srccredit="Eric Baudais">
501
<term><guilabel>Appearance</guilabel></term>
505
This section contains:
507
<itemizedlist mark="opencircle">
510
<guibutton>Show Statusbar</guibutton> —
511
This option determines whether the status bar at the bottom of the
512
<interface>Main Window</interface> is shown or hidden. The status bar
513
gives you a brief description of the various menu items or messages about
514
what <application>gedit</application> is currently doing.
520
<guibutton>Set toolbar according to system settings</guibutton> —
521
This option displays the toolbar with the system settings for GNOME. You can
522
change the system settings for the toolbar in the
523
<application>Control Center</application>. To change the system settings for
524
GNOME, start the <application>Control Center</application>by selecting
525
<guimenuitem>GNOME Control Center</guimenuitem> from the
526
<guisubmenu>Settings</guisubmenu> submenu of the <guimenu>Main
527
Menu</guimenu>. Then select the <guisubmenu>Applications</guisubmenu> submenu
528
from the <guimenu>User Interface</guimenu> menu.
534
<guibutton>Set toolbar to Icons only</guibutton> —
535
This option displays the toolbar with just the icons. There is no text under
536
each icon to tell you what it does. The option overrides whatever you have
537
selected for the toolbar behavior in the <application>Control Center</application>.
543
<guibutton>Set toolbar to Icons with text</guibutton> —
544
This option displays the toolbar with the explanatory text under each icon.
545
The option overrides whatever you have selected for the toolbar behavior
546
in the <application>Control Center</application>.
556
<term><guilabel>Editor Behavior</guilabel></term>
560
This section contains:
562
<itemizedlist mark="opencircle">
566
<guibutton>Enable Auto-indent</guibutton> —
567
This option turns on the auto-indent ability in <application>gedit</application>.
568
Auto-indent automatically indents the text at the same place in the line as the
569
text in the previous line. Auto-indent is very useful when you are writing
570
configuration files, scripts, code, etc… If you want to write paragraphs
571
of text, the auto-indent function can be a hassle.
574
<!-- ***This option is deprecated or just not around.***
577
<guibutton>Enable Wordwrap</guibutton> —
578
This option turns on wordwrap. Wordwrap automatically puts the text you type on the next
579
line, if your text exceeds the visible area in the <interface>text window</interface>.
592
<sect2 id="documents">
593
<title>Documents</title>
595
<figure id="documents-fig">
596
<title>The Preferences Dialog with the Documents Tab Highlighted</title>
598
<screeninfo>Preferences dialog with Documents tab</screeninfo>
599
<graphic fileref="images/prefs-documents" format="png"
600
srccredit="Eric Baudais">
607
<term><guilabel>MDI (Multiple Document Interface)</guilabel></term>
611
This section contains:
613
<itemizedlist mark="opencircle">
616
<guilabel>Mode:</guilabel> —
617
This option specifies the way <application>gedit</application> displays the
618
<interface>Main Window</interface> and how it opens new documents. The option
619
determines the user interface you like to use for the <interface>Main Window</interface>
620
There are 4 types of modes <application>gedit</application> can use. They
621
are the notebook, toplevel, modal, and default modes.
625
The notebook style looks strikingly similar to the
626
<guimenuitem>Preferences…</guimenuitem> dialog. The most notable thing about
627
this style is the tabs at the top of the <interface>Main Window</interface>. The
628
highlighted tab is the document you are currently viewing. To change the document
629
to another open document, just click on the cooresponding tab. In the notebook
630
style you cannot view multiple documents at the same time. Only the current
631
document can be seen.
635
The toplevel style opens a new occurance of <application>gedit</application> for
636
each document opened. The windows are stacked one on top of another, so they
637
completely overlap. From this position, you can move the multiple
638
<application>gedit</application> windows around to your liking. This lets you
639
see more than one document, or different positions in the same document.
643
The modal style will only open one occurance of gedit, no matter how many documents
644
you open. You have to use the <guimenu>Documents</guimenu> menu to change between
645
different documents. The default style is the same style as the modal style. This
646
is a change from previous versions of <application>gedit</application>. The modal
647
style is a very plain style for <application>gedit</application>.
653
<guilabel>Notebook Tab Position:</guilabel> —
654
This option changes the place the tabs for the notebook style are located.
664
<term><guilabel>Undo</guilabel></term>
668
This section contains:
670
<itemizedlist mark="opencircle">
673
<guilabel>Set limit on undo levels to:</guilabel> —
674
This option sets the number of times you can undo a mistake. So, if
675
you set the limit to 5 undo levels, then you can only use the undo button
676
five times. If you make a lot of mistakes, like me, you might want to set
677
this level higher than the default of 5 undo levels.
680
Users with low memory, under 16 MB, should set the number of undo levels
681
lower because <application>gedit</application> stores each
682
command into memory to the undo level limit. So, if you set the undo
683
level limit to 50, then <application>gedit</application> will store
684
up to 50 commands in your main memory.
698
<title>Fonts/Colors</title>
700
<figure id="fonts-fig">
701
<title>The Preferences Dialog with the Fonts/Colors Tab Highlighted</title>
703
<screeninfo>Preferences dialog with Fonts/Colors tab</screeninfo>
704
<graphic fileref="images/prefs-font" format="png"
705
srccredit="Eric Baudais">
712
<term><guilabel>Fonts</guilabel></term>
716
This section contains:
718
<itemizedlist mark="opencircle">
721
<guilabel>Default Font</guilabel> —
722
This option changes the font used in <application>gedit</application>.
732
<term><guilabel>Colors</guilabel></term>
736
This section contains:
738
<itemizedlist mark="opencircle">
741
<guilabel>Background:</guilabel> —
742
This option lets you choose the background color in <application>gedit</application>.
743
This is the background color of the <interface>Main Window</interface>.
749
<guilabel>Foreground:</guilabel> —
750
This option lets you choose the foreground color in <application>gedit</application>.
751
This is the background color of the <interface>Main Window</interface>.
762
<sect2 id="printing">
763
<title>Printing</title>
765
<figure id="printing-fig">
766
<title>The Preferences Dialog with the Printing Tab Highlighted</title>
768
<screeninfo>Fonts/Colors dialog with Printing tab</screeninfo>
769
<graphic fileref="images/prefs-printing" format="png"
770
srccredit="Eric Baudais">
777
<term><guilabel>Printing</guilabel></term>
781
This section contains:
783
<itemizedlist mark="opencircle">
786
<guibutton>Add header</guibutton> —
787
This option adds a header to each page you print in <application>gedit</application>.
788
As of <application>gedit</application> version 0.8.0, you cannot configure
795
<guibutton>Enable word wrapping</guibutton> —
796
This option turns on wordwrap. Wordwrap automatically puts the text you typed on the next
797
line, if you exceed the page's width you select in the <link linkend="paper">Paper tab
798
of the Preferences dialog</link>. So, you do not have to explicitly press the
799
<keysym>return</keysym> key for each line you wanted printed.
805
<guibutton>Print line numbers every:</guibutton> —
806
This option prints the line number of the file. You also have to select how often
807
you want to line numbers printed. The default is to print the line number every five
814
<guibutton>Portrait</guibutton> —
815
This option selects to print the page using the portrait style. The portrait style
816
has the text printed across the smallest side of the paper.
822
<guibutton>Landscape</guibutton> —
823
This option selects to print the page using the portrait style. The portrait style
824
has the text printed across the largest side of the paper.
838
<figure id="paper-fig">
839
<title>The Preferences Dialog with the Paper Tab Highlighted</title>
841
<screeninfo>Fonts/Colors dialog with Paper tab</screeninfo>
842
<graphic fileref="images/prefs-paper" format="png"
843
srccredit="Eric Baudais">
849
This section contains:
851
<itemizedlist mark="opencircle">
854
<guilabel>Paper:</guilabel> —
855
This option selects the type of paper you will use to print the document.
856
The <guilabel>width</guilabel> and <guilabel>height</guilabel> boxes will
857
change automatically for the correct paper size.
863
<guilabel>Width:</guilabel> —
864
This option selects the width of the paper you will use to print the document.
865
To the right of the <guilabel>width</guilabel> box is another box you can use
866
to change the units the paper is measured in for the <guilabel>width</guilabel>
867
and <guilabel>height</guilabel> boxes.
873
<guilabel>Height:</guilabel> —
874
This option selects the height of the paper you will use to print the document.
875
To the right of the <guilabel>height</guilabel> box is the units the height
876
of the paper is measured in.
882
<guibutton>Set System Paper Size</guibutton> —
883
This option sets the paper size in the <guilabel>width</guilabel> and
884
<guilabel>height</guilabel> boxes to the system paper size. The system
885
paper size is determined by the number in the environment variable $PAPERCONF
886
or in the file <filename>paperconf</filename>.
899
In <application>gedit</application> there are three different type of menus. The
900
<interface>menu bar</interface> contains all the commands, options, and plug-ins.
901
The <interface>toolbar</interface> contains selected commands the user uses the
902
most. The <interface>right click menu</interface> in the <interface>text window</interface>,
903
contains the commands that are useful while editing a file. Only the <interface>menu bar</interface>
904
is described in this section because it is so large. The
905
<interface>toolbar</interface> and <link linkend="pop-up-menu"><interface>
906
right click menu</interface></link> are talked about in other sections of <application>
907
gedit's</application> manual.
911
<title>Menu Bar</title>
913
The <interface>menu bar</interface> can be moved around the
914
<interface>desktop</interface>. When you click on the far left side
915
of the <interface>menu bar</interface>, on the raised dotted portion, you
919
Dragging refers to the action in which you click on an object, with your mouse,
920
and move the mouse pointer without releasing the previously clicked button.
921
You can then release the mouse button and the object you were moving with the
922
mouse will stay on the desktop where you released the mouse button. This
923
action is generally called <quote>drag and drop.</quote>
926
the menu bar with your mouse and move it anywhere on your desktop. The
927
<interface>menu bar</interface> can also snap into place on all four sides
928
of the <interface>Main Window</interface>, if you place your mouse close
929
to the edge of the <interface>Main Window</interface>. The menu bar's
930
default position is located at the top of the <interface>Main Window</interface>
931
and contains the following menus:
937
<term><guimenu>File</guimenu></term>
943
<itemizedlist mark="opencircle">
948
<guimenuitem>New</guimenuitem>
949
</menuchoice> —
950
This item opens a new file.
960
<guimenuitem>Open…</guimenuitem>
961
</menuchoice> —
962
This item brings up the <interface>Open File…</interface> dialog. From there
963
you can open an existing file.
971
<keysym>Ctl-S</keysym>
973
<guimenuitem>Save</guimenuitem>
974
</menuchoice> —
975
This item saves the current file, if the file was previously saved, or brings
976
up the <interface>Save As&hellip</interface> dialog to save the file.
983
<guimenuitem>Save All</guimenuitem>
984
</menuchoice> —
985
This item saves all the files that are open in <application>gedit</application>.
992
<guimenuitem>Save As…</guimenuitem>
993
</menuchoice> —
994
This item brings up the <interface>Save As&hellip</interface> dialog to save the selected file
995
in <application>gedit</application>. You should use this command if you want to save the
996
file under a different name.
1003
<guimenuitem>Revert</guimenuitem>
1004
</menuchoice> —
1005
This item discards all changes you made to your unsaved file and opens the
1006
original file in the <interface>Main Window</interface>.
1013
<guimenuitem>1.</guimenuitem>
1014
</menuchoice> —
1015
This part of the <guimenu>File</guimenu> menu shows the four most recent
1016
files you opened with <application>gedit</application>. When you click on
1017
one of the files displayed, that specific file is opened.
1024
<guimenuitem>Print</guimenuitem>
1025
</menuchoice> —
1027
<figure id="print-dialog-fig">
1028
<title>Print Document Dialog</title>
1030
<screeninfo>Print Document dialog</screeninfo>
1031
<graphic fileref="images/print" format="png"
1032
srccredit="Eric Baudais">
1037
This item brings up the <interface>Print Document</interface> dialog.
1038
The <interface>Print Document</interface> dialog is divided into two
1039
parts: the <guilabel>Select printer</guilabel> section and the
1040
<guilabel>Print Range</guilabel> section.
1044
The <guilabel>Select printer</guilabel> section lets you specify whether
1045
the file will be printed to a printer or printed to a pre-press
1048
A pre-press file is one that a professional printing company can take
1049
and produce brochures, flyers, letterheads, etc. The file formats which
1050
are referred to are PS (Postscript) and PDF
1051
(Portable Document Format).
1055
The button for the <guibutton>Printer</guibutton> and <guibutton>File</guibutton>
1056
options are on the left side of the dialog. If you choose to print the file
1057
to a printer, you need to verify the printing command is correct, in the text
1058
window to the right of the <guibutton>Printer</guibutton> button. If you
1059
choose to print the file to a pre-press file, you need to enter the name of
1060
the file, in the text window to the right of the <guibutton>File</guibutton>
1061
button. The default file name is <filename>output.ps</filename>.
1062
You also can choose the type of pre-press file format from the pull down
1063
menu <guilabel>Name:</guilabel>.
1067
The <guilabel>Print Range</guilabel> section lets you specify what parts of the
1068
file you wish to print. When the <guibutton>All</guibutton> button is pressed the
1069
whole file will be printed. If you want to specify certain pages, of the file,
1070
to be printed, you need to press the <guibutton>Pages</guibutton> button and enter the
1071
starting and ending page number. If you only want a certain selection of the file,
1072
which you have highlighted, to be printed, you need to press the
1073
<guibutton>Selection</guibutton> button.
1077
There are three buttons at the bottom of the <interface>Print Document</interface>
1078
dialog. The <guibutton>Print</guibutton> button will print the document using the
1079
options in the <interface>Print Document</interface> dialog. The
1080
<guibutton>Preview</guibutton> button exits the <interface>Print Document</interface>
1081
dialog and brings up the <interface>Print Preview</interface> dialog. The
1082
<interface>Print Preview</interface> dialog lets you preview the document before
1091
<guimenuitem>Print Preview</guimenuitem>
1092
</menuchoice> —
1094
<figure id="print-preview-fig">
1095
<title>Print Preview Document Dialog</title>
1097
<screeninfo>Print Preview Document dialog</screeninfo>
1098
<graphic fileref="images/print-preview" format="png"
1099
srccredit="Eric Baudais">
1104
The <interface>Print Preview</interface> dialog lets you preview the document before
1113
<keysym>Ctl-W</keysym>
1115
<guimenuitem>Close</guimenuitem>
1116
</menuchoice> —
1117
This item closes the current document in <application>gedit</application>. If
1118
the item isn't saved, <application>gedit</application> will ask you if you
1119
want to save the file or discard the changes you made to the file.
1126
<guimenuitem>Close All</guimenuitem>
1127
</menuchoice> —
1128
This item closes all the documents in <application>gedit</application>. If
1129
any files aren't saved, <application>gedit</application> will ask you if you
1130
want to save the file or discard the changes you made to the file.
1138
<keysym>Ctl-Q</keysym>
1140
<guimenuitem>Exit</guimenuitem>
1141
</menuchoice> —
1142
This item exits <application>gedit</application>. If
1143
any files aren't saved, <application>gedit</application> will ask you if you
1144
want to save the file or discard the changes you made to it.
1155
<term><guimenu>Edit</guimenu></term>
1160
<itemizedlist mark="opencircle">
1165
<keysym>Ctl-Z</keysym>
1167
<guimenuitem>Undo</guimenuitem>
1168
</menuchoice> —
1169
This item returns the document to its previous state before each command is executed
1170
or word is typed; it essentially takes back each command or typed word in the order
1171
they were performed. You can only take back a certain number of commands. The
1172
option is configured in the <link linkend="documents-fig"><interface>Preferences…</interface>
1181
<keysym>Ctl-R</keysym>
1183
<guimenuitem>Redo</guimenuitem>
1184
</menuchoice> —
1185
This item returns the document to its state before the
1186
<guimenuitem>Undo</guimenuitem> command was executed. It's the opposite of
1187
<guimenuitem>Undo</guimenuitem>.
1195
<keysym>Ctl-X</keysym>
1197
<guimenuitem>Cut</guimenuitem>
1198
</menuchoice> —
1199
This item puts the highlighted text, in the <interface>text window</interface>,
1200
in a buffer and then deletes the text that is highlighted from the file.
1201
The <guimenuitem>Paste</guimenuitem> command takes the text
1202
out of the buffer and inserts it in the file you are editing.
1210
<keysym>Ctl-C</keysym>
1212
<guimenuitem>Copy</guimenuitem>
1213
</menuchoice> —
1214
This item puts the highlighted text, in the <interface>text window</interface>,
1215
in a buffer, but does not delete the text that is highlighted.
1216
The <guimenuitem>Paste</guimenuitem> command takes the text
1217
out of the buffer and inserts it in the file you are editing.
1225
<keysym>Ctl-V</keysym>
1227
<guimenuitem>Paste</guimenuitem>
1228
</menuchoice> —
1229
This item takes any text in the buffer and inserts it into the document. The
1230
<guimenuitem>Cut</guimenuitem> and <guimenuitem>Copy</guimenuitem> commands
1231
are the only way to put text into the buffer.
1238
<guimenuitem>Select All</guimenuitem>
1239
</menuchoice> —
1240
This item highlights all the text in the current file you are editing.
1250
<guimenuitem>Find</guimenuitem>
1251
</menuchoice> —
1253
<figure id="find-dialog-fig">
1254
<title>Find Dialog</title>
1256
<screeninfo>Find dialog</screeninfo>
1257
<graphic fileref="images/find" format="png"
1258
srccredit="Eric Baudais">
1263
This item brings up the <interface>Find</interface> dialog. You enter the
1264
string you want to search for in the <guilabel>Search For:</guilabel>
1265
<interface>text window</interface>. You can either start your search at the beginning of
1266
you file, pressing the <guibutton>beginning of the document</guibutton> button,
1267
or start it where the cursor is located in the <interface>Main Window</interface>,
1268
using the <guibutton>cursor position</guibutton> button. You can also specify if
1269
you want <application>gedit</application> to search for the string with the case
1270
how you entered it or have <application>gedit</application> ignore the case of the
1279
<keysym>Shift-F6</keysym>
1281
<guimenuitem>Find Again</guimenuitem>
1282
</menuchoice> —
1283
This item searches for the string you previously entered in the
1284
<interface>Find</interface> dialog.
1294
<guimenuitem>Replace</guimenuitem>
1295
</menuchoice> —
1298
<figure id="replace-dialog-fig">
1299
<title>Replace Dialog</title>
1301
<screeninfo>Replace dialog</screeninfo>
1302
<graphic fileref="images/replace" format="png"
1303
srccredit="Eric Baudais">
1308
This item brings up the <interface>Replace</interface> dialog. This allows
1309
you to search for a string and replace it with another string. You enter
1310
the string you want to search for in the <guilabel>Search For:</guilabel>
1311
<interface>text window</interface>. You then enter the string, you want
1312
to replace the string you searched for, in the <guilabel>Replace with:</guilabel>
1313
<interface>text window</interface>. You can either start your search at the beginning of
1314
your file, pressing the <guibutton>beginning of the document</guibutton> button,
1315
or start it where the cursor is located in the <interface>Main Window</interface>,
1316
using the <guibutton>cursor position</guibutton> button. You can also specify if
1317
you want <application>gedit</application> to search for the string with the case
1318
how you entered it or have <application>gedit</application> ignore the case of the
1322
When you have the string you want to search for and the string you want to replace
1323
it with entered, click on the <guibutton>Find</guibutton> button, at the bottom
1324
of the <interface>Replace</interface> dialog, to find the correct string you are
1325
wanting to replace. Then, click the <guibutton>Replace</guibutton> button to
1326
replace the highlighted string with the string in the <guilabel>Replace with:</guilabel>
1327
<interface>text window</interface>. If, instead, you want to replace all
1328
occurances of the string in the <guilabel>Search for:</guilabel>
1329
<interface>text window</interface>, click the <guibutton>Replace All</guibutton>
1337
<guimenuitem>Goto Line</guimenuitem>
1338
</menuchoice> —
1340
<figure id="goto-dialog-fig">
1341
<title>Goto Line Dialog</title>
1343
<screeninfo>Goto Line dialog</screeninfo>
1344
<graphic fileref="images/goto-line" format="png"
1345
srccredit="Eric Baudais">
1350
This item brings up the <interface>Goto Line</interface> dialog. You enter
1351
the line number you want to move the cursor, in the <interface>Main Window</interface>,
1352
to. Click the <guibutton>Okay</guibutton> button and your cursor is put at
1353
the line number you specified, starting at the beginning of the file. If the
1354
line number you specified exceeded the maximum number of lines in the file, your
1355
cursor will be placed on the last line of the file.
1366
<term><guimenu>View</guimenu></term>
1371
<itemizedlist mark="opencircle">
1375
<guimenuitem>Add View</guimenuitem>
1376
</menuchoice> —
1377
This item opens another window to the current file you are editing. If
1378
you edit the file in one view, the other views of the same file are
1379
updated and your changes are seen across all views of the same file.
1386
<guimenuitem>Remove View</guimenuitem>
1387
</menuchoice> —
1388
This item closes a window to the file you are editing.
1391
You cannot remove a view, if there is only one view open. You need
1392
to have more than one view open to close a view.
1405
<term><guimenu>Settings</guimenu></term>
1410
<itemizedlist mark="opencircle">
1414
<guimenuitem>Show Status Bar</guimenuitem>
1415
</menuchoice> —
1416
This item controls whether you see the status bar or not. The status bar
1417
gives you a brief description of the various menu items or messages about
1418
what <application>gedit</application> is currently doing.
1425
<guimenuitem>Preferences…</guimenuitem>
1426
</menuchoice> —
1427
This item brings up the <link linkend="prefs-0"><interface>Preferences…
1428
</interface></link> dialog.
1439
<term><guimenu>Files</guimenu></term>
1443
The menu contains all the files currently opened in <application>gedit</application>. If
1444
you click on one of the files, the <interface>Main Window</interface> shows the file
1445
you clicked on so you can edit it.
1451
<term><guimenu>Help</guimenu></term>
1456
<itemizedlist mark="opencircle">
1459
<guimenuitem>Help</guimenuitem> —
1466
<guimenuitem>About</guimenuitem> — shows
1467
basic information about
1468
<application>gedit</application>, such as
1469
the author's name, current developers, and the application version number.
1482
<sect2 id="pop-up-menu">
1483
<title>Right Click Menu</title>
1485
The <interface>right click</interface> menu is accessed by clicking
1486
the right mouse button in the <interface>Main Window</interface> of
1487
<application>gedit</application>.
1493
<itemizedlist mark="opencircle">
1499
<keysym>Ctl-X</keysym>
1501
<guimenuitem>Cut</guimenuitem>
1502
</menuchoice> —
1503
This item puts the highlighted text, in the <interface>text window</interface>,
1504
in a buffer and then deletes the text that is highlighted from the file.
1505
The <guimenuitem>Paste</guimenuitem> command takes the text
1506
out of the buffer and inserts it in the file you are editing.
1514
<keysym>Ctl-C</keysym>
1516
<guimenuitem>Copy</guimenuitem>
1517
</menuchoice> —
1518
This item puts the highlighted text, in the <interface>text window</interface>,
1519
in a buffer, but does not delete the text that is highlighted.
1520
The <guimenuitem>Paste</guimenuitem> command takes the text
1521
out of the buffer and inserts it in the file you are editing.
1529
<keysym>Ctl-V</keysym>
1531
<guimenuitem>Paste</guimenuitem>
1532
</menuchoice> —
1533
This item takes any text in the buffer and inserts it into the document. The
1534
<guimenuitem>Cut</guimenuitem> and <guimenuitem>Copy</guimenuitem> commands
1535
are the only way to put text into the buffer.
1542
<guimenuitem>Select All</guimenuitem>
1543
</menuchoice> —
1544
This item highlights all the text in the current file you are editing.
1552
<keysym>Ctl-S</keysym>
1554
<guimenuitem>Save</guimenuitem>
1555
</menuchoice> —
1556
This item saves a file, if it is an existing file, or brings up the
1557
<interface>Save As…</interface> dialog to save the new file.
1565
<keysym>Ctl-W</keysym>
1567
<guimenuitem>Close</guimenuitem>
1568
</menuchoice> —
1569
This item closes the current document in <application>gedit</application>. If
1570
the item isn't saved, <application>gedit</application> will ask you if you
1571
want to save the file or discard the changes you made to the file.
1578
<guimenuitem>Print</guimenuitem>
1579
</menuchoice> —
1580
This item brings up the <interface>Print Document</interface> dialog.
1581
See the <link linkend="print-dialog-fig"><interface>Print Document</interface>
1582
dialog</link> to find out more about the <guimenuitem>Print</guimenuitem> command
1583
in <application>gedit</application>.
1592
<title>Known Bugs and Limitations</title>
1595
<itemizedlist mark="opencircle">
1598
At this point <application>gedit</application> does not have syntax highlighting.
1599
The current text widget that <application>gedit</application> uses is not
1600
suitable for this feature.
1609
<title>Frequently Asked Questions</title>
1611
<qandaset defaultlabel="qanda">
1613
<qandaentry id="highlighting">
1616
I want syntax highlighting. When will it be included?
1622
Currently, the GTK+ Text widget isn't suitable for syntax highlighting to be implemented
1623
reliably. We might add syntax highlighting when we migrate to the new text widget.
1626
On the other hand, <application>gedit</application> intends to be a simple text editor.
1627
If you are looking for syntax highlighting, we strongly recommend you use a full featured
1628
text editor like <application>VIM</application>, <application>emacs</application>, or
1629
<application>elvis</application>.
1634
<qandaentry id="slow-screen">
1637
<application>Gedit</application> seems very slow when I type. After I start typing,
1638
I can see the text appearing slowly, one character at a time. What is wrong?
1643
This behavior occurs when the active theme is poorly written. Change your theme to
1644
a nicely written one. Having this kind of theme is not only affecting the speed
1645
the <application>gedit</application> window is being redrawn, but all the gtk windows.
1646
In <application>gedit</application> it is just more evident.
1655
<!-- ============= Authors ================================ -->
1657
<sect1 id="authors">
1658
<title>Authors</title>
1660
<application>gedit</application> was written by Alex Roberts
1661
(<email>bse@error.fsnet.co.uk</email>) and Evan Lawrence.
1662
<application>gedit</application> is currently being maintained by
1663
Chema Celorio (<email>chema@celorio.com</email>) and Jason Leach
1664
(<email>leach@wam.umd.edu</email>). The artwork for
1665
<application>gedit</application> was done by Steve Hall
1666
(<email>steve_hall@mindspring.com</email>). To find more information about
1667
<application>gedit</application>, please visit the <ulink
1668
url="http://gedit.sourceforge.net" type="http">gedit web
1669
page</ulink> at http://gedit.sourceforge.net. Please send all comments and suggestions to
1670
the <application>gedit</application> mailing list
1671
(<email>gedit-list@sourceforge.org</email>). Send all bug
1672
reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
1673
bug tracking database</ulink>. (Instructions for submitting bug
1674
reports can be found <ulink
1675
url="http://bugs.gnome.org/Reporting.html" type="http">
1676
on-line</ulink>.) If you are using
1677
GNOME 1.1 or later, you can also use <application>Bug Report
1678
Tool</application> (<command>bug-buddy</command>), available in the
1679
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
1680
Menu</guimenu>, for submitting bug reports.
1684
This manual was written by Eric Baudais
1685
(<email>baudais@okstate.edu</email>). Please send all comments and
1686
suggestions regarding this manual to the <ulink type="http"
1687
url="http://www.gnome.org/gdp">GNOME Documentation Project</ulink>
1688
by sending an email to <email>docs@gnome.org</email>. You can also
1689
add your comments online by using the <ulink type="http"
1690
url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
1694
<!-- For translations: uncomment this:
1697
Latin translation was done by ME
1698
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
1699
suggestions regarding this translation to SOMEWHERE.
1707
<!-- ============= Application License ============================= -->
1709
<sect1 id="license">
1710
<title>License</title>
1712
This program is free software; you can redistribute it and/or
1713
modify it under the terms of the <citetitle>GNU General Public
1714
License</citetitle> as published by the Free Software Foundation;
1715
either version 2 of the License, or (at your option) any later
1719
This program is distributed in the hope that it will be useful, but
1720
WITHOUT ANY WARRANTY; without even the implied warranty of
1721
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1722
<citetitle>GNU General Public License</citetitle> for more details.
1725
A copy of the <citetitle>GNU General Public License</citetitle> is
1726
included as an appendix to the <citetitle>GNOME Users
1727
Guide</citetitle>. You may also obtain a copy of the
1728
<citetitle>GNU General Public License</citetitle> from the Free
1729
Software Foundation by visiting <ulink type="http"
1730
url="http://www.fsf.org">their Web site</ulink> or by writing to
1732
Free Software Foundation, Inc.
1733
<street>59 Temple Place</street> - Suite 330
1734
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
1735
<country>USA</country>