~cyphermox/ubuntu/maverick/gnome-nettool/ping-fix : revision 14

35

31

</copyright>

36

32

37

33

-->

38

39

<publishername> GNOME Documentation Project </publishername>

40

</publisher>

41

&legal;

42

43

44

Sun GNOME Documentation Team

45

</corpauthor>

46

47

48

<surname>Baudais</surname>

49

50

<orgname>GNOME Documentation Project</orgname>

51

<address> <email>baudais@okstate.edu</email> </address>

52

</affiliation>

53

</author>

54

55

<firstname>Rodrigo</firstname>

56

57

</author>

58

59

60

<firstname>Baris</firstname>

61

<surname>Cicek provided information from earlier revisions of the gedit application.</surname>

62

<contrib>Acknowledgements</contrib>

63

</othercredit>

64

65

66

<surname>George provided information about plugins.</surname>

67

<contrib>Acknowledgements</contrib>

68

</othercredit>

69

34

35

<publishername>GNOME Documentation Project</publishername>

36

</publisher>

37

&legal;

38

39

40

<firstname>Rodrigo</firstname>

41

42

</author>

70

43

71

44

<!-- This is appropriate place for other contributors: translators,

72

maintainers, etc. Commented out by default.

45

maintainers, etc. Commented out by default.

73

46

74

<firstname>Latin</firstname>

75

<surname>Translator 1</surname>

76

77

<orgname>Latin Translation Team</orgname>

78

<address> <email>translator@gnome.org</email> </address>

79

</affiliation>

80

<contrib>Latin translation</contrib>

47

<firstname>Latin</firstname>

48

<surname>Translator 1</surname>

49

50

<orgname>Latin Translation Team</orgname>

51

<address> <email>translator@gnome.org</email> </address>

52

</affiliation>

53

<contrib>Latin translation</contrib>

81

54

</othercredit>

82

55

-->

83

</authorgroup>

56

</authorgroup>

84

57

85

58

86

59

87

60

88

61

<!-- Remember to remove the &manrevision; entity from the revision entries other

89

62

than the current revision. -->

90

91

<revnumber>&app; Manual V&manrevision;</revnumber>

92

93

94

<para role="author">Sun GNOME Documentation Team</para>

95

<para role="publisher">GNOME Documentation Project</para>

96

</revdescription>

97

</revision>

98

99

<revnumber>gedit Manual V2.6</revnumber>

100

<date>September 2003</date>

101

102

<para role="author">Sun GNOME Documentation Team</para>

103

<para role="publisher">GNOME Documentation Project</para>

104

</revdescription>

105

</revision>

106

107

<revnumber>gedit Manual V2.5</revnumber>

108

<date>March 2003</date>

109

110

<para role="author">Sun GNOME Documentation Team</para>

111

<para role="publisher">GNOME Documentation Project</para>

112

</revdescription>

113

</revision>

114

115

<revnumber>gedit Manual V2.4</revnumber>

116

<date>January 2003</date>

117

118

<para role="author">Sun GNOME Documentation Team</para>

119

<para role="publisher">GNOME Documentation Project</para>

120

</revdescription>

121

</revision>

122

123

<revnumber>gedit Manual V2.3</revnumber>

124

<date>September 2002</date>

125

126

<para role="author">Sun GNOME Documentation Team</para>

127

<para role="publisher">GNOME Documentation Project</para>

128

</revdescription>

129

</revision>

130

131

<revnumber>gedit Manual V2.2</revnumber>

132

<date>August 2002</date>

133

134

<para role="author">Sun GNOME Documentation Team</para>

135

<para role="publisher">GNOME Documentation Project</para>

136

</revdescription>

137

</revision>

138

139

<revnumber>gedit Manual V2.1</revnumber>

140

141

142

<para role="author">Sun GNOME Documentation Team</para>

143

<para role="publisher">GNOME Documentation Project</para>

144

</revdescription>

145

</revision>

146

147

<revnumber>gedit Manual V2.0</revnumber>

148

<date>March 2002</date>

149

150

<para role="author">Sun GNOME Documentation Team</para>

151

<para role="publisher">GNOME Documentation Project</para>

152

</revdescription>

153

</revision>

154

155

<revnumber>gedit V1.0</revnumber>

156

157

158

<para role="author">Eric Baudais <email>baudais@okstate.edu</email>

159

</para>

160

<para role="publisher">GNOME Documentation Project</para>

161

</revdescription>

162

</revision>

163

</revhistory>

164

<releaseinfo> This manual describes version &appversion; of &app;.

165

</releaseinfo>

166

167

<title>Feedback</title>

168

<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="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink>.

63

64

<revnumber>gnome-nettool V2.17.1</revnumber>

65

66

67

<para role="publisher">GNOME Documentation Project</para>

68

</revdescription>

69

</revision>

70

</revhistory>

71

<releaseinfo> This manual describes version &appversion; of &app;.

72

</releaseinfo>

73

74

<title>Feedback</title>

75

<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="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink>.

169

76

</para>

170

77

171

</legalnotice>

78

</legalnotice>

172

79

</articleinfo>

173

<indexterm><primary>gedit</primary></indexterm>

174

<indexterm><primary>text editor</primary></indexterm>

80

81

<indexterm><primary>gnome-nettool</primary></indexterm>

82

<indexterm><primary>network tool application</primary></indexterm>

175

83

176

84

177

85

178

179

<title>Introduction</title>

180

<para>The <application>&app;</application> application enables you to create and edit text files. You can use <application>&app;</application> plugins to perform a variety of tasks related to text-editing from within the <application>&app;</application> window.</para>

181

</sect1>

182

183

184

<title>Getting Started</title>

185

186

187

188

<title>To Start &app;</title>

189

<para>You can start <application>&app;</application> in the following ways:</para>

190

191

192

<term><guimenu>Applications</guimenu> menu</term>

193

194

<para>Choose <menuchoice><guisubmenu>Accessories</guisubmenu><guimenuitem>Text Editor</guimenuitem></menuchoice>. </para>

195

</listitem>

196

</varlistentry>

197

198

<term>Command line</term>

199

200

<para>Execute the following command: <command>gedit</command></para>

201

</listitem>

202

</varlistentry>

203

</variablelist>

204

</sect2>

205

206

207

208

<title>When You Start &app;</title>

209

<para>When you start <application>&app;</application>, the following window is displayed:</para>

210

211

212

<title>&app; Window</title>

213

214

215

216

217

</imageobject>

218

<textobject> <phrase>Shows gedit main window.</phrase>

219

</textobject>

220

</mediaobject>

221

</screenshot>

222

</figure>

223

224

<para>The <application>&app;</application> window contains the following

225

elements: </para>

226

227

<varlistentry> <term>Menubar</term>

228

229

<para>The menus on the menubar contain all of the commands you need to work with files in <application>&app;</application>.</para>

230

</listitem>

231

</varlistentry>

232

<varlistentry> <term>Toolbar</term>

233

234

<para> The toolbar contains a subset of the commands that you can access from the menubar.</para>

235

</listitem>

236

</varlistentry>

237

<varlistentry> <term>Display area</term>

238

239

<para> The display area contains the text of the file that you are editing. </para>

240

</listitem>

241

</varlistentry>

242

<varlistentry> <term>Output window</term>

243

244

<para>The output window displays the output returned by the Shell command plugin and the Compare files plugin. </para>

245

</listitem>

246

</varlistentry>

247

<varlistentry> <term>Statusbar</term>

248

249

<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>

250

251

252

<para>Cursor position: the line number and column number where the cursor is located.</para>

253

</listitem>

254

255

<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>

256

</listitem>

257

</itemizedlist>

258

</listitem>

259

</varlistentry>

260

</variablelist>

261

<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>

262

263

<para>

264

In <application>&app;</application>, you can perform the same action in several ways. For example, you can open a file in the following ways:

265

266

267

268

269

<thead>

270

271

272

<para>UI Component</para></entry>

273

274

<para>Action</para></entry>

275

</row>

276

</thead>

277

<tbody>

278

279

<entry><para>Window</para></entry>

280

<entry><para>Drag a file into the <application>&app;</application> window from another application such as a file manager.</para></entry>

281

</row>

282

283

<entry><para>Menubar</para></entry>

284

<entry><para>Choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>.</para>

285

