~ubuntu-branches/debian/sid/nano/sid : revision 27

2

<html>

3

4

<head>

5

<title>nano Command Manual</title>

5

6

7

8

7

8

9

10

11

46

</head>

47

48

49

<h1 class="settitle" align="center">nano Command Manual</h1>

49

50

51

52

66

67

<tr><td align="left" valign="top">• <a href="#Introduction" accesskey="1">Introduction</a>:</td><td>  </td><td align="left" valign="top">

68

</td></tr>

69

<tr><td align="left" valign="top">• <a href="#Editor-Basics" accesskey="2">Editor Basics</a>:</td><td>  </td><td align="left" valign="top">

70

</td></tr>

71

<tr><td align="left" valign="top">• <a href="#Built_002din-Help" accesskey="3">Built-in Help</a>:</td><td>  </td><td align="left" valign="top">

72

</td></tr>

73

<tr><td align="left" valign="top">• <a href="#Feature-Toggles" accesskey="4">Feature Toggles</a>:</td><td>  </td><td align="left" valign="top">

74

</td></tr>

75

<tr><td align="left" valign="top">• <a href="#Nanorc-Files" accesskey="5">Nanorc Files</a>:</td><td>  </td><td align="left" valign="top">

76

</td></tr>

77

<tr><td align="left" valign="top">• <a href="#The-File-Browser" accesskey="6">The File Browser</a>:</td><td>  </td><td align="left" valign="top">

78

</td></tr>

79

<tr><td align="left" valign="top">• <a href="#Pico-Compatibility" accesskey="7">Pico Compatibility</a>:</td><td>  </td><td align="left" valign="top">

80

</td></tr>

81

<tr><td align="left" valign="top">• <a href="#Building-and-Configure-Options" accesskey="8">Building and Configure Options</a>:</td><td>  </td><td align="left" valign="top">

69

<tr><td align="left" valign="top">• <a href="#Invoking" accesskey="2">Invoking</a>:</td><td>  </td><td align="left" valign="top">

70

</td></tr>

71

<tr><td align="left" valign="top">• <a href="#Command_002dline-Options" accesskey="3">Command-line Options</a>:</td><td>  </td><td align="left" valign="top">

72

</td></tr>

73

<tr><td align="left" valign="top">• <a href="#Editor-Basics" accesskey="4">Editor Basics</a>:</td><td>  </td><td align="left" valign="top">

74

</td></tr>

75

<tr><td align="left" valign="top">• <a href="#Built_002din-Help" accesskey="5">Built-in Help</a>:</td><td>  </td><td align="left" valign="top">

76

</td></tr>

77

<tr><td align="left" valign="top">• <a href="#Feature-Toggles" accesskey="6">Feature Toggles</a>:</td><td>  </td><td align="left" valign="top">

78

</td></tr>

79

<tr><td align="left" valign="top">• <a href="#Nanorc-Files" accesskey="7">Nanorc Files</a>:</td><td>  </td><td align="left" valign="top">

80

</td></tr>

81

<tr><td align="left" valign="top">• <a href="#The-File-Browser" accesskey="8">The File Browser</a>:</td><td>  </td><td align="left" valign="top">

82

</td></tr>

83

<tr><td align="left" valign="top">• <a href="#Pico-Compatibility" accesskey="9">Pico Compatibility</a>:</td><td>  </td><td align="left" valign="top">

84

</td></tr>

85

<tr><td align="left" valign="top">• <a href="#Building-and-Configure-Options">Building and Configure Options</a>:</td><td>  </td><td align="left" valign="top">

82

86

</td></tr>

83

87

</table>

84

88

87

91

88

92

89

93

<p>

90

Next: <a href="#Editor-Basics" accesskey="n" rel="next">Editor Basics</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

94

Next: <a href="#Invoking" accesskey="n" rel="next">Invoking</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

91

95

</div>

92

96

93

97

<h2 class="chapter">1 Introduction</h2>

98

102

auto-indentation, go-to-line-and-column-number, feature toggles,

99

103

file locking, backup files, and internationalization support.

100

104

</p>

101

102

<tr><td align="left" valign="top">• <a href="#Overview" accesskey="1">Overview</a>:</td><td>  </td><td align="left" valign="top">

103

</td></tr>

104

<tr><td align="left" valign="top">• <a href="#Command-Line-Options" accesskey="2">Command Line Options</a>:</td><td>  </td><td align="left" valign="top">

105

</td></tr>

106

</table>

107

108

<hr>

109

110

111

<p>

112

Next: <a href="#Command-Line-Options" accesskey="n" rel="next">Command Line Options</a>, Up: <a href="#Introduction" accesskey="u" rel="up">Introduction</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

113

</div>

114

115

<h3 class="section">1.1 Overview</h3>

116

117

<p>The original goal for <code>nano</code> was a complete bug-for-bug compatible

118

emulation of Pico, but <code>nano</code>’s current goal is to be as compatible

105

<p>The original goal for <code>nano</code> was to be a complete bug-for-bug

106

emulation of Pico. But currently the goal is to be as compatible

119

107

as possible while offering a superset of Pico’s functionality. See

120

108

See <a href="#Pico-Compatibility">Pico Compatibility</a>, for more info.

121

109

</p>

110

<p>Please report bugs via <a href="https://savannah.gnu.org/bugs/?group=nano">https://savannah.gnu.org/bugs/?group=nano</a>.

111

</p>

112

<hr>

113

114

115

<p>

116

Next: <a href="#Command_002dline-Options" accesskey="n" rel="next">Command-line Options</a>, Previous: <a href="#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

117

</div>

118

119

<h2 class="chapter">2 Invoking</h2>

120

122

121

<p>The usual way to invoke <code>nano</code> is:

123

122

</p>

124

123

140

139

(making <code>nano</code> remember the cursor position), you will rarely

