Difference between revisions of "Nano"
m (fix introduction) |
Kynikos.bot (talk | contribs) (wikify some external links, use https for archlinux.org) |
||
(11 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | [[Category:Text editors | + | [[Category:Text editors]] |
− | {{ | + | [[de:Nano]] |
+ | [[it:Nano]] | ||
+ | {{Lowercase title}} | ||
− | [http://www.nano-editor.org/ GNU nano] (or nano) is a text editor which aims to introduce a simple interface and intuitive command options to console based text editing. nano is the default console editor in distributions such as | + | [http://www.nano-editor.org/ GNU nano] (or nano) is a text editor which aims to introduce a simple interface and intuitive command options to console based text editing. nano is the default console editor in distributions such as Ubuntu and supports features including colorized syntax highlighting, DOS/Mac file type conversions, spellchecking and [[Wikipedia:UTF-8|UTF-8]] encoding. nano opened with an empty buffer typically occupies under 1.5 MB of resident memory. [http://i275.photobucket.com/albums/jj281/adamchrista/Arch%20Linux/Wiki%20Examples/nano-man.png nano Screenshot]. |
== Package Installation == | == Package Installation == | ||
− | {{ | + | {{Pkg|nano}} is part of the [[Official Repositories|Arch Linux [core] repository]], usually installed by default by AIF. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Configuration == | == Configuration == | ||
Line 44: | Line 23: | ||
{{Note|Command-line arguments override and take precedence over the configuration commands established in .nanorc|}} | {{Note|Command-line arguments override and take precedence over the configuration commands established in .nanorc|}} | ||
− | ====Nano syntax highlight for PKGBUILD==== | + | ==== Nano syntax highlight for PKGBUILD ==== |
− | + | This new version highlights like the ArchLinux [https://projects.archlinux.org/svntogit/packages.git/tree "svntogit-server"]. | |
− | This new version highlights like the ArchLinux [ | ||
# Arch PKGBUILD files | # Arch PKGBUILD files | ||
# | # | ||
Line 68: | Line 46: | ||
color brightblack "#.*$" | color brightblack "#.*$" | ||
− | This is another version from this [ | + | This is another version from this [https://bbs.archlinux.org/viewtopic.php?pid=565476 forumthread]. |
## Arch PKGBUILD files | ## Arch PKGBUILD files | ||
Line 96: | Line 74: | ||
To use, save as /usr/share/nano/pkgbuild.nanorc and add: | To use, save as /usr/share/nano/pkgbuild.nanorc and add: | ||
include "/usr/share/nano/pkgbuild.nanorc" | include "/usr/share/nano/pkgbuild.nanorc" | ||
− | to your ~/.nanorc | + | to your {{Ic|~/.nanorc}} |
− | or to /etc/nanorc | + | or to {{Ic|/etc/nanorc}}. |
=== Suggested Configuration === | === Suggested Configuration === | ||
==== Suspension ==== | ==== Suspension ==== | ||
− | Unlike most interactive programs, suspension is not enabled by default. To change this, uncomment the 'set suspend' line in | + | Unlike most interactive programs, suspension is not enabled by default. To change this, uncomment the 'set suspend' line in {{Ic|/etc/nanorc}}. This will allow you to use the keys {{Keypress|Ctrl+z}} to send nano to the background. |
==== Do not wrap text ==== | ==== Do not wrap text ==== | ||
Line 112: | Line 90: | ||
== nano Usage == | == nano Usage == | ||
=== Special Functions === | === Special Functions === | ||
− | * {{ | + | * {{Keypress|Ctrl}} key modified shortcuts ({{Ic|^}}) representing commonly used functions are listed along the bottom two lines of the nano screen. |
− | * Additional functions can be interactively toggled by way of {{Ic|Meta}} (typically {{ | + | * Additional functions can be interactively toggled by way of {{Ic|Meta}} (typically {{Keypress|Alt}}) and/or {{Keypress|Esc}} key modified sequences. |
==== Shortcut Lists Overview ==== | ==== Shortcut Lists Overview ==== | ||
− | * {{Ic|^G Get Help}} ({{ | + | * {{Ic|^G Get Help}} ({{Keypress|F1}}) |
: Displays the online help files within the session window. A suggested read for nano users of all levels | : Displays the online help files within the session window. A suggested read for nano users of all levels | ||
− | * {{Ic|^O WriteOut}} ({{ | + | * {{Ic|^O WriteOut}} ({{Keypress|F3}}) |
: Save the contents of the current file buffer to a file on the disk | : Save the contents of the current file buffer to a file on the disk | ||
− | * {{Ic|^R Read File}} ({{ | + | * {{Ic|^R Read File}} ({{Keypress|F5}}) |
: Inserts another file into the current one at the cursor location | : Inserts another file into the current one at the cursor location | ||
− | * {{Ic|^Y Prev Page}} ({{ | + | * {{Ic|^Y Prev Page}} ({{Keypress|F7}}) |
: Display the previous buffered screen | : Display the previous buffered screen | ||
− | * {{Ic|^K Cut Text}} ({{ | + | * {{Ic|^K Cut Text}} ({{Keypress|F9}}) |
: Cut and store the current line from the beginning of the line to the end of the line | : Cut and store the current line from the beginning of the line to the end of the line | ||
− | * {{Ic|^C Cur Pos}} ({{ | + | * {{Ic|^C Cur Pos}} ({{Keypress|F11}}) |
: Display line, column and character position information at the current location of the cursor | : Display line, column and character position information at the current location of the cursor | ||
− | * {{Ic|^X Exit}} ({{ | + | * {{Ic|^X Exit}} ({{Keypress|F2}}) |
: Close and exit nano | : Close and exit nano | ||
− | * {{Ic|^J Justify}} ({{ | + | * {{Ic|^J Justify}} ({{Keypress|F4}}) |
: Aligns text according to the geometry of the console window | : Aligns text according to the geometry of the console window | ||
− | * {{Ic|^W Where}} ({{ | + | * {{Ic|^W Where}} ({{Keypress|F6}}) |
: Perform a case-insensitive string, or regular expression search | : Perform a case-insensitive string, or regular expression search | ||
− | * {{Ic|^V Next Page}} ({{ | + | * {{Ic|^V Next Page}} ({{Keypress|F8}}) |
: Display the next buffered screen | : Display the next buffered screen | ||
− | * {{Ic|^U UnCut Text}} ({{ | + | * {{Ic|^U UnCut Text}} ({{Keypress|F10}}) |
: Paste the contents of the cut buffer to the current cursor location | : Paste the contents of the cut buffer to the current cursor location | ||
− | * {{Ic|^T To Spell}} ({{ | + | * {{Ic|^T To Spell}} ({{Keypress|F12}}) |
: Spellcheck the contents of the buffer with the built-in {{Ic|spell}}, if available | : Spellcheck the contents of the buffer with the built-in {{Ic|spell}}, if available | ||
− | {{Tip|See the nano online help files via | + | {{Tip|See the nano online help files via {{Keypress|Ctrl+g}} within nano and the [http://www.nano-editor.org/dist/v2.1/nano.html nano Command Manual] for complete descriptions and additional support.|}} |
==== Selected Toggle Functions ==== | ==== Selected Toggle Functions ==== | ||
− | * {{Ic|Meta+c}} (or {{ | + | * {{Ic|Meta+c}} (or {{Keypress|Esc+c}}) |
: Toggles support for line, column and character position information. | : Toggles support for line, column and character position information. | ||
− | * {{Ic|Meta+i}} (or {{ | + | * {{Ic|Meta+i}} (or {{Keypress|Esc+i}}) |
: Toggles support for the auto indentation of lines | : Toggles support for the auto indentation of lines | ||
− | * {{Ic|Meta+k}} (or {{ | + | * {{Ic|Meta+k}} (or {{Keypress|Esc+k}}) |
: Toggles support for cutting text from the current cursor position to the end of the line | : Toggles support for cutting text from the current cursor position to the end of the line | ||
− | * {{Ic|Meta+m}} (or {{ | + | * {{Ic|Meta+m}} (or {{Keypress|Esc+m}}) |
: Toggles mouse support for cursor placement, marking and shortcut execution | : Toggles mouse support for cursor placement, marking and shortcut execution | ||
− | * {{Ic|Meta+x}} (or {{ | + | * {{Ic|Meta+x}} (or {{Keypress|Esc+x}}) |
: Toggles the display of the shortcut list at the bottom of the nano screen for additional screen space | : Toggles the display of the shortcut list at the bottom of the nano screen for additional screen space | ||
Line 162: | Line 140: | ||
== Tips & Tricks == | == Tips & Tricks == | ||
− | + | === Replacing vi with nano === | |
− | === Replacing | + | Casual users may prefer the use of {{Ic|nano}} over {{Ic|vi}} for its simplicity and ease of use and may opt to replace vi with nano as the default text editor for commands such as '''visudo'''. |
− | |||
− | Casual users may prefer the use of {{Ic|nano}} over {{Ic|vi}} for its simplicity and ease of use and may opt to replace vi with nano as the default text editor for commands such as | ||
==== Method One ==== | ==== Method One ==== | ||
{{Warning|From {{Ic|man 8 visudo}}: ''Note that this can be a security hole since it allows the user to execute any program they wish simply by setting VISUAL or EDITOR.''}} | {{Warning|From {{Ic|man 8 visudo}}: ''Note that this can be a security hole since it allows the user to execute any program they wish simply by setting VISUAL or EDITOR.''}} | ||
− | [[Sudo|sudo]] from the core repository is compiled with | + | [[Sudo|sudo]] from the core repository is compiled with {{Ic|--with-env-editor}} by default and honors the use of the {{Ic|VISUAL}} and {{Ic|EDITOR}} variables. To establish nano as the '''visudo''' editor for the duration of the current shell session, set and export the {{Ic|EDITOR}} variable before calling '''visudo'''. |
export EDITOR=nano | export EDITOR=nano | ||
===== Example Usage ===== | ===== Example Usage ===== | ||
− | |||
export EDITOR=nano && sudo visudo | export EDITOR=nano && sudo visudo | ||
Line 188: | Line 163: | ||
===== Example .bash_profile ===== | ===== Example .bash_profile ===== | ||
− | + | {{Bc|. $HOME/.bashrc| | |
− | |||
export EDITOR=nano | export EDITOR=nano | ||
Line 197: | Line 171: | ||
startx | startx | ||
logout | logout | ||
− | fi | + | fi |
+ | }} | ||
==== Method Three ==== | ==== Method Three ==== | ||
Line 203: | Line 178: | ||
===== Symbolic Linking ===== | ===== Symbolic Linking ===== | ||
− | As root, or with | + | As root, or with {{Ic|su -}} |
− | + | Rename the {{Ic|vi}} executable to {{Ic|vi.old}} for ease of restoration: | |
− | + | # mv /usr/bin/vi /usr/bin/vi.old | |
− | + | Create a symbolic link from {{Ic|/usr/bin/nano}} to {{Ic|/usr/bin/vi}} | |
+ | # ln -s /usr/bin/nano /usr/bin/vi | ||
− | + | Assuming sudo is installed and properly configured. You will need to add {{Ic|vi}} to the {{ic|IgnorePkg}} list in {{ic|pacman.conf}} to make this permanent. Otherwise it will revert back to {{Ic|vi}} the next time it is updated. | |
− | |||
− | ===== | + | ===== Restoration of vi ===== |
− | + | Remove the {{Ic|/usr/bin/vi}} symbolic link: | |
− | + | unlink /usr/bin/vi | |
− | |||
− | |||
− | + | Rename the {{Ic|vi.old}} executable back to {{Ic|vi}}: | |
− | |||
− | |||
mv /usr/bin/vi.old /usr/bin/vi | mv /usr/bin/vi.old /usr/bin/vi | ||
− | |||
==== Method Four ==== | ==== Method Four ==== | ||
Line 229: | Line 199: | ||
===== Removal & Symbolic Linking ===== | ===== Removal & Symbolic Linking ===== | ||
+ | Use [[Pacman|pacman]] to remove the {{Ic|vi}} package, its configuration, and all unneeded dependencies: | ||
pacman -Rns vi | pacman -Rns vi | ||
− | |||
− | + | Create a symbolic link from {{Ic|/usr/bin/nano}} to {{Ic|/usr/bin/vi}}: | |
− | |||
− | |||
ln -s /usr/bin/nano /usr/bin/vi | ln -s /usr/bin/nano /usr/bin/vi | ||
− | |||
− | ===== Restoration of {{Ic|vi}} | + | ===== Restoration of vi ===== |
+ | Remove the {{Ic|/usr/bin/vi}} symbolic link: | ||
unlink /usr/bin/vi | unlink /usr/bin/vi | ||
− | + | ||
− | + | Use pacman to install the previously deinstallled {{Ic|vi}} package: | |
− | + | pacman -S vi | |
{{Box Note|Do not clean {{Ic|-c}} or refresh {{Ic|-y}} the package database if you wish to retain the previously installed version of the {{Ic|vi}} package.<br>If this case, subsequent updates will also require the judicious use of the {{Ic|--ignore vi}} switch (and optionally {{Ic|--ignore glibc ncurses coreutils}}).|}} | {{Box Note|Do not clean {{Ic|-c}} or refresh {{Ic|-y}} the package database if you wish to retain the previously installed version of the {{Ic|vi}} package.<br>If this case, subsequent updates will also require the judicious use of the {{Ic|--ignore vi}} switch (and optionally {{Ic|--ignore glibc ncurses coreutils}}).|}} | ||
== Additional Resources == | == Additional Resources == | ||
− | * [ | + | * [[wikipedia:Nano_(text_editor)|nano (text editor)]] - Wikipedia Entry |
* [http://www.nano-editor.org/ GNU nano Homepage] - Official Site | * [http://www.nano-editor.org/ GNU nano Homepage] - Official Site | ||
* [https://savannah.gnu.org/bugs/?group=nano GNU nano Bugs] Bug Reporting | * [https://savannah.gnu.org/bugs/?group=nano GNU nano Bugs] Bug Reporting | ||
+ | * [https://github.com/craigbarnes/nanorc Better syntax highlighting definitions] |
Revision as of 16:09, 4 December 2012
GNU nano (or nano) is a text editor which aims to introduce a simple interface and intuitive command options to console based text editing. nano is the default console editor in distributions such as Ubuntu and supports features including colorized syntax highlighting, DOS/Mac file type conversions, spellchecking and UTF-8 encoding. nano opened with an empty buffer typically occupies under 1.5 MB of resident memory. nano Screenshot.
Package Installation
nano is part of the Arch Linux [core] repository, usually installed by default by AIF.
Configuration
Creating ~/.nanorc
The look, feel and function of nano is typically controlled by way of either command-line arguments, or configuration commands within the file ~/.nanorc
.
A sample configuration file is installed upon program installation and is located at /etc/nanorc
.The file ~/.nanorc
must be first created by the user:
$ cd ~ $ touch .nanorc
or
$ cp /etc/nanorc ~/.nanorc
Proceed to establish the nano console environment by setting and/or unsetting commands within .nanorc
file.
Nano syntax highlight for PKGBUILD
This new version highlights like the ArchLinux "svntogit-server".
# Arch PKGBUILD files # syntax "pkgbuild" "^.*PKGBUILD*" # commands color red "\<(cd|echo|enable|exec|export|kill|popd|pushd|read|source|touch|type)\>" color brightblack "\<(case|cat|chmod|chown|cp|diff|do|done|elif|else|esac|exit|fi|find|for|ftp|function|grep|gzip|if|in)\>" color brightblack "\<(install|ln|local|make|mv|patch|return|rm|sed|select|shift|sleep|tar|then|time|until|while|yes)\>" # ${*} icolor blue "\$\{?[0-9A-Z_!@#$*?-]+\}?" # numerics color blue "\ [0-9]*" color blue "\.[0-9]*" color blue "\-[0-9]*" color blue "=[0-9]" # spaces color ,green "[[:space:]]+$" # strings; multilines are not supported color brightred ""(\\.|[^"])*"" "'(\\.|[^'])*'" # comments color brightblack "#.*$"
This is another version from this forumthread.
## Arch PKGBUILD files ## syntax "pkgbuild" "^.*PKGBUILD$" color green start="^." end="$" color cyan "^.*(pkgbase|pkgname|pkgver|pkgrel|pkgdesc|arch|url|license).*=.*$" color brightcyan "\<(pkgbase|pkgname|pkgver|pkgrel|pkgdesc|arch|url|license)\>" color brightcyan "(\$|\$\{|\$\()(pkgbase|pkgname|pkgver|pkgrel|pkgdesc|arch|url|license)(|\}|\))" color cyan "^.*(depends|makedepends|optdepends|conflicts|provides|replaces).*=.*$" color brightcyan "\<(depends|makedepends|optdepends|conflicts|provides|replaces)\>" color brightcyan "(\$|\$\{|\$\()(depends|makedepends|optdepends|conflicts|provides|replaces)(|\}|\))" color cyan "^.*(groups|backup|noextract|options).*=.*$" color brightcyan "\<(groups|backup|noextract|options)\>" color brightcyan "(\$|\$\{|\$\()(groups|backup|noextract|options)(|\}|\))" color cyan "^.*(install|source|md5sums|sha1sums|sha256sums|sha384sums|sha512sums).*=.*$" color brightcyan "\<(install|source|md5sums|sha1sums|sha256sums|sha384sums|sha512sums)\>" color brightcyan "(\$|\$\{|\$\()(install|source|md5sums|sha1sums|sha256sums|sha384sums|sha512sums)(|\}|\))" color brightcyan "\<(startdir|srcdir|pkgdir)\>" color cyan "\.install" color brightwhite "=" "'" "\(" "\)" "\"" "#.*$" "\," "\{" "\}" color brightred "build\(\)" color brightred "package_.*.*$" color brightred "\<(configure|make|cmake|scons)\>" color red "\<(DESTDIR|PREFIX|prefix|sysconfdir|datadir|libdir|includedir|mandir|infodir)\>"
To use, save as /usr/share/nano/pkgbuild.nanorc and add:
include "/usr/share/nano/pkgbuild.nanorc"
to your ~/.nanorc
or to /etc/nanorc
.
Suggested Configuration
Suspension
Unlike most interactive programs, suspension is not enabled by default. To change this, uncomment the 'set suspend' line in /etc/nanorc
. This will allow you to use the keys Template:Keypress to send nano to the background.
Do not wrap text
If you are coming from another distribution, you might wonder about nano's strange behaviour, so just edit /etc/nanorc like this:
## Do not wrap text at all. set nowrap
nano Usage
Special Functions
- Template:Keypress key modified shortcuts (
^
) representing commonly used functions are listed along the bottom two lines of the nano screen. - Additional functions can be interactively toggled by way of
Meta
(typically Template:Keypress) and/or Template:Keypress key modified sequences.
Shortcut Lists Overview
-
^G Get Help
(Template:Keypress)
- Displays the online help files within the session window. A suggested read for nano users of all levels
-
^O WriteOut
(Template:Keypress)
- Save the contents of the current file buffer to a file on the disk
-
^R Read File
(Template:Keypress)
- Inserts another file into the current one at the cursor location
-
^Y Prev Page
(Template:Keypress)
- Display the previous buffered screen
-
^K Cut Text
(Template:Keypress)
- Cut and store the current line from the beginning of the line to the end of the line
-
^C Cur Pos
(Template:Keypress)
- Display line, column and character position information at the current location of the cursor
-
^X Exit
(Template:Keypress)
- Close and exit nano
-
^J Justify
(Template:Keypress)
- Aligns text according to the geometry of the console window
-
^W Where
(Template:Keypress)
- Perform a case-insensitive string, or regular expression search
-
^V Next Page
(Template:Keypress)
- Display the next buffered screen
-
^U UnCut Text
(Template:Keypress)
- Paste the contents of the cut buffer to the current cursor location
-
^T To Spell
(Template:Keypress)
- Spellcheck the contents of the buffer with the built-in
spell
, if available
Selected Toggle Functions
-
Meta+c
(or Template:Keypress)
- Toggles support for line, column and character position information.
-
Meta+i
(or Template:Keypress)
- Toggles support for the auto indentation of lines
-
Meta+k
(or Template:Keypress)
- Toggles support for cutting text from the current cursor position to the end of the line
-
Meta+m
(or Template:Keypress)
- Toggles mouse support for cursor placement, marking and shortcut execution
-
Meta+x
(or Template:Keypress)
- Toggles the display of the shortcut list at the bottom of the nano screen for additional screen space
Tips & Tricks
Replacing vi with nano
Casual users may prefer the use of nano
over vi
for its simplicity and ease of use and may opt to replace vi with nano as the default text editor for commands such as visudo.
Method One
man 8 visudo
: Note that this can be a security hole since it allows the user to execute any program they wish simply by setting VISUAL or EDITOR.sudo from the core repository is compiled with --with-env-editor
by default and honors the use of the VISUAL
and EDITOR
variables. To establish nano as the visudo editor for the duration of the current shell session, set and export the EDITOR
variable before calling visudo.
export EDITOR=nano
Example Usage
export EDITOR=nano && sudo visudo
Method Two
man 8 visudo
: Note that this can be a security hole since it allows the user to execute any program they wish simply by setting VISUAL or EDITOR.The EDITOR variable can also be set within the following files for persistent use:
- ~/.bash_profile (login shell)
- ~/.bashrc (interactive, non-login shell)
- /etc/profile (global settings for all system users except
root
)
Example .bash_profile
. $HOME/.bashrc
Method Three
Symbolic Linking
As root, or with su -
Rename the vi
executable to vi.old
for ease of restoration:
# mv /usr/bin/vi /usr/bin/vi.old
Create a symbolic link from /usr/bin/nano
to /usr/bin/vi
# ln -s /usr/bin/nano /usr/bin/vi
Assuming sudo is installed and properly configured. You will need to add vi
to the IgnorePkg
list in pacman.conf
to make this permanent. Otherwise it will revert back to vi
the next time it is updated.
Restoration of vi
Remove the /usr/bin/vi
symbolic link:
unlink /usr/bin/vi
Rename the vi.old
executable back to vi
:
mv /usr/bin/vi.old /usr/bin/vi
Method Four
Removal & Symbolic Linking
Use pacman to remove the vi
package, its configuration, and all unneeded dependencies:
pacman -Rns vi
Create a symbolic link from /usr/bin/nano
to /usr/bin/vi
:
ln -s /usr/bin/nano /usr/bin/vi
Restoration of vi
Remove the /usr/bin/vi
symbolic link:
unlink /usr/bin/vi
Use pacman to install the previously deinstallled vi
package:
pacman -S vi
Additional Resources
- nano (text editor) - Wikipedia Entry
- GNU nano Homepage - Official Site
- GNU nano Bugs Bug Reporting
- Better syntax highlighting definitions