<para>If you have recently opened the file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open Recent</guimenuitem></menuchoice>.</para>

286

</entry>

287

</row>

288

289

<entry><para>Toolbar</para></entry>

290

<entry><para>Click on the <guibutton>Open</guibutton> toolbar button.</para></entry>

291

</row>

292

293

<entry><para>Right-click popup menu</para></entry>

294

<entry><para>Right-click on the file in a file manager window, then choose <guilabel>Open With</guilabel> from the popup menu. </para></entry>

295

</row>

296

297

<entry><para>Shortcut keys</para></entry>

298

<entry><para>Press <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>.</para></entry>

299

</row>

300

</tbody>

301

</tgroup>

302

</informaltable>

303

</para>

304

<para>

305

This manual documents functionality from the menubar.

306

</para>

307

</sect2>

308

309

310

311

<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>

312

<para>You can open multiple files in <application>&app;</application>. The application displays one file at a time in the application window. The application adds a tab for each open file to the window. To display another open file, click on the tab that corresponds to the file. To create a new <application> &app;</application> window for each file that is open, drag the tab corresponding to each file to the desktop background. </para>

313

<para>You can also use the <guimenu>Documents</guimenu> menu to move between the open files. You can choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Move to New Window</guimenuitem> </menuchoice> to move a document to a new <application> &app;</application> window.

314

</para>

315

<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/gedit_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>

316

</sect2>

317

318

319

<title>To Open Multiple Files from a Command Line</title>

320

<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>

321

<para><command>gedit <replaceable>file1.txt file2.txt file3.txt</replaceable></command></para>

322

<para>When the application starts, the files that you specify are displayed in the <application>&app;</application> window.</para>

323

<para>For more information on how to run <application>&app;</application> from a command line, see <ulink url="man:gedit" type="man"><citerefentry><refentrytitle>&app;</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>

324

</sect2>

325

</sect1>

326

327

328

<title>Usage</title>

329

330

331

332

<title>To Create a New File</title>

333

<para>To create a new file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>. The application displays a new file in the <application>&app;</application> window.</para>

334

</sect2>

335

336

337

338

<para>You can save files in the following ways:</para>

339

340

<listitem><para>To save changes to an existing file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice>. </para>

341

</listitem>

342

<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>

343

</listitem>

344

<listitem><para>To save all of the files that are currently open in <application>&app;</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Save All</guimenuitem> </menuchoice>.</para>

345

</listitem>

346

</itemizedlist>

347

<para>To close all of the files that are currently open in <application>&app;</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Close All</guimenuitem> </menuchoice>.</para>

348

</sect2>

349

350

351

352

<para>You can edit the text of a file in the following ways:</para>

353

354

<listitem><para>Type new text from the keyboard. </para>

355

</listitem>

356

<listitem><para>To copy the selected text to a buffer, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Copy</guimenuitem> </menuchoice>.</para>

357

</listitem>

358

<listitem><para>To delete the selected text from the file and move the selected text to a buffer, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Cut</guimenuitem> </menuchoice>.</para>

359

</listitem>

360

<listitem><para>To permanently delete the selected text from the file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Delete</guimenuitem> </menuchoice>.</para>

361

</listitem>

362

<listitem><para>To insert the contents of the buffer 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.</para>

363

</listitem>

364

<listitem><para>To select all of the text in a file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Select All</guimenuitem> </menuchoice>. </para>

365

</listitem>

366

</itemizedlist>

367

</sect2>

368

369

370

<title>To Undo or Redo Edits</title>

371

<para>To undo an edit, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem> </menuchoice>. To redo an edit, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Redo</guimenuitem> </menuchoice>. The number of previous edits that you can undo is determined by the <guilabel>Undo</guilabel> limit setting in the <xref linkend="gedit-prefs-editor"/> tabbed section of the <guilabel>Preferences</guilabel> dialog. </para>

372

</sect2>

373

374

375

376

<para>To search a file for a string, perform the following steps:</para>

377

378

<listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Find</guimenuitem> </menuchoice> to display the <guilabel>Find</guilabel> dialog.</para>

379

</listitem>

380

<listitem><para>Type the string that you want to find, in the <guilabel>Search for</guilabel> field.</para>

381

<para>You can include the following escape sequences:</para>

382

383

384

385

<para>Use this escape sequence to specify a new line.</para>

386

</listitem>

387

388

389

<para>Use this escape sequence to specify a tab character.</para>

390

</listitem>

391

392

393

<para>Use this escape sequence to specify a carriage return.</para>

394

</listitem>

395

</itemizedlist>

396

</listitem>

397

<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. </para>

398

</listitem>

399

<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. </para>

400

</listitem>

401

<listitem><para>Select the <guilabel>Search backwards</guilabel> option to search backwards to the beginning of the file. </para>

402

</listitem>

403

<listitem><para>Select the <guilabel>Wrap around</guilabel> option to search to one end of the file and then continue the search from the other end of the file. </para>

404

</listitem>

405

<listitem><para>Click <guibutton>Find</guibutton> to search the file for the first occurrence of the string. If <application>&app;</application> finds the string, the application moves the cursor to the string, and selects the string.</para>

406

</listitem>

407

<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 string, choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Find Previous</guimenuitem> </menuchoice>.</para>

408

</listitem>

409

<listitem><para>To finish the search, click <guibutton>Close</guibutton>. </para>

410

</listitem>

411

</orderedlist>

412

</sect2>

413

414

415

<title>To Find and Replace Text</title>

416

<para>To search a file for a string, and replace the string with an alternative string, perform the following steps:</para>

417

418

<listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Replace</guimenuitem> </menuchoice> to display the <guilabel>Replace</guilabel> dialog.</para>

419

</listitem>

420

<listitem><para>Type the string that you want to find, in the <guilabel>Search for</guilabel> field. </para>

421

<para>You can include the following escape sequences:</para>

422

423

424

425

<para>Use this escape sequence to specify a new line.</para>

426

</listitem>

427

428

429

<para>Use this escape sequence to specify a tab character.</para>

430

</listitem>

431

432

433

<para>Use this escape sequence to specify a carriage return.</para>

434

</listitem>

435

</itemizedlist>

436

</listitem>

437

<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>

438

</listitem>

439

<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 enter. </para>

440

</listitem>

441

<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. </para>

442

</listitem>

443

<listitem><para>Select the <guilabel>Search backwards</guilabel> option to search backwards to the beginning of the file. </para>

444

</listitem>

445

<listitem><para>Select the <guilabel>Wrap around</guilabel> option to search to one end of the file and then continue the search from the other end of the file. </para>

446

</listitem>

447

<listitem><para>Click <guibutton>Find</guibutton> to search the file for the first occurrence of the string. If <application>&app;</application> finds the string, the application moves the cursor to the string, and selects the string. </para>

448

</listitem>

449

<listitem><para>Click <guibutton>Replace</guibutton> to replace the occurrence of the string with the text in the <guilabel>Replace with</guilabel> field. Click <guibutton>Replace All</guibutton> to replace all occurrences of the string.</para>

450

</listitem>

451

<listitem><para>To find the next occurrence of the string, click <guibutton>Find</guibutton>.</para>

452

</listitem>

453

<listitem><para>To finish the search, click <guibutton>Close</guibutton>. </para>

454

</listitem>

455

</orderedlist>

456

</sect2>

457

458

459

460

<para>To open a file from a Uniform Resource Identifier (URI), perform the following steps:</para>

461

462

463

<para>Choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open Location</guimenuitem> </menuchoice> to display the <guilabel>Open Location</guilabel> dialog. </para>

464

</listitem>

465

466

<para>Enter the URI of the file that you want to open.</para>

467

</listitem>

468

469

<para>Use the <guilabel>Character coding</guilabel> drop-down list to select the appropriate character coding. </para>

470

</listitem>

471

472

<para>Click <guibutton>Open</guibutton>.</para>

473

</listitem>

474

</orderedlist>

475

<para>Alternatively, type <command>gedit <replaceable>URI</replaceable></command> at a command line, where <replaceable>URI</replaceable> is the URI of the file that you want to open, then press <keycap>Return</keycap>. Valid types of <replaceable>URI</replaceable> include <literal>http:</literal>, <literal>ftp:</literal>, <literal>file:</literal>, and all of the methods supported by <literal>gnome-vfs</literal>.</para>