141

140

need to specify a line number.

142

141

</p>

143

<p>Please email any bug reports to <a href="mailto:nano@nano-editor.org">nano@nano-editor.org</a>.

144

Or file them at <a href="https://savannah.gnu.org/bugs/?group=nano">https://savannah.gnu.org/bugs/?group=nano</a>.

145

</p>

146

142

<hr>

147

143

148

144

149

145

<p>

150

Previous: <a href="#Overview" accesskey="p" rel="prev">Overview</a>, Up: <a href="#Introduction" accesskey="u" rel="up">Introduction</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

146

Next: <a href="#Editor-Basics" accesskey="n" rel="next">Editor Basics</a>, Previous: <a href="#Invoking" accesskey="p" rel="prev">Invoking</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

151

147

</div>

152

153

<h3 class="section">1.2 Command Line Options</h3>

148

149

<h2 class="chapter">3 Command-line Options</h2>

154

150

155

151

<p><code>nano</code> takes the following options from the command line:

156

152

</p>

171

167

</dd>

172

168

173

169

<dt><samp>--backup</samp></dt>

174

<dd><p>When saving a file, back up the previous version of it to the current

175

filename suffixed with a ‘<samp>~</samp>’.

170

<dd><p>When saving a file, back up the previous version of it, using the current

171

filename suffixed with a tilde (‘<samp>~</samp>’).

176

172

</p>

177

173

</dd>

178

174

<dt><samp>-C <var>directory</var></samp></dt>

179

175

<dt><samp>--backupdir=<var>directory</var></samp></dt>

180

<dd><p>Set the directory where <code>nano</code> puts unique backup files if file

181

backups are enabled.

176

<dd><p>Make and keep not just one backup file, but make and keep a uniquely

177

numbered one every time a file is saved — when backups are enabled.

178

The uniquely numbered files are stored in the specified directory.

182

179

</p>

183

180

</dd>

184

181

193

190

</dd>

194

191

195

192

<dt><samp>--multibuffer</samp></dt>

196

<dd><p>Enable multiple file buffers (if support for them has been compiled in).

193

<dd><p>Read a file into a new buffer by default.

197

194

</p>

198

195

</dd>

199

196

405

402

406

403

<dt><samp>--nowrap</samp></dt>

407

404

<dd><p>Don’t hard-wrap long lines at any length. This option conflicts with

408

<samp>-r</samp> – the last one given takes effect.

405

<samp>-r</samp> — the last one given takes effect.

409

406

</p>

410

407

411

408

441

438

442

439

443

440

<dd><p>Ignored, for compatibility with Pico.

444

</p></dd>

441

</p>

442

</dd>

445

443

</dl>

446

444

447

445

449

447

450

448

451

449

<p>

452

Next: <a href="#Built_002din-Help" accesskey="n" rel="next">Built-in Help</a>, Previous: <a href="#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

450

Next: <a href="#Built_002din-Help" accesskey="n" rel="next">Built-in Help</a>, Previous: <a href="#Command_002dline-Options" accesskey="p" rel="prev">Command-line Options</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

453

451

</div>

454

452

455

<h2 class="chapter">2 Editor Basics</h2>

453

<h2 class="chapter">4 Editor Basics</h2>

456

454

457

455

458

456

<tr><td align="left" valign="top">• <a href="#Entering-Text" accesskey="1">Entering Text</a>:</td><td>  </td><td align="left" valign="top">

480

478

Next: <a href="#Special-Functions" accesskey="n" rel="next">Special Functions</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

481

479

</div>

482

480

483

<h3 class="section">2.1 Entering Text</h3>

481

<h3 class="section">4.1 Entering Text</h3>

484

482

485

483

<p><code>nano</code> is a "modeless" editor. All keystrokes, with the exception

486

484

of Control and Meta key sequences, enter text into the file being edited.

493

491

Next: <a href="#The-Cutbuffer" accesskey="n" rel="next">The Cutbuffer</a>, Previous: <a href="#Entering-Text" accesskey="p" rel="prev">Entering Text</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

494

492

</div>

495

493

496

<h3 class="section">2.2 Special Functions</h3>

494

<h3 class="section">4.2 Special Functions</h3>

497

495

498

496

<p>Special functions use the Control key (Ctrl), displayed in the help and

499

497

shortcut lists as ^; the Meta key (Alt or Cmd), displayed as M-; or the

520

518

Next: <a href="#The-Mark" accesskey="n" rel="next">The Mark</a>, Previous: <a href="#Special-Functions" accesskey="p" rel="prev">Special Functions</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

521

519

</div>

522

520

523

<h3 class="section">2.3 The Cutbuffer</h3>

521

<h3 class="section">4.3 The Cutbuffer</h3>

524

522

525

523

<p>Text can be cut from a file, a whole line at a time, by using the ’Cut Text’

526

524

command (default key binding: ^K). The cut line is stored in the cutbuffer.

540

538

Next: <a href="#The-Titlebar" accesskey="n" rel="next">The Titlebar</a>, Previous: <a href="#The-Cutbuffer" accesskey="p" rel="prev">The Cutbuffer</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

541

539

</div>

542

540

543

541

544

542

545

543

<p>Text can be selected by first ’setting the Mark’ (default key bindings:

546

544

^6 and M-A) and then moving the cursor to the other end of the portion

560

558

Next: <a href="#The-Statusbar" accesskey="n" rel="next">The Statusbar</a>, Previous: <a href="#The-Mark" accesskey="p" rel="prev">The Mark</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

561

559

</div>

562

560

563

<h3 class="section">2.5 The Titlebar</h3>

561

<h3 class="section">4.5 The Titlebar</h3>

564

562

565

563

<p>The titlebar is the line displayed at the top of the editor. There are

566

564

three sections: left, center and right. The section on the left

580

578

