# The nano FAQ

## Table of Contents

## 1. General

> 1.1 About this FAQ
> 1.2. How do I contribute to it?
> 1.3. What is GNU nano?
> 1.4. What is the history behind nano?
> 1.5. Why the name change from TIP?
> 1.6. What is the current version of nano?
> 1.7. I want to read the manpage without having to download the program!

## 2. Where to get GNU nano.

> 2.1. FTP and WWW sites that carry nano.
> 2.2. RedHat and derivatives (.rpm) packages.
> 2.3. Debian (.deb) packages.
> 2.4. By CVS (for the brave).

## 3. Installation and Configuration

> 3.1. How do I install the RPM or DEB package?
> 3.2. Compiling from source: WHAT THE HECK DO I DO NOW?
> 3.3. Why does everything go into /usr/local?
> 3.4. I get errors about 'bindtextdomain','gettext' and/or 'gettextdomain'. What can I do about it?
> 3.5. Nano should automatically run strip on the binary when installing it!
> 3.6. How can I make the executable smaller? This is too bloated!
> 3.7. Tell me more about this multibuffer stuff!
> 3.8. How do I make a .nanorc file that nano will read when I start it?

## 4. Running

> 4.1. Ack! My backspace/delete/enter/double bucky/meta key doesn't seem to work! What can I do?
> 4.2. Nano crashes when I type <insert keystroke here>!
> 4.3. Nano crashes when I resize my window. How can I fix that?
> 4.4. [version 1.1.12 and earlier] Why does nano show ^\ in the shortcut list instead of ^J?
> 4.5a. [version 1.1.12 and earlier] When I type in a search string, the string I last searched for is already in front of my cursor! What happened?!
> 4.5b. [version 1.2.4 and later] Hey, the search string behavior has reverted, it's now like Pico, what happened to the consistency?
> 4.6. I get the message "NumLock glitch detected. Keypad will malfunction with NumLock off." What gives?
> 4.7. How do I make nano my default editor (in Pine, mutt, etc.)?
> 4.8. I've compiled nano with color support, but I don't see any color when I run it!

## 5. Internationalization

> 5.1. There's no translation for my language!
> 5.2. I don't like the translation for <x> in my language. How can I fix it?

## 6. Advocacy and Licensing

> 6.1. Why should I use nano instead of Pico?
> 6.2. Why should I use Pico instead of nano?
> 6.3. What is so bad about the Pine license?
> 6.4. Okay, well what mail program should I use then?
> 6.5. Why doesn't UW simply change their license?
> 6.6. What if tomorrow UW changes the license to be truly Free Software?

## 7. Miscellaneous

> 7.1. Nano related mailing lists.
> 7.2. I want to send the development team a big load of cash (or just a thank you).
> 7.3. How do I submit a patch?
> 7.4. How do I join the development team?
> 7.5. Can I have CVS write access?

## 8. ChangeLog

# 1. General

## 1.1 About this FAQ

> This FAQ was written and is maintained by Chris Allegretta <chrisa@asty.org>, who also happens to be the creator of nano. Maybe someone else will volunteer to maintain this FAQ someday, who knows...

## 1.2. How do I contribute to it?

> Your best bet is to send it to the nano email address, nano@nano-editor.org and if it is useful enough it will be included in future versions.

## 1.3. What is GNU nano?

> GNU nano is designed to be a free replacement for the Pico text editor, part of the Pine email suite from The University of Washington. It aims to "emulate Pico as closely as possible and perhaps include extra functionality".

## 1.4. What is the history behind nano?

> Funny you should ask!

> In the beginning...

> For years Pine was THE program used to read email on a Unix system. The Pico text editor is the portion of the program one would use to compose his or her mail messages. Many beginners to Unix flocked to Pico and Pine because of their well organized, easy to use interfaces. With the proliferation of GNU/Linux in the mid to late 90's, many University students became intimately familiar with the strengths (and weaknesses) of Pine and Pico.

> Then came Debian...

> The Debian GNU/Linux distribution, known for its strict standards in distributing truly "free" software (i.e. software with no restrictions on redistribution), would not include a binary package for Pine or Pico. Many people had a serious dilemma: they loved these programs, but they were not truly free software in the GNU sense of the word.

> The event...