476

<para>The application opens the file located at the URI in read-only mode.</para>

477

</sect2>

478

479

480

<title>To Pipe the Output of a Command to a File</title>

481

<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 | gedit</command>, then press <keycap>Return</keycap>.</para>

482

<para>The output of the <command>ls</command> command is displayed in a new text file in the <application>&app;</application> window.</para>

483

<para>Alternatively, you can use the Shell command plugin to pipe command output to the current file. For information about how to use the Shell command plugin, see <xref linkend="gedit-shell-command-plugin"/>.</para>

484

</sect2>

485

486

487

<title>To Position the Cursor on a Specific Line</title>

488

<para>To position the cursor on a specific line in the current file, perform the following steps:</para>

489

490

<listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Go to Line</guimenuitem> </menuchoice> to display the <guilabel>Go to Line</guilabel> dialog.</para>

491

</listitem>

492

<listitem><para>Type the number of the line that you want to move the cursor to in the <guilabel>Line number</guilabel> field.</para>

493

</listitem>

494

<listitem><para>Click <guibutton>Go to Line</guibutton>. The application moves the cursor to the line number that you specify.</para>

495

</listitem>

496

<listitem><para>To close the <guilabel>Go to Line</guilabel> dialog, click <guibutton>Close</guibutton>.</para>

497

</listitem>

498

</orderedlist>

499

</sect2>

500

501

502

<title>To Set the Page Options</title>

503

504

<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>

505

506

<para>The <guilabel>Page Setup</guilabel> dialog enables you to specify the following print options:</para>

507

508

509

<title>General Tabbed Section</title>

510

511

<varlistentry> <term><guilabel>Print syntax highlighting</guilabel> </term>

512

513

<para>Select this option to print syntax highlighting. For more information about syntax highlighting, see <xref linkend="gedit-set-highlightmode"/>. </para>

514

</listitem>

515

</varlistentry>

516

<varlistentry> <term><guilabel>Print page headers</guilabel> </term>

517

518

<para>Select this option to include a header on each page that you print. You cannot configure the header. </para>

519

</listitem>

520

</varlistentry>

521

<varlistentry> <term><guilabel>Line Numbers</guilabel>

522

</term>

523

524

<para>Select the <guilabel>Print line numbers</guilabel> option to include line numbers when you print a file. </para>

525

<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>

526

</listitem>

527

</varlistentry>

528

<varlistentry> <term><guilabel>Text Wrapping</guilabel> </term>

529

530

<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.

531

</para>

532

<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.

533

</para>

534

</listitem>

535

</varlistentry>

536

</variablelist>

537

</sect3>

538

539

540

<title>Fonts</title>

541

542

543

544

<para>Click on this button to select the font to use to print the body text of a file.</para>

545

</listitem>

546

</varlistentry>

547

<varlistentry> <term><guilabel>Line numbers</guilabel>

548

</term>

549

550

<para>Click on this button to select the font to use to print line numbers.</para>

551

</listitem>

552

</varlistentry>

553

<varlistentry> <term><guilabel>Headers and footers</guilabel> </term>

554

555

<para>Click on this button to select the font to use to print the headers and footers in a file. </para>

556

</listitem>

557

</varlistentry>

558

</variablelist>

559

<para>To reset the fonts to the default fonts for printing a file from <application>&app;</application>, click <guibutton>Restore Default Fonts</guibutton>.</para>

560

</sect3>

561

562

</sect2>

563

564

565

566

<title>To Print a File</title>

567

<para>You can use <application>&app;</application> to perform the following print operations:</para>

568

569

<listitem><para>Print a file to a printer. </para>

570

</listitem>

571

<listitem><para>Print the output of the print command to a file.</para>

572

</listitem>

573

</itemizedlist>

574

<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>

575

576

<para>To preview the pages that you want to print, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print Preview</guimenuitem> </menuchoice>.</para>

577

578

<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>

579

580

<para>The <guilabel>Print</guilabel> dialog enables you to specify the following print options:</para>

581

582

583

<title>Job Tabbed Section</title>

584

585

<varlistentry> <term><guilabel>Print range</guilabel> </term>

586

587

<para>Select one of the following options to determine how many pages to print:</para>

588

589

590

591

<para>Select this option to print all of the pages in the file.</para>

592

</listitem>

593

594

<para><guilabel>Lines</guilabel></para>

595

<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>

596

</listitem>

597

598

<para><guilabel>Selection</guilabel></para>

599

<para>Select this option to print the selected text only. This option is only available if you select text.</para>

600

</listitem>

601

602

</itemizedlist>

603

</listitem>

604

</varlistentry>

605

<varlistentry> <term><guilabel>Copies</guilabel> </term>

606

607

<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>

608

<para>If you print multiple copies of the file, select the <guilabel>Collate</guilabel> option to collate the printed copies.</para>

609

</listitem>

610

</varlistentry>

611

</variablelist>

612

</sect3>

613

614

615

<title>Printer Tabbed Section</title>

616

617

<varlistentry> <term><guilabel>Printer</guilabel> </term>

618

619

<para>Use this drop-down list to select the printer to which you want to print the file.</para>

620

</listitem>

621

</varlistentry>

622

<varlistentry> <term><guilabel>Settings</guilabel> </term>

623

624

<para>Use this drop-down list to select the printer settings.

625

</para>

626

<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.

627

</para>

628

</listitem>

629

</varlistentry>

630

<varlistentry> <term><guilabel>Location</guilabel> </term>

631

632

<para>

633

Use this drop-down list to select one of the following print destinations:

634

</para>

635

636

637

638

639

<para>

640

Print the file to a CUPS printer.

641

</para>

642

<note>

643

<para>

644

If the selected printer is a CUPS printer, <guilabel>CUPS</guilabel> is the only entry in this drop-down list.

645

</para>

646

</note>

647

</listitem>

648

</varlistentry>

649

650

651

652

<para>

653

Print the file to a printer.

654

</para>

655

</listitem>

656

</varlistentry>

657

658

659

660

<para>

661

Print the file to a PostScript file.

662

</para>

663

<para>

664

Click <guibutton>Save As</guibutton> to display a dialog where you specify the name and location of the PostScript file.

665

</para>

666

</listitem>

667

</varlistentry>

668

669

<term><guilabel>Custom</guilabel></term>

670

671

<para>

672

Use the specified command to print the file.

673

</para>

674

<para>

675

Type the name of the command in the text box. Include all command-line arguments.

676

</para>

677

</listitem>

678

</varlistentry>

679

</variablelist>

680

</listitem>

681

</varlistentry>

682

<varlistentry> <term><guilabel>State</guilabel> </term>

683

684

<para>This functionality is not supported in this version of &app;.

685

</para>

686

</listitem>

687

</varlistentry>

688

689

690

<para>This functionality is not supported in this version of &app;.

691

</para>

692

</listitem>

693

</varlistentry>

694

<varlistentry> <term><guilabel>Comment</guilabel> </term>

695

696

<para>This functionality is not supported in this version of &app;.

697

</para>

698

</listitem>

699

</varlistentry>

700

</variablelist>

701

</sect3>

702

703

704

<title>Paper Tabbed Section</title>

705

706

<varlistentry> <term><guilabel>Paper size</guilabel> </term>

707

708

<para>Use this drop-down list to select the size of the paper to which you want to print the file.</para>

709

</listitem>

710

</varlistentry>

711

<varlistentry> <term><guilabel>Width</guilabel> </term>

712

713

<para>Use this spin box to specify the width of the paper. Use the adjacent drop-down list to change the measurement unit.</para>

714

</listitem>

715

</varlistentry>

716

<varlistentry> <term><guilabel>Height</guilabel> </term>

717

718

<para>Use this spin box to specify the height of the paper.</para>

719

</listitem>

720

</varlistentry>

721

<varlistentry> <term><guilabel>Feed orientation</guilabel> </term>

722

723

<para>Use this drop-down list to select the orientation of the paper in the printer.</para>

724

</listitem>

725

</varlistentry>

726

<varlistentry> <term><guilabel>Page orientation</guilabel> </term>

727

728

<para>Use this drop-down list to select the page orientation.</para>

729

</listitem>

730

</varlistentry>

731

<varlistentry> <term><guilabel>Layout</guilabel> </term>

732