Next: <a href="#Shortcut-Lists" accesskey="n" rel="next">Shortcut Lists</a>, Previous: <a href="#The-Titlebar" accesskey="p" rel="prev">The Titlebar</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

581

579

</div>

582

580

583

<h3 class="section">2.6 The Statusbar</h3>

581

<h3 class="section">4.6 The Statusbar</h3>

584

582

585

583

<p>The statusbar is the third line from the bottom of the screen, or the

586

584

bottom line in Expert Mode. See See <a href="#Expert-Mode">Expert Mode</a>, for more info. It

596

594

Next: <a href="#Using-the-Mouse" accesskey="n" rel="next">Using the Mouse</a>, Previous: <a href="#The-Statusbar" accesskey="p" rel="prev">The Statusbar</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

597

595

</div>

598

596

599

<h3 class="section">2.7 Shortcut Lists</h3>

597

<h3 class="section">4.7 Shortcut Lists</h3>

600

598

601

599

<p>The Shortcut Lists are the two lines at the bottom of the screen which

602

600

show some of the more commonly used functions in the editor.

608

606

Previous: <a href="#Shortcut-Lists" accesskey="p" rel="prev">Shortcut Lists</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

609

607

</div>

610

608

611

<h3 class="section">2.8 Using the Mouse</h3>

609

<h3 class="section">4.8 Using the Mouse</h3>

612

610

613

611

<p>When mouse support has been configured and enabled, a single mouse click

614

612

places the cursor at the indicated position. Clicking a second time in

628

626

Next: <a href="#Feature-Toggles" accesskey="n" rel="next">Feature Toggles</a>, Previous: <a href="#Editor-Basics" accesskey="p" rel="prev">Editor Basics</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

629

627

</div>

630

628

631

<h2 class="chapter">3 Built-in Help</h2>

629

<h2 class="chapter">5 Built-in Help</h2>

632

630

633

631

<p>The built-in help system in <code>nano</code> is available by pressing ^G.

634

632

It is fairly self-explanatory. It documents the various parts of the

643

641

Next: <a href="#Nanorc-Files" accesskey="n" rel="next">Nanorc Files</a>, Previous: <a href="#Built_002din-Help" accesskey="p" rel="prev">Built-in Help</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

644

642

</div>

645

643

646

<h2 class="chapter">4 Feature Toggles</h2>

644

<h2 class="chapter">6 Feature Toggles</h2>

647

645

648

<p>Toggles allow you to change certain aspects of the editor that would

649

normally be done via command-line options. They are invoked via Meta

650

key sequences. See See <a href="#Special-Functions">Special Functions</a>, for more info. The

651

following global toggles are available:

646

<p>Toggles allow you to change on-the-fly certain aspects of the editor

647

which would normally be specified via command-line options. They are

648

invoked via Meta-key sequences. See See <a href="#Special-Functions">Special Functions</a>, for more info.

649

The following global toggles are available:

652

650

</p>

653

651

654

652

<dt><code>Backup Files Toggle (Meta-B)</code></dt>

655

<dd><p>toggles the -B (<code>--backup</code>) command line option.

653

<dd><p>toggles the -B (<code>--backup</code>) command-line option.

656

654

</p>

657

655

</dd>

658

656

<dt><code>Constant Cursor Position Display Toggle (Meta-C)</code></dt>

659

<dd><p>toggles the -c (<code>--const</code>) command line option.

657

<dd><p>toggles the -c (<code>--const</code>) command-line option.

660

658

</p>

661

659

</dd>

662

660

<dt><code>Multiple File Buffers Toggle (Meta-F)</code></dt>

663

<dd><p>toggles the -F (<code>--multibuffer</code>) command line option.

661

<dd><p>toggles the -F (<code>--multibuffer</code>) command-line option.

664

662

</p>

665

663

</dd>

666

664

<dt><code>Smart Home Key Toggle (Meta-H)</code></dt>

667

<dd><p>toggles the -A (<code>--smarthome</code>) command line option.

665

<dd><p>toggles the -A (<code>--smarthome</code>) command-line option.

668

666

</p>

669

667

</dd>

670

668

<dt><code>Auto Indent Toggle (Meta-I)</code></dt>

671

<dd><p>toggles the -i (<code>--autoindent</code>) command line option.

669

<dd><p>toggles the -i (<code>--autoindent</code>) command-line option.

672

670

</p>

673

671

</dd>

674

672

<dt><code>Cut To End Toggle (Meta-K)</code></dt>

675

<dd><p>toggles the -k (<code>--cut</code>) command line option.

673

<dd><p>toggles the -k (<code>--cut</code>) command-line option.

676

674

</p>

677

675

</dd>

678

676

<dt><code>Long Line Wrapping Toggle (Meta-L)</code></dt>

679

<dd><p>toggles the -w (<code>--nowrap</code>) command line option.

677

<dd><p>toggles the -w (<code>--nowrap</code>) command-line option.

680

678

</p>

681

679

</dd>

682

680

<dt><code>Mouse Support Toggle (Meta-M)</code></dt>

683

<dd><p>toggles the -m (<code>--mouse</code>) command line option.

681

<dd><p>toggles the -m (<code>--mouse</code>) command-line option.

684

682

</p>

685

683

</dd>

686

684

<dt><code>No Conversion From DOS/Mac Format Toggle (Meta-N)</code></dt>

687

<dd><p>toggles the -N (<code>--noconvert</code>) command line option.

685

<dd><p>toggles the -N (<code>--noconvert</code>) command-line option.

688

686

</p>

689

687

</dd>

690

688

<dt><code>More Space For Editing Toggle (Meta-O)</code></dt>

691

<dd><p>toggles the -O (<code>--morespace</code>) command line option.

689

<dd><p>toggles the -O (<code>--morespace</code>) command-line option.

692

690

</p>

693