> It was in late 1999 when Chris Allegretta (our hero) was yet again complaining to himself about the less-than-perfect license Pico was distributed under, the 1000 makefiles that came with it and how just a few small improvements could make it the Best Editor in the World (TM). Having been a convert from Slackware to Debian, he missed having a simple binary package that included Pine and Pico, and had grown tired of downloading them himself.

> Finally something snapped inside and Chris coded and hacked like a madman for many hours straight one weekend to make a (barely usable) Pico clone, at the time called TIP (Tip Isn't Pico). The program could not be invoked without a filename, could not save files, had no help menu, spell checker, and so forth. But over time it improved, and with the help of a few great coders it matured to the (hopefully) stable state it is today.

> In February 2001, nano was declared an official GNU program by Richard Stallman. Nano also reached its first production release on March 22, 2001.

## 1.5. Why the name change from TIP?

> On January 10, 2000, TIP was officially renamed to nano because of a namespace conflict with another program called 'tip'. The original 'tip' program "establishes a full duplex terminal connection to a remote host", and was included with many older Unix systems (and newer ones like Solaris). The conflict was not noticed at first because there is no 'tip' utility included with most GNU/Linux distributions (where nano was developed).

## 1.6. What is the current version of nano?

> The current version of nano *should* be 1.2.4. Of course you should always check the nano homepage to see what the latest and greatest version is.

## 1.7. I want to read the man page without having to download the program!

> Jeez, demanding, aren't we? Okay, look here.

# 2. Where to get GNU nano.

## 2.1. FTP and WWW sites that carry nano.

> The nano distribution can be downloaded at the following fine web and ftp sites:

> - http://www.nano-editor.org/dist/
> - http://www.ewtoo.org/~astyanax/nano/dist/
> - ftp://ftp.gnu.org/pub/gnu/nano/

## 2.2. RedHat and derivatives (.rpm) packages.

> - http://www.nano-editor.org/dist/v1.2/RPMS/
> - http://www.ewtoo.org/~astyanax/nano/dist/v1.2/RPMS/

> Additionally, check out the RedHat contribs section at:

> - http://distro.ibiblio.org/pub/Linux/distributions/redhat/contrib/libc6/i386/
> - ftp://distro.ibiblio.org/pub/Linux/distributions/redhat/contrib/libc6/i386/

## 2.3. Debian (.deb) packages.

> Debian users can check out the current nano packages for:

> - stable
> - testing
> - unstable

> You can also have a look at the Package Pool to see all the available binary and source packages.

> Note that versions < 0.9.10 are probably not for those wanting to get serious work done, so if you are using Debian 2.2, check that you have updated to 2.2r3, which comes with nano 0.9.23. If you're tracking unstable, you probably have the newest version already.

## 2.4. By CVS (for the brave).

> For the 'bleeding edge' current version of nano, you can use CVS to download the current source code. Note: believe it or not, by downloading code that has not yet stabilized into an official release, there could quite possibly be bugs, in fact the code may not even compile! Anyway, see the nano CVS page for info on anonymous CVS access to the nano source.

# 3. Installation and Configuration

## 3.1. How do install the RPM or DEB package?

> It's simple really! As root, type rpm -Uvh nano-x.y.z-1.i386.rpm if you have a RedHat-ish system or dpkg -i nano_x.y.z-1.deb if you have a Debian-ish system, where x.y.z is the release of nano. There are other programs to install packages, and if you wish to use those, knock yourself out.

## 3.2. Compiling from source: WHAT THE HECK DO I DO NOW?

> Okay, take a deep breath, this really isn't hard. Unpack the nano source with a command like:

> tar -zxvf nano-x.y.z.tar.gz

> If you get error messages about the -z option, try this:

> gzip -dc nano-x.y.z.tar.gz | tar xvf -

> (again, where x.y.z is the version number in question). Then you need to run configure with any options you might want (if any).

> The average case is this:

> cd nano-x.y.z/
> ./configure
> make
> make install (as root, of course)

## 3.3. Why does everything go into /usr/local?

> Well, that's what the configure script defaults to. If you wish to change this, simply do this:

> ./configure --prefix=/usr

> to put nano into /usr/bin when you run make install.

## 3.4. I get errors about 'bindtextdomain', 'gettext' and/or 'gettextdomain'. What can I do about it?

> Try doing a ./configure --with-included-gettext and see if that solves your problem. You may need to do a make clean; make to get it to work fully.

## 3.5. Nano should automatically run strip on the binary when installing it!

> Actually, it does, but you have to use make install-strip. The default make install does not, and will not, run strip automatically.

## 3.6. How can I make the executable smaller? This is too bloated!

> Actually, there are several parts of the editor that can be disabled. You can pass arguments to the configure script that disable certain features. Here's a brief list:

>       --disable-tabcomp       Disables tab completion code for a smaller binary
>       --disable-justify       Disable justify/unjustify function
>       --disable-speller       Disables spell checker function
>       --disable-help          Disables help function (^G)
>       --disable-browser       Disables mini file browser
>       --disable-wrapping      Disables all wrapping of text (and -w flag)
>       --disable-mouse         Disables mouse support (and -m flag)
>       --disable-operatingdir  Disable setting of operating directory

> There's also the --enable-tiny option which disables everything above, as well as some larger chunks of the program (like the marker code that you use Control-^ to select with). Also, if you know you aren't going to be using other languages you can use --disable-nls to disable internationalization and save a few K to a few dozen K depending on if you have locale support on your system. And finally there's always good old strip to strip all debugging code and code that exists in libraries on your system.

> If, on the other hand, you can't live without bells and whistles, you could try:

>       --enable-extra          Enable extra functions, including easter eggs
>       --enable-nanorc         Enable use of .nanorc file
>       --enable-color          Enables color and syntax highlighting
>       --enable-multibuffer    Enables having multiple file buffers open
>       --enable-all            Enables all of the above features

## 3.7. Tell me more about this multibuffer stuff!

> To use multiple file buffers, you must be using nano 1.1.12 or newer, and you must have configured nano with --enable-multibuffer or --enable-extra (use nano -V to check). Then when you want to enable inserting a file into its own buffer instead of into the current file, just hit Meta-F, then insert the file as normal with ^R. If you always want files to be loaded into their own buffers, use the --multibuffer or -F flag when you invoke nano.

> You can move between the buffers you have open with the Meta-< and Meta-> keys, or more easily with Meta-, and Meta-. (clear as mud, right? =-). When you have more than one file buffer open, the ^X shortcut will say "Close", instead of the normal "Exit" when only one buffer is open.

## 3.8. How do I make a .nanorc file that nano will read when I start it?

> It's not hard at all! But, your version of nano must have been compiled with --enable-nanorc, and again must be version 1.1.12 or newer (use nano -V to check your version and compiled features). Then simply copy the nanorc.sample that came with the nano source or your nano package (most likely in /usr/doc/nano) to .nanorc in your home directory. If you didn't get one, the syntax is simple. Flags are turned on and off by using the word set and the getopt_long flag for the feature, for example "set pico" or "set nowrap".

# 4. Running

## 4.1. Ack! My backspace/delete/enter/double bucky/meta key doesn't seem to work! What can I do?

> Try setting your $TERM variable to 'vt100'. Nano doesn't yet support every term entry under the sun.

> Bourne shell users (like bash): export TERM=vt100
> C Shell users (tcsh and csh): setenv TERM vt100

## 4.2. Nano crashes when I type <insert keystroke here>!

> If you aren't trying some bizarre keystroke combination with some bizarre $TERM entry, chances are you have found a bug. You are welcome to submit it to the nano-devel list or to nano@nano-editor.org.

## 4.3. Nano crashes when I resize my window. How can I fix that?

> Older versions of nano had this problem, please upgrade to a newer version (at least 0.9.9 would be great, 0.9.12 is recommended).

## 4.4. [version 1.1.12 and earlier] Why does nano show ^\ in the shortcut list instead of ^J?

> The help (^G) and justify (^J) function were among the last to be written. To show the improvements that nano had over Pico (go to line # and replace), ^_ and ^\ were put on the shortcut list. Later, ^G came back in place of ^_ as it proved to be very valuable for new Unix users. If you use the -p option to nano (or hit Meta-P) you will get the same shortcuts at the bottom as Pico.

## 4.5a. [version 1.1.12 and earlier] When I type in a search string, the string I last searched for is already in front of my cursor! What happened?!

> In nano version 0.9.20, the default is to have a completely consistent user interface across all user input functions. This means that regardless of whether you're being asked for a filename to insert or write, or a string to search for, the previous value is already inserted before the cursor. If you prefer the old behavior, use the Pico emulation mode (-p or --pico) or just hit Meta-P while in nano (see the ^G help text for more details).

## 4.5b. [version 1.2.4 and later] Hey, the search string behavior has reverted, it's now like Pico, what happened to the consistency?

> It was decided that consistency was nice, but people are used to Pico's inconsistent behavior. Also, in version 1.1.99pre1, search and replace history was introduced. If you wish to edit your previous search/replace entry (or any previous entry), you can do so by hitting the up arrow to cycle through your history. This method allows the best of both worlds: You don't need to erase the previous string if you want to enter a new one, but you can with one keystroke recall previous entries for editing. Therefore there is now no "Pico mode", nano is and has always been a Pico clone, and clones by default should be compatible.

## 4.6. I get the message "NumLock glitch detected. Keypad will malfunction with NumLock off." What gives?

> Nano (and actually almost all console editors) has issues when cycling the NumLock key in certain X terminals (rxvt, aterm, wterm, etc...). When you switch NumLock from on to off, you put the terminal into an "application mode" that changes what sequences are sent by the keypad. These sequences vary sufficiently from terminal to terminal that it is nearly impossible to work around them from within nano.

> In a nutshell, if you want to be able to use the keypad with the arrow and page up/down functionality, you have to exit nano and reset your terminal (presumably with "reset" or "stty sane" or similar) and then run nano again with NumLock off. If you know an easier way to restore "normal mode", please mail nano@nano-editor.org.

## 4.7. How do I make nano my default editor (in Pine, mutt, etc.)?

> You need to make nano your $EDITOR. If you want this to be saved, you should put a line like this in your .bashrc if you use bash (or .zshrc if you believe in zsh):

> export EDITOR=/usr/local/bin/nano

> or if you use tcsh put this in your .cshrc file:

> setenv EDITOR /usr/local/bin/nano

> Change /usr/local/bin/nano to wherever nano is installed on your system. Type "which nano" to find out. This will not take effect until the next time you login. So log out and back in again.

> Then on top that if you use Pine you must go into setup (type S at the main menu), then configure (type C). Hit enter on the lines that say:

> [ ] enable-alternate-editor-cmd
> [ ] enable-alternate-editor-implicitly

> Then exit (E) and select Yes (Y).

> Mutt users should see an effect immediately the next time you log in, no further configuration is needed. However, if you want to let people know you use nano to compose your email messages, you can put a line like this in your .muttrc:

> my_hdr X-Composer: nano x.y.z

> Again, replace x.y.z with the version of nano you use.

## 4.8. I've compiled nano with color support, but I don't see any color when I run it!

> If you want nano to actually use color, you have to specify the color configurations you want it to use in your .nanorc. Some example configurations are in the nanorc.sample that comes with the nano source or your nano package. See Section 3.8.

# 5. Internationalization

## 5.1. There's no translation for my language!

> On June of 2001, GNU nano entered the Free Translation Project and since then, translations should be managed from there.

> If there isn't a translation for your language, you could ask your language team to translate nano, or better still, join your team and do it yourself. Joining a team is easy. You just need to ask the TP coordinator to add you to your team, and send a translation disclaimer to the FSF (this is necessary as nano is an official GNU package, but it does not mean that you transfer the rights of your work to the FSF, it's just so the FSF can legally manage them).

> In any case, translating nano is very easy. Just grab the nano.pot file from the latest and greatest nano distribution (it's in the po/ directory) and translate each line into your native language on the msgstr line. When you're done, you should send it to the TP's central po repository.

## 5.2. I don't like the translation for <x> in my language. How can I fix it?

> The best way would probably be to e-mail the person listed in the `Last-Translator:` field in the <your_language>.po file with your suggested corrections and they can make the changes reach the nano-devel list.

# 6. Advocacy and Licensing

## 6.1. Why should I use nano instead of Pico?

> There are many reasons to use nano instead of Pico, a more complete list can be found at the nano homepage.

## 6.2. Why should I use Pico instead of nano?

> Again, check out the nano homepage for a good summary of reasons. It really is a matter of personal preference as to which editor you should use. If you're the type of person who likes using the original version of a program, then Pico is the editor for you. If you're looking for a few more features and a 'better' license as far as adding your own changes (sacrificing mailer integration with Pine), nano is the way to go.

## 6.3. What is so bad about the Pine license?

> The U of W license for Pine and Pico is not considered truly Free Software according to both the Free Software Foundation and the Debian Free Software Guidelines. The main problem regards the limitations on distributing derived works: according to UW, you can distribute their software, and you can modify it, but you can not do both, i.e. distribute modified binaries.

## 6.4. Okay, well what mail program should I use then?

> If you are looking to use a Free Software program similar to Pine and emacs is not your thing, you should definitely take a look at mutt. It is a full-screen, console based mail program that actually has a lot more flexibility than Pine, but has a keymap included in the distribution that allows you to use the same keystrokes as Pine would to send and receive mail. It's also licensed under the GPL.

## 6.5. Why doesn't UW simply change their license?

> You're really not asking the right person here. I (Chris) waited a long time to see if UW would change their license because of the amount of high quality software being released and developed under the GPL without being taken advantage of by malicious corporate entities or other baddies, but no such luck so far.

## 6.6. What if tomorrow UW changes the license to be truly Free Software?

> Honestly nothing would make me happier than to see that happen. Nano would continue to be developed independently until such time as Pico had all the features nano did or the projects merged. That just does not seem very likely given that there has been no sign of any changes in the past few years in a positive direction.

# 7. Miscellaneous

## 7.1. Nano related mailing lists.

> There are three mailing lists for nano hosted at Savannah, info-nano, help-nano and nano-devel. Info-nano is a very low traffic list where new versions of nano are announced (surprise!) Help-nano is for getting help with the editor without needing to hear all of the development issues surrounding it. Nano-devel is a normally low, sometimes high traffic list for discussing the present and future development of nano. Here are links to where you can sign up for a given list:

> info-nano - http://mail.gnu.org/mailman/listinfo/info-nano/
> help-nano - http://mail.gnu.org/mailman/listinfo/help-nano/
> nano-devel - http://mail.gnu.org/mailman/listinfo/nano-devel/

## 7.2. I want to send the development team a big load of cash (or just a thank you).

> That's fine. Send it our way! Better yet, fix a bug in the program or implement a cool feature and send us that instead (though cash is fine too).

## 7.3. How do I submit a patch?

> See Section 7.2.

## 7.4. How do I join the development team?

> The easiest way is to consistently send in good patches that add some needed functionality, fix a bug or two and/or make the program more optimized/efficient. Then ask nicely and you will probably be added to the Savannah development list and be given CVS write access after awhile. There is a lot of responsibility that goes along with being a team member, so don't think it's just something to add to your resume.

## 7.5. Can I have CVS write access?

> Re-read Section 7.4 and you should know the answer.

## 8. ChangeLog

> 2003/07/02 - Added question about nano's not showing color when it's compiled with color support (DLR; suggested by Jordi).
> 2003/02/23 - Updated RPM links for nano 1.2.x. (DLR).
> 2003/01/16 - Split section 4.5 into 4.5a and 4.5b for search string behavior. Added --enable-all docs.
> 2002/12/28 - More misc. fixes (David Benbennick, DLR).
> 2002/10/25 - Misc. fixes and link updates (DLR).
> 2002/09/10 - Another typo fix (DLR).
> 2002/05/15 - Typo fix (DLR).
> 2001/12/26 - Misc. fixes (Aaron S. Hawley, DLR).
> 2001/10/02 - Update for Free Translation Project.
> 2001/10/02 - Assorted fixes, Debian additions.
> 2001/06/30 - Silly typo fix.
> 2001/05/05 - Spelling fixes by David Lawrence Ramsey.
> 2001/05/02 - Misc fixes.
> 2001/03/26 - Typo fix in an URL.
> 2001/02/17 - Advocacy updates.
> 2001/02/15 - Added GNU notes for 0.9.99pre3.
> 2001/02/06 - Typo fixes.
> 2001/01/14 - Added note about NumLock glitch.
> 2001/01/10 - Linux -> GNU/Linux.
> 2001/01/09 - Added "making exe smaller" section.
> 2000/12/19 - Typo and assorted error fixes.
> 2000/11/28 - Added blurb about make install-strip.
> 2000/11/19 - Changed Debian frozen to stable.
> 2000/11/18 - Previous string display (4.5).
> 2000/09/27 - Moved addresses to nano-editor.org.
> 2000/06/31 - Initial framework.

$Id: faq.html,v 1.73.2.2 2004/06/28 02:36:33 astyanax Exp $