733

<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>

734

</listitem>

735

</varlistentry>

736

<varlistentry> <term><guilabel>Paper tray</guilabel> </term>

737

738

<para>Use this drop-down list to select the paper tray.

739

</para> </listitem>

740

</varlistentry>

741

</variablelist>

742

</sect3>

743

744

</sect2>

745

746

747

<title>To Customize the Toolbar</title>

748

<para>To display or hide the toolbar, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Toolbar</guimenuitem> </menuchoice>. To customize how <application>&app;</application> displays the toolbar, choose <menuchoice> <guimenu>View</guimenu> <guisubmenu>Customize Toolbar</guisubmenu> </menuchoice>, then select one of the following menu items:</para>

749

750

751

<para><guimenuitem>Desktop Default</guimenuitem></para>

752

<para>Display the default toolbar.</para>

753

</listitem>

754

755

<para><guimenuitem>Icons Only</guimenuitem></para>

756

<para>Display icons only.</para>

757

</listitem>

758

759

<para><guimenuitem>Text for All Icons</guimenuitem></para>

760

<para>Display icons, and display text for all icons.</para>

761

</listitem>

762

763

<para><guimenuitem>Text for Important Icons</guimenuitem></para>

764

<para>Display icons, and display text for the important icons.</para>

765

</listitem>

766

</itemizedlist>

767

<para>To display or hide the output window, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Output Window</guimenuitem> </menuchoice>.</para>

768

769

</sect2>

770

771

772

<title>To Set the Syntax Highlighting Mode</title>

773

<para>To set the syntax highlighting mode, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Highlight Mode</guimenuitem> </menuchoice>, then select one of the following menu items:</para>

774

775

776

<term><guimenuitem>Normal</guimenuitem></term>

777

778

<para>Do not display any syntax highlighting.</para>

779

</listitem>

780

</varlistentry>

781

782

<term><guisubmenu>Sources</guisubmenu></term>

783

784

<para>Display syntax highlighting to edit source code. Use the <guisubmenu>Sources</guisubmenu> submenu to select one of the following source code types: <guimenuitem>Verilog</guimenuitem>, <guimenuitem>PHP</guimenuitem>, <guimenuitem>SQL</guimenuitem>, <guimenuitem>IDL</guimenuitem>, <guimenuitem>C</guimenuitem>, <guimenuitem>Ada</guimenuitem>, <guimenuitem>C++</guimenuitem>, <guimenuitem>C#</guimenuitem>, or <guimenuitem>Java</guimenuitem>.</para>

785

</listitem>

786

</varlistentry>

787

788

<term><guisubmenu>Markup</guisubmenu></term>

789

790

<para>Display syntax highlighting to edit markup code. Use the <guisubmenu>Markup</guisubmenu> submenu to select one of the following markup code types: <guimenuitem>HTML</guimenuitem>, <guimenuitem>LaTeX</guimenuitem>, or <guimenuitem>XML</guimenuitem>.</para>

791

</listitem>

792

</varlistentry>

793

794

<term><guisubmenu>Scripts</guisubmenu></term>

795

796

<para>Display syntax highlighting to edit script code. Use the <guisubmenu>Scripts</guisubmenu> submenu to select one of the following script code types: <guimenuitem>Python</guimenuitem> or <guimenuitem>Perl</guimenuitem>.</para>

797

</listitem>

798

</varlistentry>

799

800

<term><guisubmenu>Others</guisubmenu></term>

801

802

<para>Display syntax highlighting to edit other types of code. Use the <guisubmenu>Others</guisubmenu> submenu to select one of the following code types: <guimenuitem>MSIL</guimenuitem>, <guimenuitem>gettext translation</guimenuitem>, <guimenuitem>.desktop</guimenuitem>, or <guimenuitem>Diff</guimenuitem>.</para>

803

</listitem>

804

</varlistentry>

805

</variablelist>

806

<para>For more information about how to configure syntax highlighting, see <xref linkend="gedit-prefs-syntax"/>.

807

</para>

808

</sect2>

809

810

</sect1>

811

812

813

<title>Preferences</title>

814

815

<para>To configure <application>&app;</application>, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>. The <guilabel>Preferences</guilabel> dialog contains the following categories:</para>

816

817

818

819

820

821

822

</itemizedlist>

823

824

825

<title>Editor</title>

826

827

828

829

<para>Use the <guilabel>Tabs width</guilabel> spin box to specify the width of the space that <application> &app;</application> inserts when you press the <keycap>Tab</keycap> key. </para>

830

<para>Select the <guilabel>Insert spaces instead of tabs</guilabel> option to specify that <application> &app;</application> inserts spaces instead of a tab character when you press the <keycap>Tab</keycap> key. </para>

831

</listitem>

832

</varlistentry>

833

<varlistentry> <term><guilabel>Auto Indentation</guilabel> </term>

834

<listitem> <para>Select the <guilabel>Enable auto indentation</guilabel> option to specify that the next line starts at the indentation level of the current line. </para>

835

</listitem>

836

</varlistentry>

837

<varlistentry> <term><guilabel>File Saving</guilabel> </term>

838

839

<para>Select the <guilabel>Create a backup copy of files before saving</guilabel> option to create a backup copy of a file each time you save the file. The backup copy of the file contains a ~ at the end of the filename.</para>

840

<para>Select the <guilabel>Autosave files every ... minutes</guilabel> option to automatically save the current file at regular intervals. Use the spin box to specify how often you want to save the file.</para>

841

</listitem>

842

</varlistentry>

843

844

845

<para>Select the <guilabel>Limit to ... actions</guilabel> option to set a limit on the number of editing actions that you can undo. Use the spin box to specify the maximum number of actions that you can undo. </para>

846

<para>Select the <guilabel>Unlimited undo</guilabel> option to set no limit on the number of editing actions that you can undo. </para>

847

</listitem>

848

</varlistentry>

849

</variablelist>

850

</sect2>

851

852

853

854

855

<varlistentry> <term><guilabel>Text Wrapping</guilabel> </term>

856

857

<para>Select the <guilabel>Enable text wrapping</guilabel> option to wrap text onto the next line, at a character level, when you reach the text window boundary. </para>

858

<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 reach the text window boundary. </para>

859

</listitem>

860

</varlistentry>

861

862

<term><guilabel>Line Numbers</guilabel></term>

863

864

<para>Select the <guilabel>Display line numbers</guilabel> option to display line numbers on the left side of the <application>&app;</application> window. </para>

865

</listitem>

866

</varlistentry>

867

868

<term><guilabel>Right Margin</guilabel></term>

869

870

<para>Select the <guilabel>Display right margin</guilabel> option to display a vertical line that indicates the right margin. </para>

871

<para>Use the <guilabel>Right margin at column</guilabel> spin box to specify the location of the vertical line. </para>

872

</listitem>

873

</varlistentry>

874

</variablelist>

875

</sect2>

876

877

878

<title>Font & Colors</title>

879

880

881

882

<para>Select the <guilabel>Use default theme font</guilabel> option to use the default system font for the text in the <application>&app;</application> text window. </para>

883

<para>The <guilabel>Editor font</guilabel> field displays the font that <application>&app;</application> uses to display text. Click on the button to specify the font type, style, and size to use for text. </para>

884

</listitem>

885

</varlistentry>

886

<varlistentry> <term><guilabel>Colors</guilabel> </term>

887

888

<para>Select the <guilabel>Use default theme colors</guilabel> option to use the default theme colors in the <application>&app;</application> text window. </para>

889

<para>Click on the <guibutton>Normal text color</guibutton> color button to display the color selector dialog. Select a color to use to display normal text in the <application>&app;</application> text window. </para>

890

<para>Click on the <guibutton>Background color</guibutton> color button to display the color selector dialog. Select a background color for the <application>&app;</application> text window. </para>

891

<para>Click on the <guibutton>Selected text color</guibutton> color button to display the color selector dialog. Select a color to use to display selected text.

892

</para>

893

<para>Click on the <guibutton>Selection color</guibutton> color button to display the color selector dialog. Select a background color to use to highlight a text selection. </para>

894

</listitem>

895

</varlistentry>

896

</variablelist>

897

</sect2>

898

899

900

<title>Syntax Highlighting</title>

901

902

<varlistentry> <term><guilabel>Enable syntax highlighting</guilabel> </term>