691

</dd>

694

692

<dt><code>Whitespace Display Toggle (Meta-P)</code></dt>

695

<dd><p>toggles whitespace-display mode.

693

<dd><p>toggles the whitespace-display mode.

696

694

See See <a href="#Whitespace">Whitespace</a>, for more info.

697

695

</p>

698

696

</dd>

699

697

<dt><code>Tabs to Spaces Toggle (Meta-Q)</code></dt>

700

<dd><p>toggles the -E (<code>--tabstospaces</code>) command line option.

698

<dd><p>toggles the -E (<code>--tabstospaces</code>) command-line option.

701

699

</p>

702

700

</dd>

703

701

<dt><code>Smooth Scrolling Toggle (Meta-S)</code></dt>

704

<dd><p>toggles the -S (<code>--smooth</code>) command line option.

702

<dd><p>toggles the -S (<code>--smooth</code>) command-line option.

705

703

</p>

706

704

</dd>

707

705

<dt><code>Expert/No Help Toggle (Meta-X)</code></dt>

708

<dd><p>toggles the -x (<code>--nohelp</code>) command line option.

706

<dd><p>toggles the -x (<code>--nohelp</code>) command-line option.

709

707

</p>

710

708

</dd>

711

709

<dt><code>Color Syntax Highlighting Toggle (Meta-Y)</code></dt>

714

712

</p>

715

713

</dd>

716

714

<dt><code>Suspend Toggle (Meta-Z)</code></dt>

717

<dd><p>toggles the -z (<code>--suspend</code>) command line option.

715

<dd><p>toggles the -z (<code>--suspend</code>) command-line option.

718

716

</p>

719

717

</dd>

720

718

<dt><code>Soft Wrapping Toggle (Meta-$)</code></dt>

721

<dd><p>toggles the -$ (<code>--softwrap</code>) command line option.

719

<dd><p>toggles the -$ (<code>--softwrap</code>) command-line option.

722

720

</p>

723

721

</dd>

724

722

</dl>

731

729

Next: <a href="#The-File-Browser" accesskey="n" rel="next">The File Browser</a>, Previous: <a href="#Feature-Toggles" accesskey="p" rel="prev">Feature Toggles</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

732

730

</div>

733

731

734

<h2 class="chapter">5 Nanorc Files</h2>

732

<h2 class="chapter">7 Nanorc Files</h2>

735

733

736

734

<p>The nanorc files contain the default settings for <code>nano</code>. They

737

735

should be in Unix format, not in DOS or Mac format. During startup,

742

740

<p>A nanorc file accepts a series of "set" and "unset" commands, which can

743

741

be used to configure <code>nano</code> on startup without using command-line

744

742

options. Additionally, there are some commands to define syntax highlighting

745

and to rebind keys – See <a href="#Syntax-Highlighting">Syntax Highlighting</a>, and See <a href="#Rebinding-Keys">Rebinding Keys</a>.

743

and to rebind keys — See <a href="#Syntax-Highlighting">Syntax Highlighting</a>, and See <a href="#Rebinding-Keys">Rebinding Keys</a>.

746

744

<code>nano</code> will read one command per line.

747

745

</p>

748

746

<p>Options in nanorc files take precedence over <code>nano</code>’s defaults, and

773

771

Next: <a href="#Syntax-Highlighting" accesskey="n" rel="next">Syntax Highlighting</a>, Up: <a href="#Nanorc-Files" accesskey="u" rel="up">Nanorc Files</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

774

772

</div>

775

773

776

<h3 class="section">5.1 Settings</h3>

774

<h3 class="section">7.1 Settings</h3>

777

775

778

776

<p>The supported settings in a nanorc file are:

779

777

</p>

789

787

</p>

790

788

</dd>

791

789

<dt><code>set backup</code></dt>

792

<dd><p>When saving a file, back up the previous version of it to the current

790

<dd><p>When saving a file, back up the previous version of it, using the current

793

791

filename suffixed with a tilde (<code>~</code>).

794

792

</p>

795

793

</dd>

796

794

<dt><code>set backupdir "directory"</code></dt>

797

<dd><p>Set the directory where <code>nano</code> puts unique backup files, if file

798

backups are enabled.

795

<dd><p>Make and keep not just one backup file, but make and keep a uniquely

796

numbered one every time a file is saved — when backups are enabled

797

with <code>set backup</code> or <code>--backup</code> or <code>-B</code>.

798

The uniquely numbered files are stored in the specified directory.

799

</p>

800

</dd>

801

<dt><code>set backwards</code></dt>

879

</p>

880

</dd>

881

<dt><code>set multibuffer</code></dt>

882

<dd><p>Allow inserting files into their own buffers.

882

<dd><p>When reading in a file with ^R, insert it into a new buffer by default.

883

</p>

884

</dd>

885

<dt><code>set noconvert</code></dt>

1038

Next: <a href="#Rebinding-Keys" accesskey="n" rel="next">Rebinding Keys</a>, Previous: <a href="#Settings" accesskey="p" rel="prev">Settings</a>, Up: <a href="#Nanorc-Files" accesskey="u" rel="up">Nanorc Files</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

1039

</div>

1040

1041

<h3 class="section">5.2 Syntax Highlighting</h3>

1041

<h3 class="section">7.2 Syntax Highlighting</h3>

1042

1043

<p>Coloring the different syntactic elements of a file

1044

is done via regular expressions (see the <code>color</code> command below).

1052

</p>

1053

1054

<dt><code>syntax "str" ["fileregex" …]</code></dt>

1055

<dd><p>Defines a syntax named "str" which can be activated via the -Y/–syntax

1055

<dd><p>Defines a syntax named "str" which can be activated via the <code>-Y/--syntax</code>

1056

command-line option, or will be automatically activated if the current

1057

filename matches the extended regular expression "fileregex". All

1058

following "color" and "icolor" statements will apply to this "str"

1059

syntax until a new syntax is defined.

1058

subsequent <code>color</code>, <code>icolor</code>, <code>header</code> and other such

1059

statements will apply to this "str" syntax until a new <code>syntax</code>

1060

command is encountered.

1060

1061

</p>

1061

1062

<p>The "none" syntax is reserved; specifying it on the command line is the

1062

1063

same as not having a syntax at all. The "default" syntax is special: it

1063

takes no "fileregex", and applies to files that don’t match any other

1064

takes no "fileregex", and applies to files that don’t match any

1064

1065

syntax’s "fileregex".

1065

1066

</p>

1066

1067

</dd>

1067

1068

<dt><code>linter program [arg …]</code></dt>

1068

<dd><p>For the currently defined syntax, use the given program to invoke the

1069

linter (this overrides the speller function when defined).

1069

<dd><p>Use the given program to do a syntax check on the current file

1070

(this overrides the speller function when defined).

1070

1071

</p>

1071

1072

</dd>

1072

1073

<dt><code>formatter program [arg …]</code></dt>

1073

<dd><p>For the currently defined syntax, use the given program to automatically

1074

reformat text. Useful in certain programming languages (e.g. go).

1074

<dd><p>Use the given program to automatically reformat text.

1075

Useful in certain programming languages (e.g. Go).

1075

1076

</p>

1076

1077

</dd>

1077

1078

<dt><code>header "regex" …</code></dt>

1078

<dd><p>For the currently defined syntax, add one or more regexes which will

1079

<dd><p>Add one or more regexes which will

1079

1080

be compared against the very first line of the file to be edited,

1080

1081

to determine whether this syntax should be used for that file.

1081

1082

</p>

1082

1083

</dd>

1083

1084

<dt><code>magic "regex" …</code></dt>

1084

<dd><p>For the currently defined syntax, add one or more regexes which will be

1085

<dd><p>Add one or more regexes which will be

1085

1086

compared against the result of querying the magic database about the file

1086

1087

to be edited, to determine whether this syntax should be used for that

1087

1088

file. This functionality only works when libmagic is installed on the

1089

1090

</p>

1090

1091

</dd>

1091

1092

<dt><code>color fgcolor,bgcolor "regex" …</code></dt>

1092

<dd><p>For the currently defined syntax, display all expressions matching the

1093

<dd><p>Display all pieces of text that match the

1093

1094

extended regular expression "regex" with foreground color "fgcolor" and

1094

1095

background color "bgcolor", at least one of which must be specified.

1095

1096

Valid colors for foreground and background are: white, black, red,

1100

1101

</p>

1101

1102

</dd>

1102

1103

<dt><code>icolor fgcolor,bgcolor "regex" …</code></dt>

1103

<dd><p>Same as above, except that the expression matching is case insensitive.

1104

<dd><p>Same as above, except that the text matching is case insensitive.

1104

1105

</p>

1105

1106

</dd>

1106

1107

<dt><code>color fgcolor,bgcolor start="sr" end="er"</code></dt>

1107

<dd><p>Display expressions which start with the extended regular expression

1108

"sr" and end with the extended regular expression "er" with foreground

1108

<dd><p>Display all pieces of text whose start matches extended regular expression

1109

"sr" and whose end matches extended regular expression "er" with foreground

1109

1110

color "fgcolor" and background color "bgcolor", at least one of which

1110

must be specified. This allows syntax highlighting to span multiple

1111

lines. Note that all subsequent instances of "sr" after an initial "sr"

1112

is found will be highlighted until the first instance of "er".

1111

must be specified. This means that, after an initial instance of "sr",

1112

all text will be highlighted until the first instance of "er".

1113

This allows syntax highlighting to span multiple lines.

1113

1114

</p>

1114

1115

</dd>

1115

1116

<dt><code>icolor fgcolor,bgcolor start="sr" end="er"</code></dt>

1116

<dd><p>Same as above, except that the expression matching is case insensitive.

1117

<dd><p>Same as above, except that the text matching is case insensitive.

1117

1118

</p>

1118

1119

</dd>

1119

1120

<dt><code>include "syntaxfile"</code></dt>

1120

1121

<dd><p>Read in self-contained color syntaxes from "syntaxfile". Note that

1121

"syntaxfile" can only contain the above commands, from "syntax" to

1122

"icolor".

1122

"syntaxfile" may contain only the above commands, from <code>syntax</code>

1123

to <code>icolor</code>.

1123

1124

</p>

1124

1125

</dd>

1125

1126

<dt><code>extendsyntax str directive [arg …]</code></dt>

1126

1127

<dd><p>Extend the syntax previously defined as str to include new information.

1127

Allows you to add a new color, icolor, magic, header, or linter directive

1128

to an already defined syntax. Useful when you want to add to definitions

1129

from the system-installed syntax definitions (which are normally not writable).

1128

This allows you to add a new <code>color</code>, <code>icolor</code>, <code>header</code>,

1129

<code>magic</code>, <code>linter</code>, or <code>formatter</code> directive to an already

1130

defined syntax — useful when you want to slightly improve a syntax defined

1131

in one of the system-installed files (which are normally not writable).

1130

1132

</p>

1131

1133

</dd>

1132

1134

</dl>

1138

1140

Previous: <a href="#Syntax-Highlighting" accesskey="p" rel="prev">Syntax Highlighting</a>, Up: <a href="#Nanorc-Files" accesskey="u" rel="up">Nanorc Files</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

1139

1141

</div>

1140

1142

1141

<h3 class="section">5.3 Rebinding Keys</h3>

1143

<h3 class="section">7.3 Rebinding Keys</h3>

1142

1144

1143

1145

<p>Key bindings may be reassigned via the following two commands in a

1144

1146

nanorc file:

1196