903

904

<para>Select this option to highlight the syntax of the text that you edit. </para>

905

</listitem>

906

</varlistentry>

907

<varlistentry> <term><guilabel>Highlight mode</guilabel> </term>

908

909

<para>Use this drop-down list to select a syntax mode to configure. </para>

910

</listitem>

911

</varlistentry>

912

<varlistentry> <term><guilabel>Elements</guilabel> </term>

913

914

<para>Use this list box to select a syntax element to configure. </para>

915

</listitem>

916

</varlistentry>

917

<varlistentry> <term>Format buttons </term>

918

919

<para>Use the following buttons to change the format of the selected syntax element: </para>

920

921

922

923

924

<thead>

925

926

927

<para>Button</para></entry>

928

929

<para>Format</para></entry>

930

</row>

931

</thead>

932

<tbody>

933

934

<entry>

935

<para>

936

937

938

939

</imageobject>

940

941

<phrase>Shows icon for bold format.</phrase>

942

</textobject>

943

</inlinemediaobject>

944

</para>

945

</entry>

946

<entry>

947

<para>

948

Bold

949

</para>

950

</entry>

951

</row>

952

953

<entry>

954

<para>

955

956

957

958

959

<phrase>Shows icon for italic format.</phrase>

960

</textobject>

961

</inlinemediaobject>

962

</para>

963

</entry>

964

<entry>

965

<para>

966

Italic

967

</para>

968

</entry>

969

</row>

970

971

<entry>

972

<para>

973

974

975

976

977

<phrase>Shows icon for underline.</phrase>

978

</textobject>

979

</inlinemediaobject>

980

</para>

981

</entry>

982

<entry>

983

<para>

984

Underline

985

</para>

986

</entry>

987

</row>

988

989

<entry>

990

<para>

991

992

993

994

995

<phrase>Shows icon for strikethrough.</phrase>

996

</textobject>

997

</inlinemediaobject>

998

</para>

999

</entry>

1000

<entry>

1001

<para>

1002

Strikethrough

1003

</para>

1004

</entry>

1005

</row>

1006

</tbody>

1007

</tgroup>

1008

</informaltable>

1009

</listitem>

1010

</varlistentry>

1011

<varlistentry> <term><guilabel>Foreground</guilabel> </term>

1012

1013

<para>Select this option to change the font color of the selected syntax element. Click on the color button to display the color selector dialog, then select the font color.</para>

1014

</listitem>

1015

</varlistentry>

1016

<varlistentry> <term><guilabel>Background</guilabel> </term>

1017

1018

<para>Select this option to change the background color of the selected syntax element. Click on the color button to display the color selector dialog, then select the background color.</para>

1019

</listitem>

1020

</varlistentry>

1021

<varlistentry> <term><guibutton>Reset to Default</guibutton> </term>

1022

1023

<para>Click on this button to reset the foreground color and background color of the selected syntax element to the default values.</para>

1024

</listitem>

1025

</varlistentry>

1026

</variablelist>

1027

</sect2>

1028

1029

1030

<title>Plugins</title>

1031

<para>For information about how to use the <guilabel>Plugins</guilabel> category of the <guilabel>Preferences</guilabel> dialog, see <xref linkend="gedit-install-plugins"/>. </para>

1032

</sect2>

1033

1034

</sect1>

1035

1036

1037

<title>Working with Plugins</title>

1038

<para>A plugin is a supplementary program that enhances the functionality of an application. The <application>&app;</application> plugins enable you to perform a variety of functions related to text editing from within the <application> &app;</application> window. The following table lists the <application> &app;</application> plugins.</para>

1039

1040

1041

1042

1043

<thead>

1044

1045

<entry colname="col1" colsep="0" valign="top"><para>Plugin Name</para></entry>

1046

<entry colname="col2" valign="top"><para>Purpose</para></entry>

1047

</row>

1048

</thead>

1049

<tbody>

1050

1051

<entry><para>ASCII table</para></entry>

1052

<entry><para>Displays a dialog that contains an ASCII table. You can use the ASCII table to insert characters into a file.</para></entry>

1053

</row>

1054

1055

<entry><para>Compare files</para></entry>

1056

<entry><para>Compares two files and displays the differences between the files in the output window. This plugin uses the <command>diff</command> command to compare the files.</para></entry>

1057

</row>

1058

1059

<entry><para>CVS ChangeLog</para></entry>

1060

<entry><para>Opens the log messages associated with CVS commit commands.</para></entry>

1061

</row>

1062

1063

<entry><para>Document Statistics</para></entry>

1064

<entry><para>Counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file. The plugin displays the results in a <guilabel>Document Statistics</guilabel> dialog. </para></entry>

1065

</row>

1066

1067

<entry><para>Indent lines</para></entry>

1068

<entry><para>Indents the selected lines, or removes the indentation from the selected lines.</para></entry>

1069

</row>

1070

1071

<entry><para>Insert Date/Time</para></entry>

1072

<entry><para>Inserts the current date and time into a file.</para></entry>

1073

</row>

1074

1075

<entry><para>Shell command</para></entry>

1076

<entry><para>Displays the text output of a shell command in the output window. </para></entry>

1077

</row>

1078

1079

1080

<entry><para>Sorts the selected text. </para></entry>

1081

</row>

1082

1083

<entry><para>Spell checker</para></entry>

1084

<entry><para>Checks the spelling in the selected text. You can configure <application>&app;</application> to check the spelling automatically, or you can check the spelling manually, in the specified language.</para></entry>

1085

</row>

1086

1087

1088

1089

<entry><para>Displays a window that contains a list of common tags. You can use the window to insert a tag into a file. </para></entry>

1090

</row>

1091

1092

1093

<entry><para>Inserts the username of the current user into the file. </para></entry>

1094

</row>

1095

</tbody>

1096

</tgroup>

1097

</informaltable>

1098

<para>When you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>, the <guilabel>Plugins</guilabel> tabbed section displays the following information:</para>

1099

1100

<listitem><para>A table that contains two columns: </para>

1101

1102

1103

<term><guilabel>Enabled</guilabel></term>

1104

1105

<para>Displays check boxes that you select to load the plugins.</para>

1106

</listitem>

1107

</varlistentry>

1108

1109

<term><guilabel>Plugin</guilabel></term>

1110

1111

<para>Displays a list of the plugins that you can use with <application>&app;</application>.</para>

1112

</listitem>

1113

</varlistentry>

1114

</variablelist>

1115

</listitem>

1116

<listitem><para>An <guibutton>About Plugin</guibutton> button: use this button to display a brief description of the selected plugin, including details about the author of the plugin. </para>

1117

</listitem>

1118

<listitem><para>A <guibutton>Configure Plugin</guibutton> button: use this button to open a configuration dialog for the selected plugin, if that plugin is configurable. For example, see <xref linkend="gedit-compare-files-configure"/> and <xref linkend="gedit-date-time-configure"/>.</para>

1119

</listitem>

1120

</itemizedlist>

1121

<para>When you load a plugin, <application>&app;</application> adds the plugin to the appropriate <application>&app;</application> menu, as described in the following table.</para>

1122

1123

1124

1125

1126

<thead>

1127

1128

<entry colname="col1" colsep="0" valign="top"><para>Plugin Name</para></entry>

1129

<entry colname="col2" valign="top"><para>Added to Menu</para></entry>

1130

</row>

1131

</thead>

1132

<tbody>

1133

1134

<entry><para>ASCII table</para></entry>

1135

1136

<guimenuitem>ASCII Table</guimenuitem></menuchoice></para></entry>

1137

</row>

1138

1139

<entry><para>Compare files</para></entry>

1140

<entry><para><menuchoice><guimenu>Tools</guimenu>

1141

<guimenuitem>Compare Files</guimenuitem></menuchoice></para></entry>

1142

</row>

1143

1144

<entry><para>CVS ChangeLog</para></entry>

1145

1146

<guimenuitem>Open CVS ChangeLogs</guimenuitem></menuchoice></para></entry>

1147

</row>

1148

1149

<entry><para>Document Statistics</para></entry>

1150

<entry><para><menuchoice><guimenu>Tools</guimenu>

1151

<guimenuitem>Document Statistics</guimenuitem></menuchoice></para></entry>

1152

</row>

1153

1154