1198

</p>

1197

1199

</dd>

1198

1200

<dt><code>insert</code></dt>

1199

<dd><p>Inserts a file into the current buffer (or into a new buffer when multibuffer

1200

is enabled).

1201

<dd><p>Inserts a file into the current buffer (at the current cursor position),

1202

or into a new buffer when option <code>multibuffer</code> is set.

1201

1203

</p>

1202

1204

</dd>

1203

1205

<dt><code>whereis</code></dt>

1204

<dd><p>Searches for text in the current buffer – or for filenames matching

1206

<dd><p>Searches for text in the current buffer — or for filenames matching

1205

1207

a string in the current list in the file browser

1206

1208

</p>

1207

1209

</dd>

1341

1343

</p>

1342

1344

</dd>

1343

1345

<dt><code>prevbuf</code></dt>

1344

<dd><p>Switches to editing/viewing the previous buffer when using multibuffer mode.

1346

<dd><p>Switches to editing/viewing the previous buffer when multiple buffers are open.

1345

1347

</p>

1346

1348

</dd>

1347

1349

<dt><code>nextbuf</code></dt>

1348

<dd><p>Switches to editing/viewing the next buffer when using multibuffer mode.

1350

<dd><p>Switches to editing/viewing the next buffer when multiple buffers are open.

1349

1351

</p>

1350

1352

</dd>

1351

1353

<dt><code>verbatim</code></dt>

1509

1511

</p>

1510

1512

</dd>

1511

1513

<dt><code>multibuffer</code></dt>

1512

<dd><p>Toggles the use of multiple file buffers (if available).

1514

<dd><p>Toggles whether a file is inserted into the current buffer

1515

or read into a new buffer.

1513

1516

</p>

1514

1517

</dd>

1515

1518

<dt><code>mouse</code></dt>

1589

1592

<dd><p>A special name that encompasses all menus. For <code>bind</code> it means

1590

1593

all menus where the specified <code>function</code> exists; for <code>unbind</code>

1591

1594

it means all menus where the specified <code>key</code> exists.

1592

</p></dd>

1595

</p>

1596

</dd>

1593

1597

</dl>

1594

1598

1595

1599

1600

1604

Next: <a href="#Pico-Compatibility" accesskey="n" rel="next">Pico Compatibility</a>, Previous: <a href="#Nanorc-Files" accesskey="p" rel="prev">Nanorc Files</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

1601

1605

</div>

1602

1606

1603

<h2 class="chapter">6 The File Browser</h2>

1607

<h2 class="chapter">8 The File Browser</h2>

1604

1608

1605

1609

<p>When reading or writing files, pressing ^T will invoke the file browser.

1606

1610

Here, one can navigate directories in a graphical manner in order to

1623

1627

Next: <a href="#Building-and-Configure-Options" accesskey="n" rel="next">Building and Configure Options</a>, Previous: <a href="#The-File-Browser" accesskey="p" rel="prev">The File Browser</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

1624

1628

</div>

1625

1629

1626

<h2 class="chapter">7 Pico Compatibility</h2>

1630

<h2 class="chapter">9 Pico Compatibility</h2>

1627

1631

1628

1632

<p><code>nano</code> attempts to emulate Pico as closely as possible, but there

1629

1633

are certain differences between the editors:

1630

1634

</p>

1631

1635

1636

<dt><code>Interactive Replace</code></dt>

1637

<dd><p>Instead of allowing you to replace either just one occurrence of a search

1638

string or all of them, <code>nano</code>’s replace function is interactive: it

1639

will pause at each found search string and query whether to replace this

1640

instance. You can then choose Yes, or No (skip this one), or All (don’t

1641

ask any more), or Cancel (stop with replacing).

1642

</p>

1643

</dd>

1632

1644

<dt><code>Search and Replace History</code></dt>

1633

<dd><p>As of version 1.1.99pre1 of <code>nano</code>, text entered as search or

1634

replace strings will be stored and can be accessed with the up/down

1635

arrow keys. Previously, <code>nano</code> offered a more consistent, but

1636

incompatible with Pico, method for entering search and replace strings.

1637

In the old method, previous entries would be displayed by default as

1638

editable text in front of the cursor, as opposed to being bracketed and

1639

uneditable as it is in Pico. The old behavior could be made compatible

1640

with Pico via the <code>-p</code> option, but recent versions of Pico use the

1641

<code>-p</code> option to preserve the XON and XOFF sequences within the

1642

editor. Since, with the new method, search and replace strings can

1643

still be edited by simply hitting the up arrow key once, the old method

1644

was removed completely.

1645

<dd><p>When the option <code>-H</code> or <code>--historylog</code> is given (or set in

1646

the .nanorc file), text entered as search or replace strings is stored.

1647

These strings can be accessed with the up/down arrow keys. A retrieved

1648

string can subsequently be edited.

1645

1649

</p>

1646

1647

1650

</dd>

1648

1651

<dt><code>Writing, Appending, or Prepending Selected Text to Files</code></dt>

1649

1652

<dd><p>Text selected using the marking key (^^) can be written out, appended,

1653

1656

<dt><code>Toggles</code></dt>

1654

1657

<dd><p>Many options which alter the functionality of the program can be

1655

1658

"toggled" on or off using Meta key sequences, meaning the program does

1656

not have to be restarted to turn a particular feature of the editor on

1657

or off. Please see the internal help function (^G) for a list of what

1658

functions can be toggled for a particular version of <code>nano</code>. See

1659

See <a href="#Feature-Toggles">Feature Toggles</a>, for more info.

1660

</p>

1661

</dd>

1662

<dt><code>Cursor Position Display</code></dt>

1663

<dd><p>The output of the "Display Cursor Position" in <code>nano</code> displays

1664

the current line position of the cursor, as well as the column and

1665

total character position.

1666