<entry><para>Indent lines</para></entry>

1155

1156

<guimenuitem>Indent</guimenuitem></menuchoice></para>

1157

1158

<guimenuitem>Unindent</guimenuitem></menuchoice></para></entry>

1159

</row>

1160

1161

<entry><para>Insert Date/Time</para></entry>

1162

1163

<guimenuitem>Insert Date and Time</guimenuitem></menuchoice></para></entry>

1164

</row>

1165

1166

<entry><para>Shell command</para></entry>

1167

<entry><para><menuchoice><guimenu>Tools</guimenu>

1168

<guimenuitem>Run Command</guimenuitem></menuchoice></para></entry>

1169

</row>

1170

1171

1172

1173

1174

</row>

1175

1176

<entry><para>Spell checker</para></entry>

1177

<entry>

1178

<para><menuchoice><guimenu>Tools</guimenu>

1179

<guimenuitem>Check Spelling</guimenuitem></menuchoice></para>

1180

<para><menuchoice><guimenu>Tools</guimenu>

1181

<guimenuitem>Autocheck Spelling</guimenuitem></menuchoice></para>

1182

<para><menuchoice><guimenu>Tools</guimenu>

1183

<guimenuitem>Set Language</guimenuitem></menuchoice></para>

1184

</entry>

1185

</row>

1186

1187

1188

1189

1190

</row>

1191

1192

1193

1194

<guimenuitem>Insert User Name</guimenuitem></menuchoice></para></entry>

1195

</row>

1196

</tbody>

1197

</tgroup>

1198

</informaltable>

1199

1200

1201

<title>To Load a &app; Plugin</title>

1202

<para>To load a <application>&app;</application> plugin, perform the following steps:</para>

1203

1204

1205

<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>. </para>

1206

</listitem>

1207

1208

<para>Select the <guilabel>Plugins</guilabel> tab. </para>

1209

</listitem>

1210

1211

<para>Select the check box next to the name of the plugin that you want to load.</para>

1212

</listitem>

1213

1214

<para>Click <guibutton>Close</guibutton> to close the <guilabel>Preferences</guilabel> dialog. </para>

1215

</listitem>

1216

</orderedlist>

1217

</sect2>

1218

1219

1220

1221

<title>To Remove a &app; Plugin</title>

1222

<para>A plugin remains loaded when you quit <application>&app;</application>. </para>

1223

<para>To remove a <application>&app;</application> plugin, perform the following steps:</para>

1224

1225

1226

<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>. </para>

1227

</listitem>

1228

1229

<para>Select the <guilabel>Plugins</guilabel> tab. </para>

1230

</listitem>

1231

1232

<para>Deselect the check box next to the name of the plugin that you want to remove.</para>

1233

</listitem>

1234

1235

<para>Click <guibutton>Close</guibutton> to close the <guilabel>Preferences</guilabel> dialog. </para>

1236

</listitem>

1237

</orderedlist>

1238

</sect2>

1239

1240

1241

1242

<title>To Use the ASCII Table Plugin</title>

1243

<para>The ASCII table plugin displays a dialog that contains an ASCII table. You can use the ASCII table to insert characters into a file. To use the ASCII table plugin, perform the following steps:</para>

1244

1245

<listitem><para>Load the ASCII table plugin. </para>

1246

</listitem>

1247

<listitem><para>Choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>ASCII Table</guimenuitem> </menuchoice> to display the <guilabel>ASCII Table</guilabel> dialog. </para>

1248

</listitem>

1249

<listitem><para>Scroll through the list to find the character that you require, then select the character with a single click.

1250

</para>

1251

</listitem>

1252

<listitem><para>Click <guibutton>Insert char</guibutton> to insert the character at the cursor position in the current file.

1253

</para>

1254

</listitem>

1255

<listitem><para>When you finish entering ASCII characters, click <guibutton>Close</guibutton> to close the <guilabel>ASCII Table</guilabel> dialog.

1256

</para>

1257

</listitem>

1258

</orderedlist>

1259

</sect2>

1260

1261

1262

1263

1264

<title>To Use the Compare Files Plugin</title>

1265

<para>The Compare files plugin compares two files and displays the differences between the files in the output window. This plugin uses the <command>diff</command> command to compare the files. To use the Compare files plugin, perform the following steps:</para>

1266

1267

<listitem><para>Load the Compare files plugin. </para>

1268

</listitem>

1269

<listitem><para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Compare Files</guimenuitem> </menuchoice>. When you choose this option for the first time, you are prompted to confirm the location of the <command>diff</command> command. You are not prompted for this location again. See <xref linkend="gedit-compare-files-configure"/> for information about how to change this location later.</para>

1270

<para> Click <guibutton>OK</guibutton> to display the <guilabel>Compare Files</guilabel> dialog. </para>

1271

</listitem>

1272

<listitem><para>Specify the files that you want to compare. To specify an open file, select the <guilabel>From document</guilabel> option then select the file from the drop-down list. To specify a closed file, select the <guilabel>From a file on disk</guilabel> option then enter the location of the file in the text box. </para>

1273

</listitem>

1274

<listitem><para>To ignore changes in the amount of white space, select the <guilabel>Ignore blanks (-b option)</guilabel> option. </para>

1275

</listitem>

1276

<listitem><para>To use the unified output format, showing three lines of context, select the <guilabel>Use the unified output format (-u option)</guilabel> option.

1277

</para>

1278

</listitem>

1279

<listitem><para>Click <guibutton>Compare</guibutton> to compare the contents of the specified files. The command output is displayed in the output window. </para>

1280

</listitem>

1281

</orderedlist>

1282

<para>For more information, see <ulink url="man:diff" type="man"><citerefentry><refentrytitle>diff</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>. </para>

1283

1284

1285

<title>To Configure the Compare Files Plugin</title>

1286

<para>To change the location of the command that the Compare files plugin uses, perform the following steps:</para>

1287

1288

<listitem> <para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>.

1289

</para>

1290

</listitem>

1291

<listitem> <para>Select the <guilabel>Plugins</guilabel> tab.

1292

</para>

1293

</listitem>

1294

<listitem> <para>Select the <guilabel>Compare Files</guilabel> plugin.

1295

</para>

1296

</listitem>

1297

<listitem> <para>Click <guibutton>Configure Plugin</guibutton> to display the <guilabel>Set program location</guilabel> dialog.

1298

</para>

1299

</listitem>

1300

<listitem> <para>Specify the location of the <command>diff</command> command in the <guilabel>Location to search for</guilabel> text box.

1301

</para>

1302

</listitem>

1303

<listitem> <para>Click <guibutton>OK</guibutton> to close the <guilabel>Set program location</guilabel> dialog.

1304

</para>

1305

</listitem>

1306

<listitem> <para>To close the <guilabel>Preferences</guilabel> dialog, click <guibutton>Close</guibutton>.</para>

1307

</listitem>

1308

</orderedlist>

1309

</sect3>

1310

</sect2>

1311

1312

1313

<title>To Use the CVS ChangeLog Plugin</title>

1314

<para>The CVS ChangeLog plugin opens the log messages associated with CVS commit commands. This plugin enables you to easily paste text into the commit message from the ChangeLog file. To use the CVS ChangeLog plugin, perform the following steps:</para>

1315

1316

<listitem><para>Set the environment variable CVSEDITOR to <application>&app;</application>. For example, if you are using the <command>bash</command> shell, run the following command at the operating system prompt:

1317

<screen> <userinput>export CVSEDITOR=&app;</userinput> </screen>

1318

</para>

1319

</listitem>

1320

<listitem><para>Commit a file to CVS in the usual way. A <application>&app;</application> window opens, to enable you to enter the commit message.

1321

</para>

1322

</listitem>

1323

<listitem><para>Load the CVS ChangeLog plugin.</para>

1324

</listitem>

1325

<listitem><para>Choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open CVS ChangeLogs</guimenuitem> </menuchoice> to open all of the ChangeLog files referenced in the commit message. <application>&app;</application> opens each ChangeLog file in a new tab.</para>

1326

</listitem>

1327

<listitem><para>Copy the ChangeLog entries that you want to add to the commit message from the <application>&app;</application> ChangeLog files.

1328

</para>

1329

</listitem>

1330

<listitem><para>Insert the copied ChangeLog entries in the <application>&app;</application> commit message tab.