</p>

1667

</dd>

1668

<dt><code>Interactive Replace and Spell Checker</code></dt>

1669

<dd><p>It is worth noting that <code>nano</code>’s replace function is interactive,

1670

i.e. it does not stop after one search string was found and automatically

1671

replaced. The <code>nano</code> implementation will pause at each found

1672

search string and query whether to replace this instance or not. The

1673

internal spell checker operates similarly. Note that there is no way to

1674

force these functions to behave in the Pico fashion. As of version

1675

1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in

1676

the internal spell checker such that the words ’apple’ and ’Apple’ will

1659

not have to be restarted to turn a particular feature on or off.

1660

See the internal help function (^G) for a list of features that

1661

can be toggled. Or see See <a href="#Feature-Toggles">Feature Toggles</a> instead.

1662

</p>

1663

</dd>

1664

<dt><code>Current Cursor Position</code></dt>

1665

<dd><p>The output of the "Display Cursor Position" command (^C) displays

1666

not only the current line and character position of the cursor,

1667

but also (between the two) the current column position.

1668

</p>

1669

</dd>

1670

<dt><code>Spell Checking</code></dt>

1671

<dd><p>In the internal spell checker misspelled words are sorted alphabetically

1672

and trimmed for uniqueness, such that the words ’apple’ and ’Apple’ will

1677

1673

be prompted for correction separately.

1678

</p></dd>

1674

</p>

1675

</dd>

1679

1676

</dl>

1680

1677

1681

1678

1686

1683

Previous: <a href="#Pico-Compatibility" accesskey="p" rel="prev">Pico Compatibility</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>   [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>

1687

1684

</div>

1688

1685

1689

<h2 class="chapter">8 Building and Configure Options</h2>

1686

<h2 class="chapter">10 Building and Configure Options</h2>

1690

1687

1691

1688

<p>Building <code>nano</code> from source is fairly straightforward if you are

1692

1689

familiar with compiling programs with autoconf support:

1709

1706

</dd>

1710

1707

<dt><code>--disable-color</code></dt>

1711

1708

<dd><p>Disable support for the syntax coloring of files. This also eliminates

1712

the -Y command-line option, which chooses a specific syntax.

1709

the <code>-Y</code> command-line option, which chooses a specific syntax.

1713

1710

</p>

1714

1711

</dd>

1715

1712

<dt><code>--disable-extra</code></dt>

1726

1723

<dt><code>--disable-histories</code></dt>

1727

1724

<dd><p>Disable the code for the handling of the history files: the search and

1728

1725

replace strings that were used, and the cursor position at which each

1729

file was closed. This also eliminates the -H and -P command-line

1730

options, which switch on the logging of search/replace strings and

1731

cursor positions.

1726

file was closed. This also eliminates the <code>-H</code> and <code>-P</code>

1727

command-line options, which switch on the logging of search/replace

1728

strings and cursor positions.

1732

1729

</p>

1733

1730

</dd>

1734

1731

<dt><code>--disable-justify</code></dt>

1737

1734

</dd>

1738

1735

<dt><code>--disable-libmagic</code></dt>

1739

1736

<dd><p>Disable the use of the library of magic-number tests (for determining

1740

the file type and thus which syntax to use for colouring – often the

1737

the file type and thus which syntax to use for colouring — often the

1741

1738

tests on filename extension and header line will be enough).

1742

1739

</p>

1743

1740

</dd>

1744

1741

<dt><code>--disable-mouse</code></dt>

1745

<dd><p>Disable all mouse functionality. This also eliminates the -m

1742

<dd><p>Disable all mouse functionality. This also eliminates the <code>-m</code>

1746

1743

command-line option, which enables the mouse functionality.

1747

1744

</p>

1748

1745

</dd>

1749

1746

<dt><code>--disable-multibuffer</code></dt>

1750

1747

<dd><p>Disable support for opening multiple files at a time and switching

1751

between them on the fly. This also eliminates the -F command-line

1752

option, which switches the use of multiple file buffers on.

1748

between them on the fly. This also eliminates the <code>-F</code> command-line

1749

option, which causes a file to be read into a separate buffer by default.

1753

1750

</p>

1754

1751

</dd>

1755

1752

<dt><code>--disable-nanorc</code></dt>

1757

1754

support, you can store custom settings in a system-wide and a per-user

1758

1755

nanorc file rather than having to pass command-line options to get

1759

1756

the desired behavior. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info.

1760

Disabling this also eliminates the -I and -q command-line options;

1761

the first inhibits the reading of nanorcfiles, and the second

1757

Disabling this also eliminates the <code>-I</code> and <code>-q</code> command-line

1758

options; the first inhibits the reading of nanorcfiles, and the second

1762

1759

suppresses warnings about errors in those files.

1763

1760

</p>

1764

1761

</dd>

1765

1762

<dt><code>--disable-operatingdir</code></dt>

1766

<dd><p>Disable setting the operating directory. This also eliminates the -o

1763

<dd><p>Disable setting the operating directory. This also eliminates the <code>-o</code>

1767

1764

command-line option, which sets the operating directory.

1768

1765

</p>

1769

1766

</dd>

1770

1767

<dt><code>--disable-speller</code></dt>

1771

<dd><p>Disable use of the spell checker. This also eliminates the -s

1768

<dd><p>Disable use of the spell checker. This also eliminates the <code>-s</code>

1772

1769

command-line option, which allows specifying an alternate spell checker.

1773

1770

</p>

1774

1771

</dd>

1777

1774

</p>

1778

1775

</dd>

1779

1776

<dt><code>--disable-wrapping</code></dt>

1780

<dd><p>Disable hard-wrapping of overlong lines. This also eliminates the -w

1777

<dd><p>Disable hard-wrapping of overlong lines. This also eliminates the <code>-w</code>

1781

1778

command-line option, which enables long-line wrapping.

1782

1779

</p>

1783

1780

</dd>

1785

1782

<dd><p>This option disables all the above. It also disables some of the larger

1786

1783

internals of the editor, like the marking code and the cut-to-end-of-line

1787

1784

code. It also disables the function toggles. By using the enabling

1788

counterpart of the above options together with –enable-tiny, specific

1789

features can be switched back on.

1785

counterpart of the above options together with <code>--enable-tiny</code>,

1786

specific features can be switched back on.

1790

1787

</p>

1791

1788

</dd>

1792

1789

<dt><code>--enable-debug</code></dt>

1828

1825

1829

1826

1830

1827

1831

<li><a name="toc-Introduction-1" href="#Introduction">1 Introduction</a>

1832

1833

<li><a name="toc-Overview-1" href="#Overview">1.1 Overview</a></li>

1834

<li><a name="toc-Command-Line-Options-1" href="#Command-Line-Options">1.2 Command Line Options</a></li>

1835

</ul></li>

1836

<li><a name="toc-Editor-Basics-1" href="#Editor-Basics">2 Editor Basics</a>

1837

1838

<li><a name="toc-Entering-Text-1" href="#Entering-Text">2.1 Entering Text</a></li>

1839

<li><a name="toc-Special-Functions-1" href="#Special-Functions">2.2 Special Functions</a></li>

1840

<li><a name="toc-The-Cutbuffer-1" href="#The-Cutbuffer">2.3 The Cutbuffer</a></li>

1841

1842

<li><a name="toc-The-Titlebar-1" href="#The-Titlebar">2.5 The Titlebar</a></li>

1843

<li><a name="toc-The-Statusbar-1" href="#The-Statusbar">2.6 The Statusbar</a></li>

1844

<li><a name="toc-Shortcut-Lists-1" href="#Shortcut-Lists">2.7 Shortcut Lists</a></li>

1845

<li><a name="toc-Using-the-Mouse-1" href="#Using-the-Mouse">2.8 Using the Mouse</a></li>

1846

</ul></li>

1847

<li><a name="toc-Built_002din-Help-1" href="#Built_002din-Help">3 Built-in Help</a></li>

1848

<li><a name="toc-Feature-Toggles-1" href="#Feature-Toggles">4 Feature Toggles</a></li>

1849

<li><a name="toc-Nanorc-Files-1" href="#Nanorc-Files">5 Nanorc Files</a>

1850

1851

<li><a name="toc-Settings-1" href="#Settings">5.1 Settings</a></li>

1852

<li><a name="toc-Syntax-Highlighting-1" href="#Syntax-Highlighting">5.2 Syntax Highlighting</a></li>

1853

<li><a name="toc-Rebinding-Keys-1" href="#Rebinding-Keys">5.3 Rebinding Keys</a></li>

1854

</ul></li>

1855

<li><a name="toc-The-File-Browser-1" href="#The-File-Browser">6 The File Browser</a></li>

1856

<li><a name="toc-Pico-Compatibility-1" href="#Pico-Compatibility">7 Pico Compatibility</a></li>

1857

<li><a name="toc-Building-and-Configure-Options-1" href="#Building-and-Configure-Options">8 Building and Configure Options</a></li>

1828

<li><a name="toc-Introduction-1" href="#Introduction">1 Introduction</a></li>

1829

<li><a name="toc-Invoking-1" href="#Invoking">2 Invoking</a></li>

1830

<li><a name="toc-Command_002dline-Options-1" href="#Command_002dline-Options">3 Command-line Options</a></li>

1831

<li><a name="toc-Editor-Basics-1" href="#Editor-Basics">4 Editor Basics</a>

1832

1833

<li><a name="toc-Entering-Text-1" href="#Entering-Text">4.1 Entering Text</a></li>

1834

<li><a name="toc-Special-Functions-1" href="#Special-Functions">4.2 Special Functions</a></li>

1835

<li><a name="toc-The-Cutbuffer-1" href="#The-Cutbuffer">4.3 The Cutbuffer</a></li>

1836

1837

<li><a name="toc-The-Titlebar-1" href="#The-Titlebar">4.5 The Titlebar</a></li>

1838

<li><a name="toc-The-Statusbar-1" href="#The-Statusbar">4.6 The Statusbar</a></li>

1839

<li><a name="toc-Shortcut-Lists-1" href="#Shortcut-Lists">4.7 Shortcut Lists</a></li>

1840

<li><a name="toc-Using-the-Mouse-1" href="#Using-the-Mouse">4.8 Using the Mouse</a></li>

1841

</ul></li>

1842

<li><a name="toc-Built_002din-Help-1" href="#Built_002din-Help">5 Built-in Help</a></li>

1843

<li><a name="toc-Feature-Toggles-1" href="#Feature-Toggles">6 Feature Toggles</a></li>

1844

<li><a name="toc-Nanorc-Files-1" href="#Nanorc-Files">7 Nanorc Files</a>

1845

1846

<li><a name="toc-Settings-1" href="#Settings">7.1 Settings</a></li>

1847

<li><a name="toc-Syntax-Highlighting-1" href="#Syntax-Highlighting">7.2 Syntax Highlighting</a></li>

1848

<li><a name="toc-Rebinding-Keys-1" href="#Rebinding-Keys">7.3 Rebinding Keys</a></li>

1849

</ul></li>

1850

<li><a name="toc-The-File-Browser-1" href="#The-File-Browser">8 The File Browser</a></li>

1851

<li><a name="toc-Pico-Compatibility-1" href="#Pico-Compatibility">9 Pico Compatibility</a></li>

1852

<li><a name="toc-Building-and-Configure-Options-1" href="#Building-and-Configure-Options">10 Building and Configure Options</a></li>

1858

1853

</ul>

1859

1854

</div>

1860

1855