1331

</para>

1332

</listitem>

1333

<listitem><para>Save your changes to the commit message, then close all files.

1334

</para>

1335

</listitem>

1336

1337

</listitem>

1338

</orderedlist>

1339

</sect2>

1340

1341

1342

<title>To Use the Document Statistics Plugin</title>

1343

<para>The Document Statistics plugin counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file. The plugin displays the results in a <guilabel>Document Statistics</guilabel> dialog. To use the Document Statistics plugin, perform the following steps:</para>

1344

1345

<listitem><para>Load the Document Statistics plugin. </para>

1346

</listitem>

1347

<listitem><para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Document Statistics</guimenuitem> </menuchoice> to display the <guilabel>Document Statistics</guilabel> dialog. The <guilabel>Document Statistics</guilabel> dialog displays the following information about the file:

1348

</para>

1349

1350

<listitem><para>Number of lines in the current document.

1351

</para>

1352

</listitem>

1353

<listitem><para>Number of words in the current document.

1354

</para>

1355

</listitem>

1356

<listitem><para>Number of characters, including spaces, in the current document.

1357

</para>

1358

</listitem>

1359

<listitem><para>Number of characters, not including spaces, in the current document.

1360

</para>

1361

</listitem>

1362

<listitem><para>Number of bytes in the current document.

1363

</para>

1364

</listitem>

1365

</itemizedlist>

1366

</listitem>

1367

<listitem><para>You can continue to update the <application>&app;</application> file while the <guilabel>Document Statistics</guilabel> dialog is open. To refresh the contents of the <guilabel>Document Statistics</guilabel> dialog, click <guibutton>Update</guibutton>.

1368

</para>

1369

</listitem>

1370

<listitem><para>To close the <guilabel>Document Statistics</guilabel> dialog, click <guibutton>Close</guibutton>.

1371

</para>

1372

</listitem>

1373

</orderedlist>

1374

</sect2>

1375

1376

1377

<title>To Use the Indent Lines Plugin</title>

1378

<para>The Indent lines plugin indents the selected lines, or removes the indentation from the selected lines. To use the Indent lines plugin, perform the following steps:</para>

1379

1380

<listitem><para>Load the Indent lines plugin. </para>

1381

</listitem>

1382

<listitem><para>Select the lines that you want to indent. To indent or unindent a single line, place the cursor anywhere on that line.

1383

</para>

1384

</listitem>

1385

<listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Indent</guimenuitem> </menuchoice>. </para>

1386

</listitem>

1387

<listitem><para>To remove the indentation, select the lines and choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Unindent</guimenuitem> </menuchoice>.

1388

</para>

1389

</listitem>

1390

</orderedlist>

1391

</sect2>

1392

1393

1394

<title>To Use the Insert Date/Time Plugin</title>

1395

<para>The Insert Date/Time plugin inserts the current date and time into a file. To use the Insert Date/Time plugin, perform the following steps:</para>

1396

1397

<listitem><para>Load the Insert Date/Time plugin. </para>

1398

</listitem>

1399

<listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>. </para>

1400

<para>If you have not configured the Insert Date/Time plugin to automatically insert the date/time without prompting you for the format, <application>&app;</application> displays the <guilabel>Insert Date and Time</guilabel> dialog. Select the appropriate date/time format from the list. Click <guibutton>Insert</guibutton> to close the <guilabel>Insert Date and Time</guilabel> dialog. <application>&app;</application> inserts the date/time at the cursor position in the current file. </para>

1401

<para>If you have configured <application>&app;</application> to use one particular date/time format, the <guilabel>Insert Date and Time</guilabel> dialog is not displayed. The date/time is automatically entered at the cursor position in the current file. </para>

1402

<para>See <xref linkend="gedit-date-time-configure"/> for information about how to configure the Insert Date/Time plugin.</para>

1403

</listitem>

1404

</orderedlist>

1405

1406

1407

<title>To Configure the Insert Date/Time Plugin</title>

1408

<para>To configure the Insert Date/Time plugin, perform the following steps:</para>

1409

1410

<listitem> <para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>.

1411

</para>

1412

</listitem>

1413

<listitem> <para>Select the <guilabel>Plugins</guilabel> tab.

1414

</para>

1415

</listitem>

1416

<listitem> <para>Select the <guilabel>Insert Date/Time</guilabel> plugin.

1417

</para>

1418

</listitem>

1419

<listitem> <para>Click <guibutton>Configure Plugin</guibutton> to display the <guilabel>Configure insert date/time plugin</guilabel> dialog.

1420

</para>

1421

</listitem>

1422

<listitem> <para>Select one of the options, as follows: </para>

1423

1424

<listitem><para>To specify the date/time format each time you insert the date/time, select the <guilabel>Prompt for a format</guilabel> option.

1425

</para>

1426

</listitem>

1427

<listitem><para>To use the same <application>&app;</application>-provided date/time format each time you insert the date/time, select the <guilabel>Use the selected format</guilabel> option, then select the appropriate format from the list. When you select this option, <application>&app;</application> does not prompt you for the date/time format when you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>.

1428

</para>

1429

</listitem>

1430

<listitem><para>To use the same customized date/time format each time you insert the date/time, select the <guilabel>Use custom format</guilabel> option, then enter the appropriate format in the text box. For more information about how to specify a custom format, see <ulink url="man:strftime" type="man"><citerefentry><refentrytitle>strftime</refentrytitle><manvolnum>3</manvolnum></citerefentry></ulink>. When you select this option, <application>&app;</application> does not prompt you for the date/time format when you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>.

1431

</para>

1432

</listitem>

1433

</itemizedlist>

1434

</listitem>

1435

<listitem> <para>Click <guibutton>OK</guibutton> to close the <guilabel>Configure insert date/time plugin</guilabel> dialog.

1436

</para>

1437

</listitem>

1438

<listitem> <para>To close the <guilabel>Preferences</guilabel> dialog, click <guibutton>Close</guibutton>.</para>

1439

</listitem>

1440

</orderedlist>

1441

</sect3>

1442

</sect2>

1443

1444

1445

<title>To Use the Shell Command Plugin</title>

1446

1447

<para>The Shell Command plugin enables you to capture the output from a shell command in <application>&app;</application>, by displaying the text output of the shell command in the output window. To use the Shell command plugin, perform the following steps:</para>

1448

1449

<listitem><para>Load the Shell command plugin. </para>

1450

</listitem>

1451

1452

<listitem><para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Run Command</guimenuitem> </menuchoice> to display the <guilabel>Run Command</guilabel> dialog.

1453

</para>

1454

</listitem>

1455

<listitem><para>Type the shell command that you want to execute in the <guilabel>Command</guilabel> field. </para>

1456

<para> You can include the following special characters:</para>

1457

1458

1459

1460

<para>Use these special characters to specify the filename of the current active document, including the path. </para>

1461

</listitem>

1462

1463

1464

<para>Use these special characters to specify the filename of the current active document, without the path. In this case, <application>&app;</application> looks for the file in the Working directory. </para>

1465

</listitem>

1466

</itemizedlist>

1467

</listitem>

1468

<listitem><para>Edit the <guilabel>Working directory</guilabel> field if necessary. By default, the Shell command plugin executes the command you specify in the current directory. </para>

1469

</listitem>

1470

<listitem><para>Select the <guilabel>Show results in Output Window</guilabel> option to display the results of the command in the output window. If you do not select this option, <application>&app;</application> discards the results of the command.

1471

</para>

1472

</listitem>

1473

<listitem><para>Click <guibutton>Run</guibutton>. The Shell command plugin executes the command and inserts the text output into the output window.

1474

</para>

1475

</listitem>

1476

<listitem><para>Use the <keycap>Shift</keycap> key to select the text in the output window. </para>

1477

</listitem>

1478

<listitem><para>Click <guibutton>Copy selected lines</guibutton> to copy the selected text into the buffer.

1479

</para>

1480

</listitem>

1481

<listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem> </menuchoice> to paste the selected text into the file.

1482

</para>

1483

</listitem>

1484

<listitem><para>Click <guibutton>Close the output window</guibutton> to close the output window.

1485

</para>

1486

</listitem>

1487

</orderedlist>

1488

1489

</sect2>

1490

1491

<title>To Use the Sort Plugin</title>

1492

<para>The Sort plugin sorts the selected text.</para>

1493

<note><para>You cannot undo the Sort operation, so you should save the file before performing the sort. To revert to the saved version of the file after the sort operation, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Revert</guimenuitem> </menuchoice>.

1494

</para>

1495

</note>

1496

<para>To use the Sort plugin, perform the following steps:</para>

1497

1498

<listitem><para>Load the Sort plugin. </para>

1499

</listitem>

1500

<listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Sort</guimenuitem> </menuchoice> to display the <guilabel>Sort</guilabel> dialog.

1501

</para>

1502

</listitem>

1503

<listitem><para>To arrange the text in reverse sort order, select the <guilabel>Reverse order</guilabel> option.

1504

</para>

1505

</listitem>

1506

<listitem><para>To delete duplicate lines, select the <guilabel>Remove duplicates</guilabel> option.

1507

</para>

1508

</listitem>

1509

<listitem><para>To ignore case sensitivity, select the <guilabel>Ignore case</guilabel> option.

1510

</para>

1511

</listitem>

1512

<listitem><para>To specify the start position of the sort, use the <guilabel>Start at column</guilabel> spin box.

1513

</para>

1514

</listitem>

1515

<listitem><para>To perform the sort operation, click <guibutton>Sort</guibutton>.

1516

</para>

1517

</listitem>

1518

</orderedlist>

1519

</sect2>

1520

1521

1522

<title>To Use the Spell Checker Plugin</title>

1523

<para>The Spell checker plugin checks the spelling in the selected text. You can configure <application>&app;</application> to check the spelling automatically, or you can check the spelling manually, in the specified language. The language setting, and the autocheck spelling properties, apply per document. To use the Spell checker plugin, perform the following steps:</para>

1524

1525

<listitem><para>Load the Spell checker plugin. </para>

1526

</listitem>

1527

<listitem><para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Set Language</guimenuitem> </menuchoice> to display the <guilabel>Set language</guilabel> dialog. Select the appropriate language from the list. Click <guibutton>OK</guibutton> to close the <guilabel>Set language</guilabel> dialog.

1528

</para>

1529

</listitem>

1530

<listitem><para>To check the spelling automatically, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Autocheck Spelling</guimenuitem> </menuchoice>. To unset the automatic spell check, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Autocheck Spelling</guimenuitem> </menuchoice> again. When automatic spell checking is set, an icon is displayed beside the <guimenuitem>Autocheck Spelling</guimenuitem> menu item. Automatic spell checking is unset by default, each time <application>&app;</application> starts.</para>

1531

<para>Unknown spellings are displayed in a different color, and underlined. Right-click on an unknown spelling, then select <guimenu>Spelling Suggestions</guimenu> from the popup menu:

1532

</para>

1533

1534

<listitem><para>To replace the unknown spelling with another spelling in the list, select the replacement spelling from the <guimenu>Spelling Suggestions</guimenu> popup menu.

1535

</para>

1536

</listitem>

1537

<listitem><para>To add the unknown spelling to your personal dictionary, select <menuchoice> <guimenu>Spelling Suggestions</guimenu> <guimenuitem>Add</guimenuitem> </menuchoice>.

1538

</para>

1539

</listitem>

1540

<listitem><para>To ignore all occurrences of the unknown spelling, so that they are no longer flagged as unknown but are not added to your personal dictionary, select <menuchoice> <guimenu>Spelling Suggestions</guimenu> <guimenuitem>Ignore All</guimenuitem> </menuchoice>. The unknown word is ignored in the current <application>&app;</application> session only.

1541

</para>

1542

</listitem>

1543

</itemizedlist>

1544

</listitem>

1545

<listitem><para>To check the spelling manually, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Check Spelling</guimenuitem> </menuchoice>.

1546

</para>

1547

<para>If there are no spelling errors, an <guilabel>Information</guilabel> dialog displays a message stating that the document does not contain misspelled words. Click <guibutton>OK</guibutton> to close the <guilabel>Information</guilabel> dialog.

1548

</para>

1549

<para>If there are spelling errors, the <guilabel>Check Spelling</guilabel> dialog is displayed:

1550

</para>

1551

1552

<listitem><para>The <guilabel>Misspelled word</guilabel> is displayed at the top of the dialog.

1553

</para>

1554

</listitem>

1555

<listitem><para>A suggested known spelling is displayed in the <guilabel>Change to</guilabel> text box. You can replace this with another known spelling by selecting a spelling from the <guilabel>Suggestions</guilabel> list, or you can enter text directly into the <guilabel>Change to</guilabel> text box.

1556

</para>

1557

</listitem>

1558

<listitem><para>To check the spelling of the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Check Word</guibutton>. If this is a known word, the <guilabel>Suggestions</guilabel> list is replaced with the text <literal>(correct spelling)</literal>. If the word is not known, new entries appear in the <guilabel>Suggestions</guilabel> list.

1559

</para>

1560

</listitem>

1561

<listitem><para>To ignore the current occurrence of the unknown word, click <guibutton>Ignore</guibutton>. To ignore all occurrences of the unknown word, click <guibutton>Ignore All</guibutton>. The unknown word is ignored in the current <application>&app;</application> session only.

1562

</para>

1563

</listitem>

1564

<listitem><para>To change the current occurrence of the unknown word to the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Change</guibutton>. To change all occurrences of the unknown word to the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Change All</guibutton>.

1565

</para>

1566

</listitem>

1567

<listitem><para>To add the unknown word to your personal dictionary, click <guibutton>Add word</guibutton>.

1568

</para>

1569

</listitem>

1570

<listitem><para>To close the <guilabel>Check Spelling</guilabel> dialog, click <guibutton>Close</guibutton>.

1571

</para>

1572

</listitem>

1573

</itemizedlist>

1574

</listitem>

1575

</orderedlist>

1576

</sect2>

1577

1578

1579

<title>To Use the Tag List Plugin</title>

1580

<para>The Tag List plugin displays a window that contains a list of common tags. You can use the window to insert a tag into a file. To use the Tag List plugin, perform the following steps:</para>

1581

1582

<listitem><para>Load the Tag List plugin. </para>

1583

</listitem>

1584

<listitem><para>Choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Tag List</guimenuitem> </menuchoice> to display the <guilabel>Tag list plugin</guilabel> window.

1585

</para>

1586

</listitem>

1587

<listitem><para>Select the appropriate tag category from the drop-down list. For example, <literal>HTML - Tags</literal>.

1588

</para>

1589

</listitem>

1590

<listitem><para>Scroll through the tag list to find the required tag.

1591

</para>

1592

</listitem>

1593

<listitem><para>To insert a tag at the cursor position in the current file, double-click on the tag in the tag list. You can also insert a tag as follows:</para>

1594

1595

<listitem><para>To insert a tag in the current file and change the focus from the <guilabel>Tag list plugin</guilabel> window to the editor window, press <keycap>Return</keycap>.

1596

</para>

1597

</listitem>

1598

<listitem><para>To insert a tag in the current file and maintain the focus on the <guilabel>Tag list plugin</guilabel> window, press <keycombo><keycap>Shift</keycap><keycap>Return</keycap></keycombo>.

1599

</para>

1600

</listitem>

1601

</itemizedlist>

1602

</listitem>

1603

<listitem><para>To close the <guilabel>Tag list plugin</guilabel> window, click on the <guibutton>Close Window</guibutton> button in the window frame. Alternatively, press <keycombo><keycap>Ctrl</keycap><keycap>W</keycap></keycombo> when the focus is on the <guilabel>Tag list plugin</guilabel> window.

1604

</para>

1605

</listitem>

1606

</orderedlist>

1607

</sect2>

1608

1609

1610

<title>To Use the User Name Plugin</title>

1611

<para>The User name plugin inserts the username of the current user into the file. To use the User name plugin, perform the following steps:</para>

1612

1613

<listitem><para>Load the User name plugin. </para>

1614

</listitem>

1615

<listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert User Name</guimenuitem> </menuchoice> to insert your username at the cursor position in the current file.

1616

</para>

1617

</listitem>

1618

</orderedlist>

1619

</sect2>

86

87

<title>Introduction</title>

88

<para>This is only a template to get the documentation done.

89

It should not be translated.</para>

1620

90

</sect1>

1621

91

1622

92

</article>

93

94