diff options
| author | Lorry Tar Creator <lorry-tar-importer@baserock.org> | 2015-03-23 03:49:03 +0000 |
|---|---|---|
| committer | <> | 2015-03-25 17:06:51 +0000 |
| commit | fb040ea36cb8e2158ccd9100600652f94ae90af1 (patch) | |
| tree | dba72a74e84a997c23fa0af7c07a4d831be2deb7 /doc | |
| parent | 8b74abeb02c01ddc768c465a826360cf33cec063 (diff) | |
| download | nano-tarball-master.tar.gz | |
Imported from /home/lorry/working-area/delta_nano-tarball/nano-2.4.0.tar.gz.HEADnano-2.4.0master
Diffstat (limited to 'doc')
64 files changed, 9105 insertions, 5035 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 15f35ee..c197ceb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,7 +1,11 @@ +SUBDIRS = man + +if HAVE_MAKEINFO +SUBDIRS += texinfo +endif + if USE_COLOR -SUBDIRS = man syntax texinfo -else -SUBDIRS = man texinfo +SUBDIRS += syntax endif -EXTRA_DIST = faq.html +dist_html_DATA = faq.html diff --git a/doc/Makefile.in b/doc/Makefile.in index b30918f..d7461b4 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,9 +1,8 @@ -# Makefile.in generated by automake 1.11.1 from Makefile.am. +# Makefile.in generated by automake 1.14.1 from Makefile.am. # @configure_input@ -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. +# Copyright (C) 1994-2013 Free Software Foundation, Inc. + # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -14,7 +13,53 @@ # PARTICULAR PURPOSE. @SET_MAKE@ + VPATH = @srcdir@ +am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)' +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -33,12 +78,15 @@ PRE_UNINSTALL = : POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ -target_triplet = @target@ +@HAVE_MAKEINFO_TRUE@am__append_1 = texinfo +@USE_COLOR_TRUE@am__append_2 = syntax subdir = doc -DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ - $(srcdir)/nanorc.sample.in +DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \ + $(top_srcdir)/mkinstalldirs $(srcdir)/nanorc.sample.in \ + $(dist_html_DATA) ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.m4 \ + $(top_srcdir)/m4/ax_check_compile_flag.m4 \ $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/glib-2.0.m4 \ $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/isc-posix.m4 \ $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ @@ -50,20 +98,87 @@ mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = nanorc.sample CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = SOURCES = DIST_SOURCES = -RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ - html-recursive info-recursive install-data-recursive \ - install-dvi-recursive install-exec-recursive \ - install-html-recursive install-info-recursive \ - install-pdf-recursive install-ps-recursive install-recursive \ - installcheck-recursive installdirs-recursive pdf-recursive \ - ps-recursive uninstall-recursive +RECURSIVE_TARGETS = all-recursive check-recursive cscopelist-recursive \ + ctags-recursive dvi-recursive html-recursive info-recursive \ + install-data-recursive install-dvi-recursive \ + install-exec-recursive install-html-recursive \ + install-info-recursive install-pdf-recursive \ + install-ps-recursive install-recursive installcheck-recursive \ + installdirs-recursive pdf-recursive ps-recursive \ + tags-recursive uninstall-recursive +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } +am__installdirs = "$(DESTDIR)$(htmldir)" +DATA = $(dist_html_DATA) RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ distclean-recursive maintainer-clean-recursive -AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \ - $(RECURSIVE_CLEAN_TARGETS:-recursive=) tags TAGS ctags CTAGS \ +am__recursive_targets = \ + $(RECURSIVE_TARGETS) \ + $(RECURSIVE_CLEAN_TARGETS) \ + $(am__extra_recursive_targets) +AM_RECURSIVE_TARGETS = $(am__recursive_targets:-recursive=) TAGS CTAGS \ distdir +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +# Read a list of newline-separated strings from the standard input, +# and print each of them once, without duplicates. Input order is +# *not* preserved. +am__uniquify_input = $(AWK) '\ + BEGIN { nonempty = 0; } \ + { items[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in items) print i; }; } \ +' +# Make sure the list of sources is unique. This is necessary because, +# e.g., the same source file might be shared among _SOURCES variables +# for different programs/libraries. +am__define_uniq_tagged_files = \ + list='$(am__tagged_files)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | $(am__uniquify_input)` ETAGS = etags CTAGS = ctags DIST_SUBDIRS = man texinfo syntax @@ -95,6 +210,7 @@ am__relativize = \ reldir="$$dir2" ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ @@ -140,6 +256,11 @@ MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGMERGE = @MSGMERGE@ +NCURSESW_CFLAGS = @NCURSESW_CFLAGS@ +NCURSESW_CONFIG = @NCURSESW_CONFIG@ +NCURSESW_LIBS = @NCURSESW_LIBS@ +NCURSES_CFLAGS = @NCURSES_CFLAGS@ +NCURSES_LIBS = @NCURSES_LIBS@ OBJEXT = @OBJEXT@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ @@ -151,6 +272,8 @@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKGDATADIR = @PKGDATADIR@ PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ POSUB = @POSUB@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ @@ -180,6 +303,7 @@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ +haveit = @haveit@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ @@ -204,17 +328,12 @@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ -target = @target@ target_alias = @target_alias@ -target_cpu = @target_cpu@ -target_os = @target_os@ -target_vendor = @target_vendor@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ -@USE_COLOR_FALSE@SUBDIRS = man texinfo -@USE_COLOR_TRUE@SUBDIRS = man syntax texinfo -EXTRA_DIST = faq.html +SUBDIRS = man $(am__append_1) $(am__append_2) +dist_html_DATA = faq.html all: all-recursive .SUFFIXES: @@ -250,24 +369,48 @@ $(ACLOCAL_M4): $(am__aclocal_m4_deps) $(am__aclocal_m4_deps): nanorc.sample: $(top_builddir)/config.status $(srcdir)/nanorc.sample.in cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ +install-dist_htmlDATA: $(dist_html_DATA) + @$(NORMAL_INSTALL) + @list='$(dist_html_DATA)'; test -n "$(htmldir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(htmldir)" || exit 1; \ + fi; \ + for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; \ + done | $(am__base_list) | \ + while read files; do \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(htmldir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(htmldir)" || exit $$?; \ + done + +uninstall-dist_htmlDATA: + @$(NORMAL_UNINSTALL) + @list='$(dist_html_DATA)'; test -n "$(htmldir)" || list=; \ + files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ + dir='$(DESTDIR)$(htmldir)'; $(am__uninstall_files_from_dir) # This directory's subdirectories are mostly independent; you can cd -# into them and run `make' without going through this Makefile. -# To change the values of `make' variables: instead of editing Makefiles, -# (1) if the variable is set in `config.status', edit `config.status' -# (which will cause the Makefiles to be regenerated when you run `make'); -# (2) otherwise, pass the desired values on the `make' command line. -$(RECURSIVE_TARGETS): - @fail= failcom='exit 1'; \ - for f in x $$MAKEFLAGS; do \ - case $$f in \ - *=* | --[!k]*);; \ - *k*) failcom='fail=yes';; \ - esac; \ - done; \ +# into them and run 'make' without going through this Makefile. +# To change the values of 'make' variables: instead of editing Makefiles, +# (1) if the variable is set in 'config.status', edit 'config.status' +# (which will cause the Makefiles to be regenerated when you run 'make'); +# (2) otherwise, pass the desired values on the 'make' command line. +$(am__recursive_targets): + @fail=; \ + if $(am__make_keepgoing); then \ + failcom='fail=yes'; \ + else \ + failcom='exit 1'; \ + fi; \ dot_seen=no; \ target=`echo $@ | sed s/-recursive//`; \ - list='$(SUBDIRS)'; for subdir in $$list; do \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + for subdir in $$list; do \ echo "Making $$target in $$subdir"; \ if test "$$subdir" = "."; then \ dot_seen=yes; \ @@ -282,57 +425,12 @@ $(RECURSIVE_TARGETS): $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ fi; test -z "$$fail" -$(RECURSIVE_CLEAN_TARGETS): - @fail= failcom='exit 1'; \ - for f in x $$MAKEFLAGS; do \ - case $$f in \ - *=* | --[!k]*);; \ - *k*) failcom='fail=yes';; \ - esac; \ - done; \ - dot_seen=no; \ - case "$@" in \ - distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ - *) list='$(SUBDIRS)' ;; \ - esac; \ - rev=''; for subdir in $$list; do \ - if test "$$subdir" = "."; then :; else \ - rev="$$subdir $$rev"; \ - fi; \ - done; \ - rev="$$rev ."; \ - target=`echo $@ | sed s/-recursive//`; \ - for subdir in $$rev; do \ - echo "Making $$target in $$subdir"; \ - if test "$$subdir" = "."; then \ - local_target="$$target-am"; \ - else \ - local_target="$$target"; \ - fi; \ - ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ - || eval $$failcom; \ - done && test -z "$$fail" -tags-recursive: - list='$(SUBDIRS)'; for subdir in $$list; do \ - test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \ - done -ctags-recursive: - list='$(SUBDIRS)'; for subdir in $$list; do \ - test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \ - done +ID: $(am__tagged_files) + $(am__define_uniq_tagged_files); mkid -fID $$unique +tags: tags-recursive +TAGS: tags -ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ - mkid -fID $$unique -tags: TAGS - -TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ - $(TAGS_FILES) $(LISP) +tags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) set x; \ here=`pwd`; \ if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ @@ -348,12 +446,7 @@ TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ set "$$@" "$$include_option=$$here/$$subdir/TAGS"; \ fi; \ done; \ - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(am__define_uniq_tagged_files); \ shift; \ if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ test -n "$$unique" || unique=$$empty_fix; \ @@ -365,15 +458,11 @@ TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ $$unique; \ fi; \ fi -ctags: CTAGS -CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ - $(TAGS_FILES) $(LISP) - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ +ctags: ctags-recursive + +CTAGS: ctags +ctags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + $(am__define_uniq_tagged_files); \ test -z "$(CTAGS_ARGS)$$unique" \ || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ $$unique @@ -382,6 +471,21 @@ GTAGS: here=`$(am__cd) $(top_builddir) && pwd` \ && $(am__cd) $(top_srcdir) \ && gtags -i $(GTAGS_ARGS) "$$here" +cscopelist: cscopelist-recursive + +cscopelist-am: $(am__tagged_files) + list='$(am__tagged_files)'; \ + case "$(srcdir)" in \ + [\\/]* | ?:[\\/]*) sdir="$(srcdir)" ;; \ + *) sdir=$(subdir)/$(srcdir) ;; \ + esac; \ + for i in $$list; do \ + if test -f "$$i"; then \ + echo "$(subdir)/$$i"; \ + else \ + echo "$$sdir/$$i"; \ + fi; \ + done >> $(top_builddir)/cscope.files distclean-tags: -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags @@ -418,13 +522,10 @@ distdir: $(DISTFILES) done @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ if test "$$subdir" = .; then :; else \ - test -d "$(distdir)/$$subdir" \ - || $(MKDIR_P) "$(distdir)/$$subdir" \ - || exit 1; \ - fi; \ - done - @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ - if test "$$subdir" = .; then :; else \ + $(am__make_dryrun) \ + || test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ $(am__relativize); \ new_distdir=$$reldir; \ @@ -446,9 +547,12 @@ distdir: $(DISTFILES) done check-am: all-am check: check-recursive -all-am: Makefile +all-am: Makefile $(DATA) installdirs: installdirs-recursive installdirs-am: + for dir in "$(DESTDIR)$(htmldir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done install: install-recursive install-exec: install-exec-recursive install-data: install-data-recursive @@ -459,10 +563,15 @@ install-am: all-am installcheck: installcheck-recursive install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi mostlyclean-generic: clean-generic: @@ -494,7 +603,7 @@ info: info-recursive info-am: -install-data-am: +install-data-am: install-dist_htmlDATA install-dvi: install-dvi-recursive @@ -538,23 +647,22 @@ ps: ps-recursive ps-am: -uninstall-am: +uninstall-am: uninstall-dist_htmlDATA -.MAKE: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) ctags-recursive \ - install-am install-strip tags-recursive +.MAKE: $(am__recursive_targets) install-am install-strip -.PHONY: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) CTAGS GTAGS \ - all all-am check check-am clean clean-generic ctags \ - ctags-recursive distclean distclean-generic distclean-tags \ - distdir dvi dvi-am html html-am info info-am install \ - install-am install-data install-data-am install-dvi \ +.PHONY: $(am__recursive_targets) CTAGS GTAGS TAGS all all-am check \ + check-am clean clean-generic cscopelist-am ctags ctags-am \ + distclean distclean-generic distclean-tags distdir dvi dvi-am \ + html html-am info info-am install install-am install-data \ + install-data-am install-dist_htmlDATA install-dvi \ install-dvi-am install-exec install-exec-am install-html \ install-html-am install-info install-info-am install-man \ install-pdf install-pdf-am install-ps install-ps-am \ install-strip installcheck installcheck-am installdirs \ installdirs-am maintainer-clean maintainer-clean-generic \ mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags \ - tags-recursive uninstall uninstall-am + tags-am uninstall uninstall-am uninstall-dist_htmlDATA # Tell versions [3.59,3.63) of GNU make to not export all variables. diff --git a/doc/faq.html b/doc/faq.html index 70baba5..d24a895 100644 --- a/doc/faq.html +++ b/doc/faq.html @@ -24,7 +24,6 @@ <blockquote><p><a href="#3.1">3.1. How do I install the RPM or DEB package?</a><br> <a href="#3.2">3.2. Compiling from source: WHAT THE HECK DO I DO NOW?</a><br> <a href="#3.3">3.3. Why does everything go into /usr/local?</a><br> - <a href="#3.4">3.4. I get errors about 'bindtextdomain','gettext', and/or 'gettextdomain'. What can I do about it?</a><br> <a href="#3.5">3.5. nano should automatically run strip on the binary when installing it!</a><br> <a href="#3.6">3.6. How can I make the executable smaller? This is too bloated!</a><br> <a href="#3.7">3.7. Tell me more about this multibuffer stuff!</a><br> @@ -46,7 +45,8 @@ <a href="#4.11">4.11. How do I make nano my default editor (in Pine, mutt, etc.)?</a><br> <a href="#4.12">4.12. I've compiled nano with color support, but I don't see any color when I run it!</a><br> <a href="#4.13">4.13. How do I select text for or paste text from the clipboard in an X terminal when I'm running nano in one and nano's mouse support is turned on?</a><br> - <a href="#4.14">4.14. When I paste text into a document, each line gets indented further than the last. Why does nano do this, and how can I avoid it?</a></p></blockquote> + <a href="#4.14">4.14. When I paste text into a document, each line gets indented further than the last. Why does nano do this, and how can I avoid it?</a><br> + <a href="#4.15">4.15. On startup I get a message that says "Detected a legacy nano history file". Now older nano versions can't find my search history!</a></p></blockquote> <h2><a href="#5">5. Internationalization</a></h2> <blockquote><p><a href="#5.1">5.1. There's no translation for my language!</a><br> <a href="#5.2">5.2. I don't like the translation for <x> in my language. How can I fix it?</a><br> @@ -84,7 +84,7 @@ <h2><a name="1.5"></a>1.5. Why the name change from TIP?</h2> <blockquote><p>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).</p></blockquote> <h2><a name="1.6"></a>1.6. What is the current version of nano?</h2> -<blockquote><p>The current version of nano *should* be 2.2.0. Of course, you should always check the nano homepage to see what the latest and greatest version is.</p></blockquote> +<blockquote><p>The current stable version of nano *should* be 2.2.6. Of course, you should always check the nano homepage to see what the latest and greatest version is.</p></blockquote> <h2><a name="1.7"></a>1.7. I want to read the man page without having to download the program!</h2> <blockquote><p>Jeez, demanding, aren't we? Okay, look <a href="http://www.nano-editor.org/dist/v2.2/nano.1.html">here</a>.</p></blockquote> <hr width="100%"> @@ -93,7 +93,6 @@ <blockquote><p>The nano distribution can be downloaded at the following fine web and ftp sites:</p> <ul> <li><a href="http://www.nano-editor.org/dist/">http://www.nano-editor.org/dist/</a></li> - <li><a href="http://www.ewtoo.org/~astyanax/nano/dist/">http://www.ewtoo.org/~astyanax/nano/dist/</a></li> <li><a href="ftp://ftp.gnu.org/pub/gnu/nano/">ftp://ftp.gnu.org/pub/gnu/nano/</a></li> </ul> </blockquote> @@ -101,18 +100,17 @@ <blockquote> <ul> <li><a href="http://www.nano-editor.org/dist/v2.2/RPMS/">http://www.nano-editor.org/dist/v2.2/RPMS/</a></li> - <li><a href="http://www.ewtoo.org/~astyanax/nano/dist/v2.2/RPMS/">http://www.ewtoo.org/~astyanax/nano/dist/v2.2/RPMS/</a></li> </ul> </blockquote> <h2><a name="2.3"></a>2.3. Debian (.deb) packages.</h2> <blockquote><p>Debian users can check out the current nano packages for:</p> <ul> - <li><a href="http://packages.debian.org/stable/editors/nano.html">stable</a></li> - <li><a href="http://packages.debian.org/testing/editors/nano.html">testing</a></li> - <li><a href="http://packages.debian.org/unstable/editors/nano.html">unstable</a></li> + <li><a href="http://packages.debian.org/stable/editors/nano">stable</a></li> + <li><a href="http://packages.debian.org/testing/editors/nano">testing</a></li> + <li><a href="http://packages.debian.org/unstable/editors/nano">unstable</a></li> </ul> <p>You can also have a look at the <a href="ftp://ftp.debian.org/debian/pool/main/n/nano/">Package Pool</a> to see all the available binary and source packages.</p> - <p>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.</p></blockquote> +</blockquote> <h2><a name="2.4"></a>2.4. By subversion (for the brave).</h2> <blockquote><p>For the 'bleeding edge' current version of nano, you can use subversion to download the current source code. <b>Note:</b> 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 <a href="http://svn.savannah.gnu.org/viewvc/trunk/nano/README.SVN?root=nano&view=markup">the nano SVN document</a> for info on anonymous SVN access to the nano source.</p></blockquote> <hr width="100%"> @@ -121,10 +119,8 @@ <blockquote><p>It's simple really! As root, type <b>rpm -Uvh nano-x.y.z-1.i386.rpm</b> if you have a RedHat-ish system or <b>dpkg -i nano_x.y.z-1.deb</b> if you have a Debian-ish system, where <b>x.y.z</b> is the release of nano. There are other programs to install packages, and if you wish to use those, knock yourself out.</p></blockquote> <h2><a name="3.2"></a>3.2. Compiling from source: WHAT THE HECK DO I DO NOW?</h2> <blockquote><p>Okay, take a deep breath, this really isn't hard. Unpack the nano source with a command like:</p> - <p><b>tar -zxvf nano-x.y.z.tar.gz</b></p> - <p>If you get error messages about the -z option, try this:</p> - <p><b>gzip -dc nano-x.y.z.tar.gz | tar xvf -</b></p> - <p>(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).</p> + <p><b>tar -xvf nano-x.y.z.tar.gz</b></p> + <p>Then you need to run <b>configure</b> with any options you might want (if any).</p> <p>The average case is this:</p> <p><b>cd nano-x.y.z/</b><br> <b>./configure</b><br> @@ -134,73 +130,67 @@ <blockquote><p>Well, that's what the <b>configure</b> script defaults to. If you wish to change this, simply do this:</p> <p><b>./configure --prefix=/usr</b></p> <p>to put nano into /usr/bin when you run <b>make install</b>.</p></blockquote> -<h2><a name="3.4"></a>3.4. I get errors about 'bindtextdomain', 'gettext', and/or 'gettextdomain'. What can I do about it?</h2> -<blockquote><p>Try doing a <b>./configure --with-included-gettext</b> and see if that solves your problem. You may need to do a <b>make clean; make</b> to get it to work fully.</p></blockquote> <h2><a name="3.5"></a>3.5. nano should automatically run strip on the binary when installing it!</h2> <blockquote><p>Actually, it does, but you have to use <b>make install-strip</b>. The default make install does not, and will not, run strip automatically.</p></blockquote> <h2><a name="3.6"></a>3.6. How can I make the executable smaller? This is too bloated!</h2> <blockquote><p>Actually, there are several parts of the editor that can be disabled. You can pass arguments to the <b>configure</b> script that disable certain features. Here's a brief list:</p> <pre> - <b>--disable-tabcomp</b> Disable tab completion functions - <b>--disable-justify</b> Disable justify/unjustify functions - <b>--disable-speller</b> Disable spell checker functions - <b>--disable-help</b> Disable help functions <b>--disable-browser</b> Disable built-in file browser - <b>--disable-wrapping</b> Disable all wrapping of text (and -w flag) + <b>--disable-color</b> Disable color and syntax highlighting + <b>--disable-extra</b> Disable extra features, currently only an easter egg + <b>--disable-help</b> Disable help functions + <b>--disable-justify</b> Disable justify/unjustify functions <b>--disable-mouse</b> Disable mouse support (and -m flag) - <b>--disable-operatingdir</b> Disable setting of operating directory</pre> - <p>There's also the <b>--enable-tiny</b> 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 <b>--disable-nls</b> 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 <b>strip</b> to strip all debugging code and code that exists in libraries on your system.</p> - <p>If, on the other hand, you can't live without bells and whistles, you could try:</p> - <pre> - <b>--enable-extra</b> Enable extra features, currently only easter eggs - <b>--enable-nanorc</b> Enable use of .nanorc files - <b>--enable-color</b> Enable color and syntax highlighting - <b>--enable-multibuffer</b> Enable having multiple file buffers open - <b>--enable-all</b> Enable all of the above features - <b>--disable-wrapping-as-root</b> - Disable text wrapping by default when the user is - root</pre></blockquote> + <b>--disable-multibuffer</b> Disable having multiple file buffers open + <b>--disable-nanorc</b> Disable the use of .nanorc files + <b>--disable-operatingdir</b> Disable setting of operating directory + <b>--disable-speller</b> Disable spell checker functions + <b>--disable-tabcomp</b> Disable tab completion functions + <b>--disable-wrapping</b> Disable all wrapping of text (and -w flag)</pre> + <p>There's also the <b>--enable-tiny</b> option which disables everything above, as well as some larger chunks of the program (like the marker code that you use with Control-^ to select text). Also, if you know you aren't going to be using other languages you can use <b>--disable-nls</b> 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 <b>strip</b> to strip all debugging code and code that exists in libraries on your system.</p> + <p>With <b>--disable-wrapping-as-root</b> you can disable any hard-wrapping by default when the user is root, useful to prevent accidentally changing long lines in system configuration files.</p> +</blockquote> <h2><a name="3.7"></a>3.7. Tell me more about this multibuffer stuff!</h2> -<blockquote><p>To use multiple file buffers, you must be using nano 1.1.0 or newer, and you must have configured nano with <b>--enable-multibuffer</b> (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 <b>Meta-F</b>, then insert the file as normal with <b>^R</b>. If you always want files to be loaded into their own buffers, use the <b>--multibuffer</b> or <b>-F</b> flag when you invoke nano.</p> +<blockquote><p>To use multiple file buffers, you must be using nano 1.1.0 or newer, and you must not have configured it with <b>--disable-multibuffer</b> nor with <b>--enable-tiny</b> (use <b>nano -V</b> to check the compilation options). Then when you want to insert a file into its own buffer instead of into the current file, just hit <b>Meta-F</b>, then insert the file as normal with <b>^R</b>. If you always want files to be loaded into their own buffers, use the <b>--multibuffer</b> or <b>-F</b> flag when you invoke nano.</p> <p>You can move between the buffers you have open with the <b>Meta-<</b> and <b>Meta-></b> keys, or more easily with <b>Meta-,</b> and <b>Meta-.</b> (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.</p></blockquote> <h2><a name="3.8"></a>3.8. Tell me more about this verbatim input stuff!</h2> -<blockquote><p>To use verbatim input, you must be using nano 1.3.1 or newer. When you want to insert a literal character into the file you're editing, such as a control character that nano usually treats as a command, first press <b>Meta-V</b>. (If you're not at a prompt, you'll get the message "Verbatim Input".) Then press the key(s) that generate the character you want.</p> - <p>Alternatively, if you've enabled Unicode support (see section <a href="#5.3">5.3</a>), you can press <b>Meta-V</b> and then type a six-digit hexadecimal code from 000000 to 10FFFF (case-insensitive), and the character with the corresponding value will be inserted instead. The prompt will change to "Unicode Input" when you do this.</p></blockquote> +<blockquote><p>To use verbatim input, you must be using nano 1.3.1 or newer. When you want to insert a literal character into the file you're editing, such as a control character that nano usually treats as a command, first press <b>Meta-V</b> (if you're not at a prompt, you'll get the message "Verbatim Input"), then press the key(s) that generate the character you want.</p> + <p>Alternatively, if you've enabled Unicode support (see section <a href="#5.3">5.3</a>), you can press <b>Meta-V</b> and then type a six-digit hexadecimal code (from 000000 to 10FFFF, case-insensitive), and the character with the corresponding value will be inserted instead. The prompt will change to "Unicode Input" when you do this.</p></blockquote> <h2><a name="3.9"></a>3.9. How do I make a .nanorc file that nano will read when I start it?</h2> -<blockquote><p>It's not hard at all! But, your version of nano must have been compiled with <b>--enable-nanorc</b>, and again must be version 1.1.12 or newer (use nano -V to check your version and compiled features). Then simply copy the <b>nanorc.sample</b> 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 <b>set</b> and the getopt_long flag for the feature, for example "set nowrap" or "set suspend".</p></blockquote> +<blockquote><p>It's not hard at all! But, your version of nano must not have been compiled with <b>--disable-nanorc</b>, and must be version 1.1.12 or newer (use nano -V to check your version and compiled features). Then simply copy the <b>nanorc.sample</b> 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 <b>set</b> and the getopt_long flag for the feature, for example "set nowrap" or "set suspend".</p></blockquote> <h2><a name="3.9.1"></a>3.9. How about in Win32?</h2> <blockquote><p>If you're using the official nano .zip file and have extracted all the files, you should take the file nano.rc and place it somewhere on your Win32 system (for example if you have write permission to do so, at the top of C:\). Then you must create an Environment variable called HOME which points to the directory where you put nano.rc. In Windows XP, you can get to Environment variables by right-clicking "My Computer" either on the desktop or in the Start Menu, and selecting Properties. This should bring up the System Properties panel. Then click the Advanced Tab, and there should be a button called Environment Variables. Click that to bring up the Environment Variables section. Now, under User Variables you should be able to click the New button, and make a new Variables Name called HOME, with the Variable Value of whatever path you copied nano.rc into (just the directory name; don't add nano.rc onto the end).</p> -<p>We're still working on documentatino for enabling synax highlighting on Win32; please bear with us</p> -<p>Note that the nano.rc file must remain Unix formated in order for nano to unerstand it. In other words, you should use probably only use nano to edit its config file. Other programs like Wordpad and Notepad will either convert the file to DOS format when saving, and the latter does not even properly read Unix-formatted files to begin with.</p></blockquote> +<p>We're still working on documentation for enabling synax highlighting on Win32; please bear with us.</p> +<p>Note that the nano.rc file must remain Unix-formated in order for nano to understand it. In other words, you should probably use only nano to edit its config file. Other programs like Wordpad and Notepad will convert the file to DOS format when saving, and the latter does not even properly read Unix-formatted files to begin with.</p></blockquote> <hr width="100%"> <h1><a name="4"></a>4. Running</h1> <h2><a name="4.1"></a>4.1. How do I open a file with a name beginning with '+' from the command line?</h2> -<blockquote><p>If a command line option that begins with '+' is followed by another option, the former is always treated as a starting line and column number and the latter is always treated as a filename. If a command line option that begins with '+' isn't followed by another option, it's always treated as a filename. Examples:</p> +<blockquote><p>If a command-line option that begins with '+' is followed by another option, the former is always treated as a starting line and column number, and the latter is always treated as a filename. If a command-line option that begins with '+' isn't followed by another option, it's always treated as a filename. Examples:</p> <p>To open '+filename.txt' starting on line 1: <b>nano +filename.txt</b><br> To open '+filename.txt' starting on line 10: <b>nano +10 +filename.txt</b><br> To open '+filename.txt' starting on line 1, column 20: <b>nano +,20 +filename.txt</b><br> To open '+filename.txt' starting on line 10, column 20: <b>nano +10,20 +filename.txt</b><br> - To open '+filename.txt' starting on line 1 and 'filename.txt' starting on line 10 (if nano has been compiled with multibuffer support): <b>nano +1 +filename.txt +20 filename.txt</b></p></blockquote> + To open '+filename.txt' starting on line 1 and 'filename.txt' starting on line 40 (if nano has been compiled with multibuffer support): <b>nano +1 +filename.txt +40 filename.txt</b></p></blockquote> <h2><a name="4.2"></a>4.2. Ack! My Backspace/Delete/Enter/Meta/double bucky key doesn't seem to work! What can I do?</h2> <blockquote><p>Try setting your $TERM variable to 'vt100'. nano doesn't yet support every term entry under the sun.</p> <p>Bourne shell users (bash and sh): <b>export TERM=vt100</b><br> C Shell users (tcsh and csh): <b>setenv TERM vt100</b></p></blockquote> <h2><a name="4.3"></a>4.3. Ack! My numeric keypad's keys don't work properly when NumLock is off! What can I do?</h2> -<blockquote><p>You can use the <b>-K</b> or <b>--rebindkeypad</b> options on the command line, or add the line <b>set rebindkeypad</b> to your .nanorc. However, nano's mouse support won't work properly if you do any of these things.</p></blockquote> +<blockquote><p>You can use the <b>-K</b> or <b>--rebindkeypad</b> option on the command line, or add the line <b>set rebindkeypad</b> to your .nanorc. However, nano's mouse support won't work properly if you do any of these things.</p></blockquote> <h2><a name="4.4"></a>4.4. Ack! When I hold down a Meta key combination for a while, the character of the held key gets inserted now and then. What gives?</h2> <blockquote><p>This is a bug in the terminal, not in nano. When a key is repeating faster than nano can process it, the keyboard buffer becomes full and starts dropping incoming keystrokes. Unfortunately, it doesn't just drop whole keystrokes; it can also drop parts of multibyte key combinations, resulting in nano's receiving a wrong key.</p></blockquote> <h2><a name="4.5"></a>4.5. How do I type the F13-F16 keys shown in the help browser? My keyboard only has F1-F12!</h2> <blockquote><p>It depends on the terminal type you're using. On some terminals, such as the FreeBSD console, xterm, konsole, and gnome-terminal, Shift-F1 to Shift-F4 will generate F13 to F16. On other terminals, such as the Linux console, rxvt, and Eterm, Shift-F3 to Shift-F6 will generate F13 to F16.</p></blockquote> <h2><a name="4.6"></a>4.6. nano crashes when I type <insert keystroke here>!</h2> -<blockquote><p>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 <a href="mailto:nano-devel@gnu.org">nano-devel</a> list or to <a href="mailto:nano@nano-editor.org">nano@nano-editor.org</a>.</p></blockquote> +<blockquote><p>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 <a href="mailto:nano-devel@gnu.org">nano-devel</a> list or in the <a href="https://savannah.gnu.org/bugs/?group=nano">bug database</a> on Savannah.</p></blockquote> <h2><a name="4.7"></a>4.7. nano crashes when I resize my window. How can I fix that?</h2> -<blockquote><p>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).</p></blockquote> +<blockquote><p>Older versions of nano had this problem, please upgrade to a newer version (at least 0.9.9, but 2.2.6 is recommended).</p></blockquote> <h2><a name="4.8"></a>4.8. [version 1.3.12 and later] I'm using glibc 2.2.3, and nano crashes when I use color support or do regular expression searches. How can I fix that?</h2> <blockquote><p>It's a bug in glibc 2.2.3. You should upgrade to at least glibc 2.2.4.</p></blockquote> <h2><a name="4.9"></a>4.9. [version 1.1.12 and earlier] Why does nano show ^\ in the shortcut list instead of ^J?</h2> -<blockquote><p>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 <b>-p</b> option to nano (or hit Meta-P) you will get the same shortcuts at the bottom as Pico.</p></blockquote> +<blockquote><p>The help (^G) and justify (^J) functions were among the last to be written. To show the improvements that nano had over Pico (go to line number, 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.</p></blockquote> <h2><a name="4.10a"></a>4.10a. [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?!</h2> -<blockquote><p>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).</p></blockquote> +<blockquote><p>Since nano version 0.9.20, the default was 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.</p></blockquote> <h2><a name="4.10b"></a>4.10b. [version 1.1.99pre1 and later] Hey, the search string behavior has reverted, it's now like Pico, what happened to the consistency?</h2> <blockquote><p>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 <b>clone</b>, and clones by default should be compatible.</p></blockquote> <h2><a name="4.11"></a>4.11. How do I make nano my default editor (in Pine, mutt, etc.)?</h2> @@ -208,7 +198,7 @@ <p><b>export EDITOR=/usr/local/bin/nano</b></p> <p>or, if you use tcsh, put this in your <b>.cshrc</b> file:</p> <p><b>setenv EDITOR /usr/local/bin/nano</b></p> - <p>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.</p> + <p>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 log in. So log out and back in again.</p> <p>Then, on top of that, if you use Pine, you must go into setup (type <b>S</b> at the main menu), and then configure (type <b>C</b>). Hit Enter on the lines that say:</p> <p><b>[ ] enable-alternate-editor-cmd</b><br> <b>[ ] enable-alternate-editor-implicitly</b></p> @@ -217,19 +207,24 @@ <p><b>my_hdr X-Composer: nano x.y.z</b></p> <p>Again, replace x.y.z with the version of nano you use.</p></blockquote> <h2><a name="4.12"></a>4.12. I've compiled nano with color support, but I don't see any color when I run it!</h2> -<blockquote><p>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 <b>nanorc.sample</b> that comes with the nano source or your nano package. See Section <a href="#3.9">3.9</a>.</p></blockquote> +<blockquote><p>If you want nano to actually use color, you have to specify the color configurations you want it to use in your .nanorc. Several example configurations are in the <b>doc/syntax</b> subdirectory of the nano source, which are normally installed to <b>/usr/local/share/nano</b>. To enable all of them, uncomment the line <b># include "/usr/local/share/nano/*.nanorc"</b> in your nanorc. See also section <a href="#3.9">3.9</a>.</p></blockquote> <h2><a name="4.13"></a>4.13. How do I select text for or paste text from the clipboard in an X terminal when I'm running nano in one and nano's mouse support is turned on?</h2> <blockquote><p>Try holding down the Shift key and selecting or pasting the text as you normally would.</p></blockquote> <h2><a name="4.14"></a>4.14. When I paste text into a document, each line gets indented further than the last. Why does nano do this, and how can I avoid it?</h2> <blockquote><p>You have the autoindent feature turned on. Hit Meta-I to turn it off, paste your text, and then hit Meta-I again to turn it back on.</p></blockquote> +<h2><a name="4.15"></a>4.15. On startup I get a message that says "Detected a legacy nano history file". Now older nano versions can't find my search history!</h2> +<blockquote><p>In nano 2.3.0, cursor-position history was introduced, and both history files now reside under a .nano directory in your home. nano was trying to move this file into the new location so it could continue to use it. This means that if you try and use an earlier version of nano, it will be unable to see your current search history. To fix this, run the following commands:<br> +mv ~/.nano/search_history ~/.nano_history<br> +ln -sf ~/.nano_history ~/.nano/search_history<br> +</p></blockquote> <hr width="100%"> <h1><a name="5"></a>5. Internationalization</h1> <h2><a name="5.1"></a>5.1. There's no translation for my language!</h2> -<blockquote><p>On June of 2001, GNU nano entered the <a href="http://translationproject.org/html/welcome.html">Free Translation Project</a> and since then, translations should be managed from there.</p> - <p>If there isn't a translation for your language, you could ask <a href="http://translationproject.org/team/">your language team</a> to translate nano, or better still, join your team and do it yourself. Joining a team is easy. You just need to ask the <a href="mailto:coordinator@translationproject.org">TP coordinator</a> to add you to your team, and send a <a href="http://translationproject.org/disclaim.txt">translation disclaimer to the FSF</a> (this is necessary as nano is an official GNU package, but it does <b>not</b> mean that you transfer the rights of your work to the FSF, it's just so the FSF can legally manage them).</p> - <p>In any case, translating nano is very easy. Just grab the <b>nano.pot</b> file from the latest and greatest nano distribution (it's in the <b>po/</b> directory) and translate each line into your native language on the <b>msgstr</b> line. When you're done, you should send it to the TP's central po repository.</p></blockquote> +<blockquote><p>On June of 2001, GNU nano entered the <a href="http://translationproject.org/html/welcome.html">Translation Project</a> and since then, translations should be managed from there.</p> + <p>If there isn't a translation for your language, you could ask <a href="http://translationproject.org/team/">your language team</a> to translate nano, or better still, join that team and do it yourself. Joining a team is easy. You just need to ask the team leader to add you, and then send a <a href="http://translationproject.org/disclaim.txt">translation disclaimer to the FSF</a> (this is necessary as nano is an official GNU package, but it does <b>not</b> mean that you transfer the rights of your work to the FSF, it's just so the FSF can legally manage them).</p> + <p>In any case, translating nano is very easy. Just grab the latest <b>nano.pot</b> file listed on <a href="http://translationproject.org/domain/nano.html">nano's page</a> at the TP, and translate each <b>msgid</b> line into your native language on the <b>msgstr</b> line. When you're done, you should send it to the TP's central po repository.</p></blockquote> <h2><a name="5.2"></a>5.2. I don't like the translation for <x> in my language. How can I fix it?</h2> -<blockquote><p>The best way would probably be to e-mail the person listed in the <code>Last-Translator:</code> field in the <b><your_language>.po</b> file with your suggested corrections and they can make the changes reach the nano-devel list.</p></blockquote> +<blockquote><p>The best way would probably be to send an e-mail to the team's mailing listed mentione in the <code>Language-Team:</code> field in the <b><your_language>.po</b> file with your suggested corrections, and then they can make the changes reach the nano-devel list.</p></blockquote> <h2><a name="5.3"></a>5.3. What is the status of Unicode support?</h2> <blockquote><p>In version 1.3.12 or later, Unicode should be usable. With your terminal, locale (LC_ALL and similar environment variables), and encoding configured to properly support UTF-8, you should be able to enter and save Unicode text.</p></blockquote> <hr width="100%"> @@ -246,22 +241,23 @@ Of course, due to the license change you can now use the <A HREF="http://www.was <hr width="100%"> <h1><a name="7"></a>7. Miscellaneous</h1> <h2><a name="7.1"></a>7.1. nano-related mailing lists.</h2> -<blockquote><p>There are three mailing lists for nano hosted at <a href="http://savannah.gnu.org/">Savannah</a>, 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:</p> +<blockquote><p>There are three mailing lists for nano hosted at <a href="http://savannah.gnu.org/">Savannah</a>: 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:</p> <p>info-nano - <a href="http://mail.gnu.org/mailman/listinfo/info-nano/">http://mail.gnu.org/mailman/listinfo/info-nano/</a><br> help-nano - <a href="http://mail.gnu.org/mailman/listinfo/help-nano/">http://mail.gnu.org/mailman/listinfo/help-nano/</a><br> nano-devel - <a href="http://mail.gnu.org/mailman/listinfo/nano-devel/">http://mail.gnu.org/mailman/listinfo/nano-devel/</a></p></blockquote> <h2><a name="7.2"></a>7.2. I want to send the development team a big load of cash (or just a thank you).</h2> -<blockquote><p>That's fine. Send it <a href="mailto:nano-devel@gnu.org">our way</a>! Better yet, fix a <a href="http://www.nano-editor.org/dist/v2.2/BUGS">bug</a> in the program or implement a <a href="http://www.nano-editor.org/dist/v2.2/TODO">cool feature</a> and send us that instead (though cash is fine too).</p></blockquote> +<blockquote><p>That's fine. Send it <a href="mailto:nano-devel@gnu.org">our way</a>! Better yet, fix a <a href="https://savannah.gnu.org/bugs/?group=nano">bug</a> in the program or implement a <a href="http://www.nano-editor.org/dist/v2.3/TODO">cool feature</a> and send us that instead (though cash is fine too).</p></blockquote> <h2><a name="7.3"></a>7.3. How do I submit a bug report or patch?</h2> <blockquote> -<p>The best place to submit bugs is to the <A HREF="https://savannah.gnu.org/bugs/?group=nano">Savannah bug tracker</A> as you can check whether the bug you are submitting has already been submitted. +<p>The best place to submit bugs is to the <a href="https://savannah.gnu.org/bugs/?group=nano">Savannah bug tracker</a> as you can check whether the bug you are submitting has already been submitted. <p>Please submit patches for nano via the <a href="https://savannah.gnu.org/patch/?group=nano">Savannah project's patch manager</a> for the nano project.</p></blockquote> <h2><a name="7.4"></a>7.4. How do I join the development team?</h2> -<blockquote><p>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 SVN 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.</p></blockquote> +<blockquote><p>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 SVN write access after a while. 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.</p></blockquote> <h2><a name="7.5"></a>7.5. Can I have write access to the subversion tree?</h2> <blockquote><p>Re-read Section <a href="#7.4">7.4</a> and you should know the answer.</p></blockquote> <h2><a name="8"></a>8. ChangeLog</h2> -<blockquote><p>2009/11/30 - Update various bits for nano 2.2.x. (DLR)<br> +<blockquote><p>2014/04/24 - A bunch of small fixes and updates. (Benno)<br> +2009/11/30 - Update various bits for nano 2.2.x. (DLR)<br> 2009/11/18 - Typo fix. (j.mader@gmail.com)<br> 2008/03/16 - Update docs to refer to subversion instead of CVS, add more words about Alpine, and refer to Savannah for bugs and patches. (chrisa)<br> 2007/12/21 - Update maintainer information. (DLR)<br> @@ -326,6 +322,6 @@ Of course, due to the license change you can now use the <A HREF="http://www.was 2000/11/18 - Previous string display (4.5).<br> 2000/09/27 - Moved addresses to nano-editor.org.<br> 2000/06/31 - Initial framework.</p></blockquote> -<p>$Id: faq.html 4521 2010-11-15 06:58:22Z astyanax $</p> +<p>$Id: faq.html 4814 2014-04-24 20:22:32Z bens $</p> </body> </html> diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index fbcdce8..f7ad09a 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,27 +1,18 @@ -if USE_NLS -SUBDIRS = fr -else SUBDIRS = +BUILT_SOURCES = + +if USE_NLS +SUBDIRS += fr endif +dist_man_MANS = nano.1 rnano.1 +html_pages = nano.1.html rnano.1.html + if USE_NANORC -man_MANS = nano.1 nanorc.5 rnano.1 -if GROFF_HTML -BUILT_SOURCES = nano.1.html nanorc.5.html rnano.1.html -endif -else -man_MANS = nano.1 rnano.1 -if GROFF_HTML -BUILT_SOURCES = nano.1.html rnano.1.html -endif +dist_man_MANS += nanorc.5 +html_pages += nanorc.5.html endif -nano_man_mans = nano.1 nanorc.5 rnano.1 -if GROFF_HTML -htmlman_DATA = nano.1.html nanorc.5.html rnano.1.html -htmlmandir = $(datadir)/nano/man-html -nano_built_sources = nano.1.html nanorc.5.html rnano.1.html - nano.1.html: nano.1 groff -t -mandoc -Thtml < $? > $@ nanorc.5.html: nanorc.5 @@ -29,7 +20,9 @@ nanorc.5.html: nanorc.5 rnano.1.html: rnano.1 groff -t -mandoc -Thtml < $? > $@ -EXTRA_DIST = $(nano_man_mans) $(nano_built_sources) -else -EXTRA_DIST = $(nano_man_mans) +if GROFF_HTML +BUILT_SOURCES += $(html_pages) +dist_html_DATA = $(html_pages) endif + +EXTRA_DIST = $(BUILT_SOURCES) diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in index a48d914..b09d383 100644 --- a/doc/man/Makefile.in +++ b/doc/man/Makefile.in @@ -1,9 +1,8 @@ -# Makefile.in generated by automake 1.11.1 from Makefile.am. +# Makefile.in generated by automake 1.14.1 from Makefile.am. # @configure_input@ -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. +# Copyright (C) 1994-2013 Free Software Foundation, Inc. + # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -16,6 +15,51 @@ @SET_MAKE@ VPATH = @srcdir@ +am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)' +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -34,11 +78,17 @@ PRE_UNINSTALL = : POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ -target_triplet = @target@ +@USE_NLS_TRUE@am__append_1 = fr +@USE_NANORC_TRUE@am__append_2 = nanorc.5 +@USE_NANORC_TRUE@am__append_3 = nanorc.5.html +@GROFF_HTML_TRUE@am__append_4 = $(html_pages) subdir = doc/man -DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \ + $(top_srcdir)/mkinstalldirs $(dist_man_MANS) \ + $(am__dist_html_DATA_DIST) ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.m4 \ + $(top_srcdir)/m4/ax_check_compile_flag.m4 \ $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/glib-2.0.m4 \ $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/isc-posix.m4 \ $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ @@ -50,15 +100,33 @@ mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = SOURCES = DIST_SOURCES = -RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ - html-recursive info-recursive install-data-recursive \ - install-dvi-recursive install-exec-recursive \ - install-html-recursive install-info-recursive \ - install-pdf-recursive install-ps-recursive install-recursive \ - installcheck-recursive installdirs-recursive pdf-recursive \ - ps-recursive uninstall-recursive +RECURSIVE_TARGETS = all-recursive check-recursive cscopelist-recursive \ + ctags-recursive dvi-recursive html-recursive info-recursive \ + install-data-recursive install-dvi-recursive \ + install-exec-recursive install-html-recursive \ + install-info-recursive install-pdf-recursive \ + install-ps-recursive install-recursive installcheck-recursive \ + installdirs-recursive pdf-recursive ps-recursive \ + tags-recursive uninstall-recursive +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; am__vpath_adj = case $$p in \ $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ @@ -80,18 +148,45 @@ am__nobase_list = $(am__nobase_strip_setup); \ am__base_list = \ sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } man1dir = $(mandir)/man1 am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" \ - "$(DESTDIR)$(htmlmandir)" + "$(DESTDIR)$(htmldir)" man5dir = $(mandir)/man5 NROFF = nroff -MANS = $(man_MANS) -DATA = $(htmlman_DATA) +MANS = $(dist_man_MANS) +am__dist_html_DATA_DIST = nano.1.html rnano.1.html nanorc.5.html +DATA = $(dist_html_DATA) RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ distclean-recursive maintainer-clean-recursive -AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \ - $(RECURSIVE_CLEAN_TARGETS:-recursive=) tags TAGS ctags CTAGS \ +am__recursive_targets = \ + $(RECURSIVE_TARGETS) \ + $(RECURSIVE_CLEAN_TARGETS) \ + $(am__extra_recursive_targets) +AM_RECURSIVE_TARGETS = $(am__recursive_targets:-recursive=) TAGS CTAGS \ distdir +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +# Read a list of newline-separated strings from the standard input, +# and print each of them once, without duplicates. Input order is +# *not* preserved. +am__uniquify_input = $(AWK) '\ + BEGIN { nonempty = 0; } \ + { items[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in items) print i; }; } \ +' +# Make sure the list of sources is unique. This is necessary because, +# e.g., the same source file might be shared among _SOURCES variables +# for different programs/libraries. +am__define_uniq_tagged_files = \ + list='$(am__tagged_files)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | $(am__uniquify_input)` ETAGS = etags CTAGS = ctags DIST_SUBDIRS = fr @@ -123,6 +218,7 @@ am__relativize = \ reldir="$$dir2" ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ @@ -168,6 +264,11 @@ MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGMERGE = @MSGMERGE@ +NCURSESW_CFLAGS = @NCURSESW_CFLAGS@ +NCURSESW_CONFIG = @NCURSESW_CONFIG@ +NCURSESW_LIBS = @NCURSESW_LIBS@ +NCURSES_CFLAGS = @NCURSES_CFLAGS@ +NCURSES_LIBS = @NCURSES_LIBS@ OBJEXT = @OBJEXT@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ @@ -179,6 +280,8 @@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKGDATADIR = @PKGDATADIR@ PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ POSUB = @POSUB@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ @@ -208,6 +311,7 @@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ +haveit = @haveit@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ @@ -232,26 +336,16 @@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ -target = @target@ target_alias = @target_alias@ -target_cpu = @target_cpu@ -target_os = @target_os@ -target_vendor = @target_vendor@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ -@USE_NLS_FALSE@SUBDIRS = -@USE_NLS_TRUE@SUBDIRS = fr -@USE_NANORC_FALSE@man_MANS = nano.1 rnano.1 -@USE_NANORC_TRUE@man_MANS = nano.1 nanorc.5 rnano.1 -@GROFF_HTML_TRUE@@USE_NANORC_FALSE@BUILT_SOURCES = nano.1.html rnano.1.html -@GROFF_HTML_TRUE@@USE_NANORC_TRUE@BUILT_SOURCES = nano.1.html nanorc.5.html rnano.1.html -nano_man_mans = nano.1 nanorc.5 rnano.1 -@GROFF_HTML_TRUE@htmlman_DATA = nano.1.html nanorc.5.html rnano.1.html -@GROFF_HTML_TRUE@htmlmandir = $(datadir)/nano/man-html -@GROFF_HTML_TRUE@nano_built_sources = nano.1.html nanorc.5.html rnano.1.html -@GROFF_HTML_FALSE@EXTRA_DIST = $(nano_man_mans) -@GROFF_HTML_TRUE@EXTRA_DIST = $(nano_man_mans) $(nano_built_sources) +SUBDIRS = $(am__append_1) +BUILT_SOURCES = $(am__append_4) +dist_man_MANS = nano.1 rnano.1 $(am__append_2) +html_pages = nano.1.html rnano.1.html $(am__append_3) +@GROFF_HTML_TRUE@dist_html_DATA = $(html_pages) +EXTRA_DIST = $(BUILT_SOURCES) all: $(BUILT_SOURCES) $(MAKE) $(AM_MAKEFLAGS) all-recursive @@ -286,13 +380,20 @@ $(top_srcdir)/configure: $(am__configure_deps) $(ACLOCAL_M4): $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(am__aclocal_m4_deps): -install-man1: $(man_MANS) +install-man1: $(dist_man_MANS) @$(NORMAL_INSTALL) - test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)" - @list=''; test -n "$(man1dir)" || exit 0; \ - { for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.1[a-z]*$$/p'; \ + @list1=''; \ + list2='$(dist_man_MANS)'; \ + test -n "$(man1dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man1dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man1dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.1[a-z]*$$/p'; \ + fi; \ } | while read p; do \ if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; echo "$$p"; \ @@ -317,20 +418,25 @@ uninstall-man1: @$(NORMAL_UNINSTALL) @list=''; test -n "$(man1dir)" || exit 0; \ files=`{ for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ sed -n '/\.1[a-z]*$$/p'; \ } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ - test -z "$$files" || { \ - echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(man1dir)" && rm -f $$files; } -install-man5: $(man_MANS) + dir='$(DESTDIR)$(man1dir)'; $(am__uninstall_files_from_dir) +install-man5: $(dist_man_MANS) @$(NORMAL_INSTALL) - test -z "$(man5dir)" || $(MKDIR_P) "$(DESTDIR)$(man5dir)" - @list=''; test -n "$(man5dir)" || exit 0; \ - { for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.5[a-z]*$$/p'; \ + @list1=''; \ + list2='$(dist_man_MANS)'; \ + test -n "$(man5dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man5dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man5dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.5[a-z]*$$/p'; \ + fi; \ } | while read p; do \ if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; echo "$$p"; \ @@ -355,51 +461,53 @@ uninstall-man5: @$(NORMAL_UNINSTALL) @list=''; test -n "$(man5dir)" || exit 0; \ files=`{ for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ sed -n '/\.5[a-z]*$$/p'; \ } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \ -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ - test -z "$$files" || { \ - echo " ( cd '$(DESTDIR)$(man5dir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(man5dir)" && rm -f $$files; } -install-htmlmanDATA: $(htmlman_DATA) + dir='$(DESTDIR)$(man5dir)'; $(am__uninstall_files_from_dir) +install-dist_htmlDATA: $(dist_html_DATA) @$(NORMAL_INSTALL) - test -z "$(htmlmandir)" || $(MKDIR_P) "$(DESTDIR)$(htmlmandir)" - @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || list=; \ + @list='$(dist_html_DATA)'; test -n "$(htmldir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(htmldir)" || exit 1; \ + fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ done | $(am__base_list) | \ while read files; do \ - echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(htmlmandir)'"; \ - $(INSTALL_DATA) $$files "$(DESTDIR)$(htmlmandir)" || exit $$?; \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(htmldir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(htmldir)" || exit $$?; \ done -uninstall-htmlmanDATA: +uninstall-dist_htmlDATA: @$(NORMAL_UNINSTALL) - @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || list=; \ + @list='$(dist_html_DATA)'; test -n "$(htmldir)" || list=; \ files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ - test -n "$$files" || exit 0; \ - echo " ( cd '$(DESTDIR)$(htmlmandir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(htmlmandir)" && rm -f $$files + dir='$(DESTDIR)$(htmldir)'; $(am__uninstall_files_from_dir) # This directory's subdirectories are mostly independent; you can cd -# into them and run `make' without going through this Makefile. -# To change the values of `make' variables: instead of editing Makefiles, -# (1) if the variable is set in `config.status', edit `config.status' -# (which will cause the Makefiles to be regenerated when you run `make'); -# (2) otherwise, pass the desired values on the `make' command line. -$(RECURSIVE_TARGETS): - @fail= failcom='exit 1'; \ - for f in x $$MAKEFLAGS; do \ - case $$f in \ - *=* | --[!k]*);; \ - *k*) failcom='fail=yes';; \ - esac; \ - done; \ +# into them and run 'make' without going through this Makefile. +# To change the values of 'make' variables: instead of editing Makefiles, +# (1) if the variable is set in 'config.status', edit 'config.status' +# (which will cause the Makefiles to be regenerated when you run 'make'); +# (2) otherwise, pass the desired values on the 'make' command line. +$(am__recursive_targets): + @fail=; \ + if $(am__make_keepgoing); then \ + failcom='fail=yes'; \ + else \ + failcom='exit 1'; \ + fi; \ dot_seen=no; \ target=`echo $@ | sed s/-recursive//`; \ - list='$(SUBDIRS)'; for subdir in $$list; do \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + for subdir in $$list; do \ echo "Making $$target in $$subdir"; \ if test "$$subdir" = "."; then \ dot_seen=yes; \ @@ -414,57 +522,12 @@ $(RECURSIVE_TARGETS): $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ fi; test -z "$$fail" -$(RECURSIVE_CLEAN_TARGETS): - @fail= failcom='exit 1'; \ - for f in x $$MAKEFLAGS; do \ - case $$f in \ - *=* | --[!k]*);; \ - *k*) failcom='fail=yes';; \ - esac; \ - done; \ - dot_seen=no; \ - case "$@" in \ - distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ - *) list='$(SUBDIRS)' ;; \ - esac; \ - rev=''; for subdir in $$list; do \ - if test "$$subdir" = "."; then :; else \ - rev="$$subdir $$rev"; \ - fi; \ - done; \ - rev="$$rev ."; \ - target=`echo $@ | sed s/-recursive//`; \ - for subdir in $$rev; do \ - echo "Making $$target in $$subdir"; \ - if test "$$subdir" = "."; then \ - local_target="$$target-am"; \ - else \ - local_target="$$target"; \ - fi; \ - ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ - || eval $$failcom; \ - done && test -z "$$fail" -tags-recursive: - list='$(SUBDIRS)'; for subdir in $$list; do \ - test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \ - done -ctags-recursive: - list='$(SUBDIRS)'; for subdir in $$list; do \ - test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \ - done +ID: $(am__tagged_files) + $(am__define_uniq_tagged_files); mkid -fID $$unique +tags: tags-recursive +TAGS: tags -ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ - mkid -fID $$unique -tags: TAGS - -TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ - $(TAGS_FILES) $(LISP) +tags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) set x; \ here=`pwd`; \ if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ @@ -480,12 +543,7 @@ TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ set "$$@" "$$include_option=$$here/$$subdir/TAGS"; \ fi; \ done; \ - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(am__define_uniq_tagged_files); \ shift; \ if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ test -n "$$unique" || unique=$$empty_fix; \ @@ -497,15 +555,11 @@ TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ $$unique; \ fi; \ fi -ctags: CTAGS -CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ - $(TAGS_FILES) $(LISP) - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ +ctags: ctags-recursive + +CTAGS: ctags +ctags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + $(am__define_uniq_tagged_files); \ test -z "$(CTAGS_ARGS)$$unique" \ || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ $$unique @@ -514,24 +568,26 @@ GTAGS: here=`$(am__cd) $(top_builddir) && pwd` \ && $(am__cd) $(top_srcdir) \ && gtags -i $(GTAGS_ARGS) "$$here" +cscopelist: cscopelist-recursive + +cscopelist-am: $(am__tagged_files) + list='$(am__tagged_files)'; \ + case "$(srcdir)" in \ + [\\/]* | ?:[\\/]*) sdir="$(srcdir)" ;; \ + *) sdir=$(subdir)/$(srcdir) ;; \ + esac; \ + for i in $$list; do \ + if test -f "$$i"; then \ + echo "$(subdir)/$$i"; \ + else \ + echo "$$sdir/$$i"; \ + fi; \ + done >> $(top_builddir)/cscope.files distclean-tags: -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags distdir: $(DISTFILES) - @list='$(MANS)'; if test -n "$$list"; then \ - list=`for p in $$list; do \ - if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ - if test -f "$$d$$p"; then echo "$$d$$p"; else :; fi; done`; \ - if test -n "$$list" && \ - grep 'ab help2man is required to generate this page' $$list >/dev/null; then \ - echo "error: found man pages containing the \`missing help2man' replacement text:" >&2; \ - grep -l 'ab help2man is required to generate this page' $$list | sed 's/^/ /' >&2; \ - echo " to fix them, install help2man, remove and regenerate the man pages;" >&2; \ - echo " typically \`make maintainer-clean' will remove them" >&2; \ - exit 1; \ - else :; fi; \ - else :; fi @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ list='$(DISTFILES)'; \ @@ -563,13 +619,10 @@ distdir: $(DISTFILES) done @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ if test "$$subdir" = .; then :; else \ - test -d "$(distdir)/$$subdir" \ - || $(MKDIR_P) "$(distdir)/$$subdir" \ - || exit 1; \ - fi; \ - done - @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ - if test "$$subdir" = .; then :; else \ + $(am__make_dryrun) \ + || test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ $(am__relativize); \ new_distdir=$$reldir; \ @@ -595,7 +648,7 @@ check: $(BUILT_SOURCES) all-am: Makefile $(MANS) $(DATA) installdirs: installdirs-recursive installdirs-am: - for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(htmlmandir)"; do \ + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(htmldir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: $(BUILT_SOURCES) @@ -609,10 +662,15 @@ install-am: all-am installcheck: installcheck-recursive install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi mostlyclean-generic: clean-generic: @@ -645,7 +703,7 @@ info: info-recursive info-am: -install-data-am: install-htmlmanDATA install-man +install-data-am: install-dist_htmlDATA install-man install-dvi: install-dvi-recursive @@ -689,36 +747,35 @@ ps: ps-recursive ps-am: -uninstall-am: uninstall-htmlmanDATA uninstall-man +uninstall-am: uninstall-dist_htmlDATA uninstall-man uninstall-man: uninstall-man1 uninstall-man5 -.MAKE: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) all check \ - ctags-recursive install install-am install-strip \ - tags-recursive +.MAKE: $(am__recursive_targets) all check install install-am \ + install-strip -.PHONY: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) CTAGS GTAGS \ - all all-am check check-am clean clean-generic ctags \ - ctags-recursive distclean distclean-generic distclean-tags \ - distdir dvi dvi-am html html-am info info-am install \ - install-am install-data install-data-am install-dvi \ +.PHONY: $(am__recursive_targets) CTAGS GTAGS TAGS all all-am check \ + check-am clean clean-generic cscopelist-am ctags ctags-am \ + distclean distclean-generic distclean-tags distdir dvi dvi-am \ + html html-am info info-am install install-am install-data \ + install-data-am install-dist_htmlDATA install-dvi \ install-dvi-am install-exec install-exec-am install-html \ - install-html-am install-htmlmanDATA install-info \ - install-info-am install-man install-man1 install-man5 \ - install-pdf install-pdf-am install-ps install-ps-am \ - install-strip installcheck installcheck-am installdirs \ - installdirs-am maintainer-clean maintainer-clean-generic \ - mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags \ - tags-recursive uninstall uninstall-am uninstall-htmlmanDATA \ - uninstall-man uninstall-man1 uninstall-man5 - - -@GROFF_HTML_TRUE@nano.1.html: nano.1 -@GROFF_HTML_TRUE@ groff -t -mandoc -Thtml < $? > $@ -@GROFF_HTML_TRUE@nanorc.5.html: nanorc.5 -@GROFF_HTML_TRUE@ groff -t -mandoc -Thtml < $? > $@ -@GROFF_HTML_TRUE@rnano.1.html: rnano.1 -@GROFF_HTML_TRUE@ groff -t -mandoc -Thtml < $? > $@ + install-html-am install-info install-info-am install-man \ + install-man1 install-man5 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs installdirs-am maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ + pdf-am ps ps-am tags tags-am uninstall uninstall-am \ + uninstall-dist_htmlDATA uninstall-man uninstall-man1 \ + uninstall-man5 + + +nano.1.html: nano.1 + groff -t -mandoc -Thtml < $? > $@ +nanorc.5.html: nanorc.5 + groff -t -mandoc -Thtml < $? > $@ +rnano.1.html: rnano.1 + groff -t -mandoc -Thtml < $? > $@ # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. diff --git a/doc/man/fr/Makefile.am b/doc/man/fr/Makefile.am index 7a43052..d8c2d18 100644 --- a/doc/man/fr/Makefile.am +++ b/doc/man/fr/Makefile.am @@ -1,23 +1,15 @@ mandir = @mandir@/fr +htmldir = @htmldir@/fr -if USE_NANORC -man_MANS = nano.1 nanorc.5 rnano.1 -if GROFF_HTML -BUILT_SOURCES = nano.1.html nanorc.5.html rnano.1.html -endif -else -man_MANS = nano.1 rnano.1 -if GROFF_HTML -BUILT_SOURCES = nano.1.html rnano.1.html -endif -endif +BUILT_SOURCES = -nano_man_mans = nano.1 nanorc.5 rnano.1 -if GROFF_HTML -htmlman_DATA = nano.1.html nanorc.5.html rnano.1.html -htmlmandir = $(datadir)/nano/man-html/fr +dist_man_MANS = nano.1 rnano.1 +html_pages = nano.1.html rnano.1.html -nano_built_sources = nano.1.html nanorc.5.html rnano.1.html +if USE_NANORC +dist_man_MANS += nanorc.5 +html_pages += nanorc.5.html +endif nano.1.html: nano.1 groff -t -mandoc -Thtml < $? > $@ @@ -26,8 +18,9 @@ nanorc.5.html: nanorc.5 rnano.1.html: rnano.1 groff -t -mandoc -Thtml < $? > $@ -EXTRA_DIST = $(nano_man_mans) $(nano_built_sources) -else -EXTRA_DIST = $(nano_man_mans) +if GROFF_HTML +BUILT_SOURCES += $(html_pages) +dist_html_DATA = $(html_pages) endif +EXTRA_DIST = $(BUILT_SOURCES) diff --git a/doc/man/fr/Makefile.in b/doc/man/fr/Makefile.in index 79d5987..3e3e3ac 100644 --- a/doc/man/fr/Makefile.in +++ b/doc/man/fr/Makefile.in @@ -1,9 +1,8 @@ -# Makefile.in generated by automake 1.11.1 from Makefile.am. +# Makefile.in generated by automake 1.14.1 from Makefile.am. # @configure_input@ -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. +# Copyright (C) 1994-2013 Free Software Foundation, Inc. + # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -16,6 +15,51 @@ @SET_MAKE@ VPATH = @srcdir@ +am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)' +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -34,11 +78,16 @@ PRE_UNINSTALL = : POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ -target_triplet = @target@ +@USE_NANORC_TRUE@am__append_1 = nanorc.5 +@USE_NANORC_TRUE@am__append_2 = nanorc.5.html +@GROFF_HTML_TRUE@am__append_3 = $(html_pages) subdir = doc/man/fr -DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \ + $(top_srcdir)/mkinstalldirs $(dist_man_MANS) \ + $(am__dist_html_DATA_DIST) ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.m4 \ + $(top_srcdir)/m4/ax_check_compile_flag.m4 \ $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/glib-2.0.m4 \ $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/isc-posix.m4 \ $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ @@ -50,8 +99,25 @@ mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = SOURCES = DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; am__vpath_adj = case $$p in \ $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ @@ -73,16 +139,25 @@ am__nobase_list = $(am__nobase_strip_setup); \ am__base_list = \ sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } man1dir = $(mandir)/man1 am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" \ - "$(DESTDIR)$(htmlmandir)" + "$(DESTDIR)$(htmldir)" man5dir = $(mandir)/man5 NROFF = nroff -MANS = $(man_MANS) -DATA = $(htmlman_DATA) +MANS = $(dist_man_MANS) +am__dist_html_DATA_DIST = nano.1.html rnano.1.html nanorc.5.html +DATA = $(dist_html_DATA) +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ @@ -128,6 +203,11 @@ MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGMERGE = @MSGMERGE@ +NCURSESW_CFLAGS = @NCURSESW_CFLAGS@ +NCURSESW_CONFIG = @NCURSESW_CONFIG@ +NCURSESW_LIBS = @NCURSESW_LIBS@ +NCURSES_CFLAGS = @NCURSES_CFLAGS@ +NCURSES_LIBS = @NCURSES_LIBS@ OBJEXT = @OBJEXT@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ @@ -139,6 +219,8 @@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKGDATADIR = @PKGDATADIR@ PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ POSUB = @POSUB@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ @@ -168,12 +250,13 @@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ +haveit = @haveit@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ host_os = @host_os@ host_vendor = @host_vendor@ -htmldir = @htmldir@ +htmldir = @htmldir@/fr includedir = @includedir@ infodir = @infodir@ install_sh = @install_sh@ @@ -192,24 +275,15 @@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ -target = @target@ target_alias = @target_alias@ -target_cpu = @target_cpu@ -target_os = @target_os@ -target_vendor = @target_vendor@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ -@USE_NANORC_FALSE@man_MANS = nano.1 rnano.1 -@USE_NANORC_TRUE@man_MANS = nano.1 nanorc.5 rnano.1 -@GROFF_HTML_TRUE@@USE_NANORC_FALSE@BUILT_SOURCES = nano.1.html rnano.1.html -@GROFF_HTML_TRUE@@USE_NANORC_TRUE@BUILT_SOURCES = nano.1.html nanorc.5.html rnano.1.html -nano_man_mans = nano.1 nanorc.5 rnano.1 -@GROFF_HTML_TRUE@htmlman_DATA = nano.1.html nanorc.5.html rnano.1.html -@GROFF_HTML_TRUE@htmlmandir = $(datadir)/nano/man-html/fr -@GROFF_HTML_TRUE@nano_built_sources = nano.1.html nanorc.5.html rnano.1.html -@GROFF_HTML_FALSE@EXTRA_DIST = $(nano_man_mans) -@GROFF_HTML_TRUE@EXTRA_DIST = $(nano_man_mans) $(nano_built_sources) +BUILT_SOURCES = $(am__append_3) +dist_man_MANS = nano.1 rnano.1 $(am__append_1) +html_pages = nano.1.html rnano.1.html $(am__append_2) +@GROFF_HTML_TRUE@dist_html_DATA = $(html_pages) +EXTRA_DIST = $(BUILT_SOURCES) all: $(BUILT_SOURCES) $(MAKE) $(AM_MAKEFLAGS) all-am @@ -244,13 +318,20 @@ $(top_srcdir)/configure: $(am__configure_deps) $(ACLOCAL_M4): $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(am__aclocal_m4_deps): -install-man1: $(man_MANS) +install-man1: $(dist_man_MANS) @$(NORMAL_INSTALL) - test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)" - @list=''; test -n "$(man1dir)" || exit 0; \ - { for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.1[a-z]*$$/p'; \ + @list1=''; \ + list2='$(dist_man_MANS)'; \ + test -n "$(man1dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man1dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man1dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.1[a-z]*$$/p'; \ + fi; \ } | while read p; do \ if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; echo "$$p"; \ @@ -275,20 +356,25 @@ uninstall-man1: @$(NORMAL_UNINSTALL) @list=''; test -n "$(man1dir)" || exit 0; \ files=`{ for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ sed -n '/\.1[a-z]*$$/p'; \ } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ - test -z "$$files" || { \ - echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(man1dir)" && rm -f $$files; } -install-man5: $(man_MANS) + dir='$(DESTDIR)$(man1dir)'; $(am__uninstall_files_from_dir) +install-man5: $(dist_man_MANS) @$(NORMAL_INSTALL) - test -z "$(man5dir)" || $(MKDIR_P) "$(DESTDIR)$(man5dir)" - @list=''; test -n "$(man5dir)" || exit 0; \ - { for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.5[a-z]*$$/p'; \ + @list1=''; \ + list2='$(dist_man_MANS)'; \ + test -n "$(man5dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man5dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man5dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.5[a-z]*$$/p'; \ + fi; \ } | while read p; do \ if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; echo "$$p"; \ @@ -313,54 +399,40 @@ uninstall-man5: @$(NORMAL_UNINSTALL) @list=''; test -n "$(man5dir)" || exit 0; \ files=`{ for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ sed -n '/\.5[a-z]*$$/p'; \ } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \ -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ - test -z "$$files" || { \ - echo " ( cd '$(DESTDIR)$(man5dir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(man5dir)" && rm -f $$files; } -install-htmlmanDATA: $(htmlman_DATA) + dir='$(DESTDIR)$(man5dir)'; $(am__uninstall_files_from_dir) +install-dist_htmlDATA: $(dist_html_DATA) @$(NORMAL_INSTALL) - test -z "$(htmlmandir)" || $(MKDIR_P) "$(DESTDIR)$(htmlmandir)" - @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || list=; \ + @list='$(dist_html_DATA)'; test -n "$(htmldir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(htmldir)" || exit 1; \ + fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ done | $(am__base_list) | \ while read files; do \ - echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(htmlmandir)'"; \ - $(INSTALL_DATA) $$files "$(DESTDIR)$(htmlmandir)" || exit $$?; \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(htmldir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(htmldir)" || exit $$?; \ done -uninstall-htmlmanDATA: +uninstall-dist_htmlDATA: @$(NORMAL_UNINSTALL) - @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || list=; \ + @list='$(dist_html_DATA)'; test -n "$(htmldir)" || list=; \ files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ - test -n "$$files" || exit 0; \ - echo " ( cd '$(DESTDIR)$(htmlmandir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(htmlmandir)" && rm -f $$files -tags: TAGS -TAGS: + dir='$(DESTDIR)$(htmldir)'; $(am__uninstall_files_from_dir) +tags TAGS: + +ctags CTAGS: -ctags: CTAGS -CTAGS: +cscope cscopelist: distdir: $(DISTFILES) - @list='$(MANS)'; if test -n "$$list"; then \ - list=`for p in $$list; do \ - if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ - if test -f "$$d$$p"; then echo "$$d$$p"; else :; fi; done`; \ - if test -n "$$list" && \ - grep 'ab help2man is required to generate this page' $$list >/dev/null; then \ - echo "error: found man pages containing the \`missing help2man' replacement text:" >&2; \ - grep -l 'ab help2man is required to generate this page' $$list | sed 's/^/ /' >&2; \ - echo " to fix them, install help2man, remove and regenerate the man pages;" >&2; \ - echo " typically \`make maintainer-clean' will remove them" >&2; \ - exit 1; \ - else :; fi; \ - else :; fi @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ list='$(DISTFILES)'; \ @@ -395,7 +467,7 @@ check: $(BUILT_SOURCES) $(MAKE) $(AM_MAKEFLAGS) check-am all-am: Makefile $(MANS) $(DATA) installdirs: - for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(htmlmandir)"; do \ + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(htmldir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: $(BUILT_SOURCES) @@ -409,10 +481,15 @@ install-am: all-am installcheck: installcheck-am install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi mostlyclean-generic: clean-generic: @@ -445,7 +522,7 @@ info: info-am info-am: -install-data-am: install-htmlmanDATA install-man +install-data-am: install-dist_htmlDATA install-man install-dvi: install-dvi-am @@ -489,32 +566,33 @@ ps: ps-am ps-am: -uninstall-am: uninstall-htmlmanDATA uninstall-man +uninstall-am: uninstall-dist_htmlDATA uninstall-man uninstall-man: uninstall-man1 uninstall-man5 .MAKE: all check install install-am install-strip -.PHONY: all all-am check check-am clean clean-generic distclean \ - distclean-generic distdir dvi dvi-am html html-am info info-am \ - install install-am install-data install-data-am install-dvi \ +.PHONY: all all-am check check-am clean clean-generic cscopelist-am \ + ctags-am distclean distclean-generic distdir dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am install-dist_htmlDATA install-dvi \ install-dvi-am install-exec install-exec-am install-html \ - install-html-am install-htmlmanDATA install-info \ - install-info-am install-man install-man1 install-man5 \ - install-pdf install-pdf-am install-ps install-ps-am \ - install-strip installcheck installcheck-am installdirs \ - maintainer-clean maintainer-clean-generic mostlyclean \ - mostlyclean-generic pdf pdf-am ps ps-am uninstall uninstall-am \ - uninstall-htmlmanDATA uninstall-man uninstall-man1 \ + install-html-am install-info install-info-am install-man \ + install-man1 install-man5 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ + pdf-am ps ps-am tags-am uninstall uninstall-am \ + uninstall-dist_htmlDATA uninstall-man uninstall-man1 \ uninstall-man5 -@GROFF_HTML_TRUE@nano.1.html: nano.1 -@GROFF_HTML_TRUE@ groff -t -mandoc -Thtml < $? > $@ -@GROFF_HTML_TRUE@nanorc.5.html: nanorc.5 -@GROFF_HTML_TRUE@ groff -t -mandoc -Thtml < $? > $@ -@GROFF_HTML_TRUE@rnano.1.html: rnano.1 -@GROFF_HTML_TRUE@ groff -t -mandoc -Thtml < $? > $@ +nano.1.html: nano.1 + groff -t -mandoc -Thtml < $? > $@ +nanorc.5.html: nanorc.5 + groff -t -mandoc -Thtml < $? > $@ +rnano.1.html: rnano.1 + groff -t -mandoc -Thtml < $? > $@ # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. diff --git a/doc/man/fr/nano.1 b/doc/man/fr/nano.1 index f840374..fdfb3cd 100644 --- a/doc/man/fr/nano.1 +++ b/doc/man/fr/nano.1 @@ -2,14 +2,14 @@ .\" Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 .\" Free Software Foundation, Inc. .\" -.\" Le travail d'adaptation française de cette page de manuel a été -.\" réalisé par Jean-Philippe Guérard, en 2003, 2004, 2005, 2006 et 2007. +.\" Le travail d'adaptation française de cette page de manuel a été +.\" réalisé par Jean-Philippe Guérard, en 2003, 2004, 2005, 2006 et 2007. .\" Ce travail d'adaptation est dans le domaine public. Attention, la .\" page traduite reste soumise au droit d'auteur de ses auteurs .\" originaux. .\" .\" The French translation of this document is a public domain work of -.\" Jean-Philippe Guérard. This translation work was made in 2003, 2004, +.\" Jean-Philippe Guérard. This translation work was made in 2003, 2004, .\" 2005, 2006 and 2007. The translated man page in itself is still .\" subject to the copyright of its original authors. .\" @@ -29,92 +29,92 @@ .\" Documentation License along with this program. If not, see .\" <http://www.gnu.org/licenses/>. .\" -.\" Ce document est publié sous une double licence. Vous pouvez +.\" Ce document est publié sous une double licence. Vous pouvez .\" le distribuer et le modifier selon les termes de l'une des deux -.\" licences ci-dessous : +.\" licences ci-dessous : .\" -.\" * La Licence publique générale GNU (GNU GPL) version 3 ou, à -.\" votre choix, supérieure, telle que publiée par la Free -.\" Software Foundation. Vous devriez avoir reçu une copie de la -.\" Licence publique générale GNU avec ce programme. Si ce n'est pas +.\" * La Licence publique générale GNU (GNU GPL) version 3 ou, à +.\" votre choix, supérieure, telle que publiée par la Free +.\" Software Foundation. Vous devriez avoir reçu une copie de la +.\" Licence publique générale GNU avec ce programme. Si ce n'est pas .\" le cas, consultez <http://www.gnu.org/licenses/>. .\" .\" * La Licence de documentation libre GNU (GNU FDL), version 1.2 ou, -.\" à votre choix, supérieure, telle que publiée par la Free +.\" à votre choix, supérieure, telle que publiée par la Free .\" Software Foundation, sans section invariante, ni texte de -.\" première ou de quatrième de couverture. Vous devriez avoir reçu +.\" première ou de quatrième de couverture. Vous devriez avoir reçu .\" une copie de la Licence de documentation libre GNU avec ce .\" programme. Si ce n'est pas le cas, consultez .\" <http://www.gnu.org/licenses/>. .\" -.\" $Id: nano.1 4443 2009-11-27 02:50:12Z astyanax $ +.\" $Id: nano.1 5071 2014-07-16 17:25:55Z jordi $ .TH NANO 1 "version 2.0.0" "29\ novembre\ 2007" .\" Please adjust this date whenever revising the manpage. -.\" Merci de modifier ces dates à chaque mise à jour de cette page. +.\" Merci de modifier ces dates à chaque mise à jour de cette page. .\" .SH NOM -nano \- NAno un NOuvel éditeur, un clone libre et amélioré de Pico +nano \- NAno un NOuvel éditeur, un clone libre et amélioré de Pico .SH SYNOPSIS .B nano -.I [OPTIONS]\ [[\+LIGNE,COLONNE]\ FICHIER]... +.I [OPTIONS]\ [[+LIGNE,COLONNE]\ FICHIER]... .br .SH DESCRIPTION -Cette page de manuel décrit brièvement la commande \fBnano\fR. +Cette page de manuel décrit brièvement la commande \fBnano\fR. .PP .\" TeX users may be more comfortable with the \fB<whatever>\fP and .\" \fI<whatever>\fP escape sequences to invoke bold face and italics, .\" respectively. -\fBnano\fR est un éditeur petit, sympathique et libre, qui vise à remplacer -Pico, l'éditeur par défaut du logiciel non libre Pine. \fBnano\fR ne se +\fBnano\fR est un éditeur petit, sympathique et libre, qui vise à remplacer +Pico, l'éditeur par défaut du logiciel non libre Pine. \fBnano\fR ne se contentant pas de copier l'interface et l'ergonomie de Pico, il offre -également certaines fonctions manquantes (ou désactivées par défaut) -dans Pico. Ces fonctionnalités sont, par exemple, les fonctions de -recherche et de remplacement, et la possibilité de sauter directement à -une ligne et à une colonne précise. +également certaines fonctions manquantes (ou désactivées par défaut) +dans Pico. Ces fonctionnalités sont, par exemple, les fonctions de +recherche et de remplacement, et la possibilité de sauter directement à +une ligne et à une colonne précise. .SH OPTIONS .TP -.B \+\fILIGNE\fP,\fICOLONNE\fP -Démarre avec le curseur positionné à la colonne \fICOLONNE\fP de -la ligne \fILIGNE\fR (l'un des deux, au moins, devant être spécifié) au -lieu de démarrer à la colonne\ 1, ligne\ 1. +.B +\fILIGNE\fP,\fICOLONNE\fP +Démarre avec le curseur positionné à la colonne \fICOLONNE\fP de +la ligne \fILIGNE\fR (l'un des deux, au moins, devant être spécifié) au +lieu de démarrer à la colonne\ 1, ligne\ 1. .TP .B \-? -Identique à \fB-h (\-\-help)\fP. +Identique à \fB\-h (\-\-help)\fP. .TP .B \-A (\-\-smarthome) -Rend plus malin le fonctionnement de la touche «\ Début\ ». Lorsque l'on -appuie sur cette touche à n'importe quel endroit excepté au tout début -du texte d'une ligne (i.\ e. au premier caractère non blanc), le curseur -se positionnera au début du texte de la ligne (qu'il soit en avant ou en -arrière). Si le curseur est déjà là, il se placera au vrai début de la +Rend plus malin le fonctionnement de la touche «\ Début\ ». Lorsque l'on +appuie sur cette touche à n'importe quel endroit excepté au tout début +du texte d'une ligne (i.\ e. au premier caractère non blanc), le curseur +se positionnera au début du texte de la ligne (qu'il soit en avant ou en +arrière). Si le curseur est déjà là , il se placera au vrai début de la ligne. .TP .B \-B (\-\-backup) -Lors de l'écriture d'un fichier, crée une copie de sécurité de la -version précédente, en ajoutant un tilde (~) au nom du fichier. +Lors de l'écriture d'un fichier, crée une copie de sécurité de la +version précédente, en ajoutant un tilde (~) au nom du fichier. .TP .B \-D (\-\-boldtext) -Utilise des caractères gras à la place de la vidéo inverse. +Utilise des caractères gras à la place de la vidéo inverse. .TP -.B \-C \fIrépertoire\fP (\-\-backupdir=\fIrépertoire\fP) -Définit le répertoire utilisé par \fBnano\fP pour enregistrer les copies -de sécurité uniques si celles-ci sont activées. +.B \-C \fIrépertoire\fP (\-\-backupdir=\fIrépertoire\fP) +Définit le répertoire utilisé par \fBnano\fP pour enregistrer les copies +de sécurité uniques si celles-ci sont activées. .TP .B \-E (\-\-tabstospaces) Convertit les tabulations clavier en espaces. .TP .B \-F (\-\-multibuffer) -Active le mode multi-espace, autorisant l'édition simultanée de +Active le mode multi-espace, autorisant l'édition simultanée de plusieurs fichiers, si ce mode est disponible. .TP .B \-H (\-\-historylog) -Enregistre les chaînes ayant fait l'objet d'une recherche ou d'un +Enregistre les chaînes ayant fait l'objet d'une recherche ou d'un remplacement dans le fichier \fI~/.nano_history\fR afin de permettre leur -réutilisation. Ceci n'est possible que si \fBnano\fR est configuré pour +réutilisation. Ceci n'est possible que si \fBnano\fR est configuré pour utiliser les fichiers nanorc. .TP .B \-I (\-\-ignorercfiles) @@ -122,63 +122,63 @@ Ne pas utiliser pas les fichiers \fISYSCONFDIR/nanorc\fR et \fI~/.nanorc\fR (si \fBnano\fR est capable de les utiliser). .TP .B \-K (\-\-rebindkeypad) -Interprète les touches du pavé numérique afin qu'elles fonctionnent +Interprète les touches du pavé numérique afin qu'elles fonctionnent toutes correctement. Vous ne devriez utiliser cette option que si ce n'est pas le cas, car nano ne sera plus capable d'utiliser la souris -correctement lorsque cette option sera activée. +correctement lorsque cette option sera activée. .TP .B \-L (\-\-nonewlines) -Ne pas ajouter de passage à la ligne à la fin des fichiers. +Ne pas ajouter de passage à la ligne à la fin des fichiers. .TP .B \-N (\-\-noconvert) -Désactive la conversion automatique des fichiers depuis les formats Mac et +Désactive la conversion automatique des fichiers depuis les formats Mac et DOS. .TP .B \-O (\-\-morespace) -Utiliser la ligne blanche située sous la ligne de titre comme -espace supplémentaire d'édition. +Utiliser la ligne blanche située sous la ligne de titre comme +espace supplémentaire d'édition. .TP -.B \-Q \fIchaîne\fP (\-\-quotestr=\fIchaîne\fP) -Définit le préfixe par défaut des citations. Nano utilise ce préfixe -pour réaliser une justification correcte des citations. Si nano est -capable d'utiliser des expressions rationnelles, le préfixe par défaut +.B \-Q \fIchaîne\fP (\-\-quotestr=\fIchaîne\fP) +Définit le préfixe par défaut des citations. Nano utilise ce préfixe +pour réaliser une justification correcte des citations. Si nano est +capable d'utiliser des expressions rationnelles, le préfixe par défaut sera "\fI^([\ \\t]*[#:>\\|}])+\fP", sinon, ce sera "\fI>\ \fP". Dans -l'expression rationnelle précédente, «\ \fI\\t\fP\ » représente une +l'expression rationnelle précédente, «\ \fI\\t\fP\ » représente une tabulation. .TP .B \-R (\-\-restricted) -Mode restreint\ : aucune lecture ou écriture de fichiers non indiqués +Mode restreint\ : aucune lecture ou écriture de fichiers non indiqués sur la ligne de commande, pas de lecture des fichiers nanorc, -interdiction de suspendre, interdiction d'ajouter au début, à la fin, -de sauvegarder un fichier ayant déjà un nom sous un nom différent, -d'utiliser une copie de sécurité ou le correcteur orthographique. Cette -option peut aussi être activée en appelant \fBnano\fP sous un nom -commençant par «\ r\ » (par exemple «\ rnano\ »). +interdiction de suspendre, interdiction d'ajouter au début, à la fin, +de sauvegarder un fichier ayant déjà un nom sous un nom différent, +d'utiliser une copie de sécurité ou le correcteur orthographique. Cette +option peut aussi être activée en appelant \fBnano\fP sous un nom +commençant par «\ r\ » (par exemple «\ rnano\ »). .TP .B \-S (\-\-smooth) -Active le défilement progressif. Le texte défilera ligne-par-ligne au lieu -de défiler morceau-par-morceau. +Active le défilement progressif. Le texte défilera ligne-par-ligne au lieu +de défiler morceau-par-morceau. .TP .B \-T \fInombre\fP (\-\-tabsize=\fInombre\fP) -Définit la taille (largeur) des tabulations en nombre de colonnes. Le -nombre indiqué doit être strictement supérieur à 0. La valeur par défaut +Définit la taille (largeur) des tabulations en nombre de colonnes. Le +nombre indiqué doit être strictement supérieur à 0. La valeur par défaut est de 8. .TP .B \-U (\-\-quickblank) -Effacement rapide de la ligne d'état. Les messages affichés par la ligne -d'état disparaîtront après une frappe clavier au lieu de 25. Notez que +Effacement rapide de la ligne d'état. Les messages affichés par la ligne +d'état disparaîtront après une frappe clavier au lieu de 25. Notez que l'option \fB-c\fP prend le pas sur cette option. .TP .B \-V (\-\-version) -Affiche la version, puis s'arrête. +Affiche la version, puis s'arrête. .TP .B \-W (\-\-wordbounds) -Détection plus précise des limites de mots, obtenue en considérant les -caractères de ponctuation comme faisant partie des mots. +Détection plus précise des limites de mots, obtenue en considérant les +caractères de ponctuation comme faisant partie des mots. .TP -.B \-Y \fIchaîne\fP (\-\-syntax=\fIchaîne\fP) +.B \-Y \fIchaîne\fP (\-\-syntax=\fIchaîne\fP) Indique quel mode de colorisation syntaxique adopter, parmi les modes -définis dans le fichier \fI.nanorc\fR, si cette fonctionnalité est +définis dans le fichier \fI.nanorc\fR, si cette fonctionnalité est disponible. .TP .B \-c (\-\-const) @@ -186,111 +186,111 @@ Affiche en permanence la position du curseur. Notez que cette option prend le pas sur l'option \fB-U\fP. .TP .B \-d (\-\-rebinddelete) -Interprète différemment la touche «\ Supprimer\ », afin que les touches -«\ Effacement arrière\ » et «\ Supprimer\ » fonctionnent correctement. -Vous ne devriez avoir besoin de cette option que si, sur votre système, -la touche «\ Effacement arrière\ » produit l'effet de la touche -«\ Supprimer\ ». +Interprète différemment la touche «\ Supprimer\ », afin que les touches +«\ Effacement arrière\ » et «\ Supprimer\ » fonctionnent correctement. +Vous ne devriez avoir besoin de cette option que si, sur votre système, +la touche «\ Effacement arrière\ » produit l'effet de la touche +«\ Supprimer\ ». .TP .B \-h (\-\-help) -Affiche un résumé des options de lancement de nano, puis s'arrête. +Affiche un résumé des options de lancement de nano, puis s'arrête. .TP .B \-i (\-\-autoindent) -Indentation automatique. Commence chaque nouvelle ligne au même niveau que -la ligne précédente. Utile pour l'édition de code source. +Indentation automatique. Commence chaque nouvelle ligne au même niveau que +la ligne précédente. Utile pour l'édition de code source. .TP .B \-k (\-\-cut) -Coupe le texte du curseur à la fin de la ligne, au lieu de couper la -ligne entière. +Coupe le texte du curseur à la fin de la ligne, au lieu de couper la +ligne entière. .TP .B \-l (\-\-nofollow) -Si le fichier édité est un lien symbolique, au lieu de le suivre, -remplace le lien par le nouveau fichier. Sans doute utile pour éditer +Si le fichier édité est un lien symbolique, au lieu de le suivre, +remplace le lien par le nouveau fichier. Sans doute utile pour éditer les fichiers de \fI/tmp\fR, non\ ? .TP .B \-m (\-\-mouse) Active l'utilisation de la souris, si elle est disponible pour votre -système. Lorsque celle-ci est activée, il est possible d'utiliser la +système. Lorsque celle-ci est activée, il est possible d'utiliser la souris pour positionner le curseur, pour marquer le texte (avec un double-clic) et pour lancer les fonctions correspondant aux raccourcis. Il est possible d'utiliser la souris sous X\ Window ou en mode console avec gpm. .TP -.B \-o \fIrépertoire\fP (\-\-operatingdir=\fIrépertoire\fP) -Définit le répertoire de travail. Demande à \fBnano\fP de mettre en place -quelque chose de similaire à un environnement d'exécution restreint +.B \-o \fIrépertoire\fP (\-\-operatingdir=\fIrépertoire\fP) +Définit le répertoire de travail. Demande à \fBnano\fP de mettre en place +quelque chose de similaire à un environnement d'exécution restreint (\fIchroot\fR). .TP .B \-p (\-\-preserve) -Préserve les séquences XON et XOFF (^Q et ^S), afin qu'elle soient reçues +Préserve les séquences XON et XOFF (^Q et ^S), afin qu'elle soient reçues par le terminal. .TP .B \-r \fIcolonne\fP (\-\-fill=\fIcolonne\fP) -Passe automatiquement à la ligne une fois arrivé à la colonne -\fIcolonne\fR. Si la valeur indiquée est de 0 ou moins, le point de -passage à la ligne aura lieu à la taille de l'écran moins \fIcolonne\fR. -Cela permet de faire varier le point de passage à la ligne lorsque l'on -change la taille de l'écran. La valeur par défaut est de \-8. +Passe automatiquement à la ligne une fois arrivé à la colonne +\fIcolonne\fR. Si la valeur indiquée est de 0 ou moins, le point de +passage à la ligne aura lieu à la taille de l'écran moins \fIcolonne\fR. +Cela permet de faire varier le point de passage à la ligne lorsque l'on +change la taille de l'écran. La valeur par défaut est de \-8. .TP .B \-s \fIprogramme\fP (\-\-speller=\fIprogramme\fP) Choix d'un correcteur orthographique de remplacement. .TP .B \-t (\-\-tempfile) -S'il a été modifié, le fichier sera sauvegardé automatiquement sans -demande de confirmation. Identique à l'option \fB-t\fP de Pico. +S'il a été modifié, le fichier sera sauvegardé automatiquement sans +demande de confirmation. Identique à l'option \fB-t\fP de Pico. .TP .B \-v (\-\-view) Mode visualisation (lecture seule). .TP .B \-w (\-\-nowrap) -Désactive le passage automatique à la ligne. +Désactive le passage automatique à la ligne. .TP .B \-x (\-\-nohelp) -Désactive la barre d'aide affichée en bas de l'écran. +Désactive la barre d'aide affichée en bas de l'écran. .TP .B \-z (\-\-suspend) -Autorise à suspendre l'éditeur. +Autorise à suspendre l'éditeur. .TP .B \-a, \-b, \-e, \-f, \-g, \-j -Ignoré, pour être compatible avec Pico. +Ignoré, pour être compatible avec Pico. .SH "FICHIERS D'INITIALISATION" \fBnano\fR lit les fichiers d'initialisation dans l'ordre suivant\ : -\fISYSCONFDIR/nanorc\fR, puis \fI~/.nanorc\fR. Référez-vous à la page de +\fISYSCONFDIR/nanorc\fR, puis \fI~/.nanorc\fR. Référez-vous à la page de manuel de \fBnanorc(5)\fR et au fichier d'exemple \fInanorc.sample\fR, -qui devraient tous les deux être livrés avec \fBnano\fR. +qui devraient tous les deux être livrés avec \fBnano\fR. .SH NOTES -Si aucun correcteur orthographique de remplacement n'est indiqué dans la +Si aucun correcteur orthographique de remplacement n'est indiqué dans la ligne de commande ou dans l'un des fichiers nanorc, \fBnano\fR prendra -la commande indiquée par la variable d'environnement \fBSPELL\fR si -elle est définie. +la commande indiquée par la variable d'environnement \fBSPELL\fR si +elle est définie. Dans certains cas, \fBnano\fR essaiera de sauvegarder le fichier en cours -d'édition dans un fichier de secours. Cela arrivera principalement si -\fBnano\fR reçoit un signal SIGHUP ou SIGTERM, ou bien se trouve à court de -mémoire. Le nom de ce fichier de secours sera \fInano.save\fR si le fichier en -cours n'avait pas encore de nom, ou sera composé du nom du fichier en cours -suivi du suffixe «\ .save\ ». Si un fichier de ce nom existe déjà dans -le répertoire, un «\ .save\ » et un nombre seront ajoutés à la fin du +d'édition dans un fichier de secours. Cela arrivera principalement si +\fBnano\fR reçoit un signal SIGHUP ou SIGTERM, ou bien se trouve à court de +mémoire. Le nom de ce fichier de secours sera \fInano.save\fR si le fichier en +cours n'avait pas encore de nom, ou sera composé du nom du fichier en cours +suivi du suffixe «\ .save\ ». Si un fichier de ce nom existe déjà dans +le répertoire, un «\ .save\ » et un nombre seront ajoutés à la fin du nom du fichier en cours afin de le rendre unique (par exemple, -«\ .save.1\ »). En mode multi-espace, \fBnano\fR réalisera une +«\ .save.1\ »). En mode multi-espace, \fBnano\fR réalisera une sauvegarde de tous les fichiers en cours dans leurs fichiers de secours respectifs. .SH BOGUES Merci de nous faire parvenir vos commentaires et de nous signaler les -bogues, en écrivant, en anglais, à \fBnano@nano-editor.org\fR. +bogues, en écrivant, en anglais, à \fBnano@nano-editor.org\fR. -La liste de discussion anglophone \fBnano\fR est disponible à l'adresse +La liste de discussion anglophone \fBnano\fR est disponible à l'adresse \fBnano-devel@gnu.org\fR. -Pour vous abonner, envoyez un courrier électronique à -\fBnano-devel-request@gnu.org\fR, ayant pour objet «\ subscribe\ ». +Pour vous abonner, envoyez un courrier électronique à +\fBnano-devel-request@gnu.org\fR, ayant pour objet «\ subscribe\ ». -N'hésitez pas également à envoyez vos commentaires, suggestions et -corrections relatives à l'adaptation française de cette page de manuel -ou du logiciel à \fBjean-philippe.guerard@tigreraye.org\fR. +N'hésitez pas également à envoyez vos commentaires, suggestions et +corrections relatives à l'adaptation française de cette page de manuel +ou du logiciel à \fBjean-philippe.guerard@tigreraye.org\fR. .SH "SITE INTERNET" http://www.nano-editor.org/ @@ -300,27 +300,27 @@ http://www.nano-editor.org/ .TP \fBnanorc\fR(5) .PP -\fI/usr/share/doc/nano/\fR (ou son équivalent sur votre système) +\fI/usr/share/doc/nano/\fR (ou son équivalent sur votre système) .SH AUTEUR Chris Allegretta <chrisa@asty.org> et d'autres (voir les fichiers \fIAUTHORS\fR et \fITHANKS\fR pour plus d'information). Cette page de -manuel a été initialement rédigée par Jordi Mallach <jordi@gnu.org> pour -le système Debian (mais elle peut être utilisée par d'autres). +manuel a été initialement rédigée par Jordi Mallach <jordi@gnu.org> pour +le système Debian (mais elle peut être utilisée par d'autres). .SH TRADUCTION -Cette adaptation française a été réalisée par Jean-Philippe\ Guérard -<jean-philippe.guerard@tigreraye.org> le 29\ novembre\ 2007 à partir +Cette adaptation française a été réalisée par Jean-Philippe\ Guérard +<jean-philippe.guerard@tigreraye.org> le 29\ novembre\ 2007 à partir de la version 1.54 du 11\ octobre\ 2007 de la page de manuel de nano -2.0.0. Cette page a été relue par Gérard Delafond. +2.0.0. Cette page a été relue par Gérard Delafond. -Un maximum de soin a été apporté lors de l'élaboration de cette -traduction\ ; néanmoins, quelques imperfections peuvent subsister. Si -vous en rencontrez, que ce soit dans la version française ou dans la -version originale, n'hésitez pas à les signaler à l'auteur ou au +Un maximum de soin a été apporté lors de l'élaboration de cette +traduction\ ; néanmoins, quelques imperfections peuvent subsister. Si +vous en rencontrez, que ce soit dans la version française ou dans la +version originale, n'hésitez pas à les signaler à l'auteur ou au traducteur. -La version originale la plus à jour de ce document est toujours +La version originale la plus à jour de ce document est toujours consultable via la commande\ : LANGUAGE=en man nano diff --git a/doc/man/fr/nano.1.html b/doc/man/fr/nano.1.html index e8f9548..e7085e9 100644 --- a/doc/man/fr/nano.1.html +++ b/doc/man/fr/nano.1.html @@ -1,5 +1,5 @@ -<!-- Creator : groff version 1.20.1 --> -<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Thu Jul 17 11:02:17 2014 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -41,8 +41,8 @@ <p style="margin-left:11%; margin-top: 1em">nano − -NAno un NOuvel éditeur, un clone libre et -amélioré de Pico</p> +NAno un NOuvel éditeur, un clone libre et +amélioré de Pico</p> <h2>SYNOPSIS <a name="SYNOPSIS"></a> @@ -58,21 +58,23 @@ amélioré de Pico</p> <p style="margin-left:11%; margin-top: 1em">Cette page de -manuel décrit brièvement la commande -<b>nano</b>.</p> +manuel décrit brièvement la +commande <b>nano</b>.</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> est -un éditeur petit, sympathique et libre, qui vise -à remplacer Pico, l’éditeur par -défaut du logiciel non libre Pine. <b>nano</b> ne se -contentant pas de copier l’interface et -l’ergonomie de Pico, il offre également -certaines fonctions manquantes (ou désactivées -par défaut) dans Pico. Ces fonctionnalités -sont, par exemple, les fonctions de recherche et de -remplacement, et la possibilité de sauter directement -à une ligne et à une colonne -précise.</p> +un éditeur petit, sympathique et libre, qui +vise à remplacer Pico, +l’éditeur par défaut du +logiciel non libre Pine. <b>nano</b> ne se contentant pas de +copier l’interface et l’ergonomie de Pico, il +offre également certaines fonctions manquantes +(ou désactivées par +défaut) dans Pico. Ces +fonctionnalités sont, par exemple, les +fonctions de recherche et de remplacement, et la +possibilité de sauter directement +à une ligne et à une colonne +précise.</p> <h2>OPTIONS <a name="OPTIONS"></a> @@ -82,11 +84,12 @@ précise.</p> <p style="margin-left:11%; margin-top: 1em"><b>+</b><i>LIGNE</i><b>,</b><i>COLONNE</i></p> -<p style="margin-left:22%;">Démarre avec le curseur -positionné à la colonne <i>COLONNE</i> de la -ligne <i>LIGNE</i> (l’un des deux, au moins, devant -être spécifié) au lieu de -démarrer à la colonne 1, +<p style="margin-left:22%;">Démarre avec le +curseur positionné à la colonne +<i>COLONNE</i> de la ligne <i>LIGNE</i> (l’un des +deux, au moins, devant être +spécifié) au lieu de +démarrer à la colonne 1, ligne 1.</p> <table width="100%" border="0" rules="none" frame="void" @@ -98,11 +101,12 @@ ligne 1.</p> <p><b>−?</b></p></td> <td width="8%"></td> -<td width="36%"> +<td width="38%"> -<p>Identique à <b>-h (−−help)</b>.</p></td> -<td width="42%"> +<p>Identique à <b>−h +(−−help)</b>.</p> </td> +<td width="40%"> </td></tr> </table> @@ -111,39 +115,42 @@ ligne 1.</p> <p style="margin-left:22%;">Rend plus malin le fonctionnement de la touche -« Début ». Lorsque l’on -appuie sur cette touche à n’importe quel -endroit excepté au tout début du texte -d’une ligne (i. e. au premier caractère -non blanc), le curseur se positionnera au début du -texte de la ligne (qu’il soit en avant ou en -arrière). Si le curseur est déjà -là, il se placera au vrai début de la -ligne.</p> +« Début ». +Lorsque l’on appuie sur cette touche à +n’importe quel endroit excepté au tout +début du texte d’une ligne (i. e. au +premier caractère non blanc), le curseur se +positionnera au début du texte de la ligne +(qu’il soit en avant ou en arrière). Si le +curseur est déjà là , +il se placera au vrai début de la ligne.</p> <p style="margin-left:11%;"><b>−B (−−backup)</b></p> -<p style="margin-left:22%;">Lors de l’écriture -d’un fichier, crée une copie de -sécurité de la version -précédente, en ajoutant un tilde (~) au nom du -fichier.</p> +<p style="margin-left:22%;">Lors de +l’écriture d’un fichier, +crée une copie de +sécurité de la version +précédente, en ajoutant un tilde +(~) au nom du fichier.</p> <p style="margin-left:11%;"><b>−D (−−boldtext)</b></p> -<p style="margin-left:22%;">Utilise des caractères -gras à la place de la vidéo inverse.</p> +<p style="margin-left:22%;">Utilise des +caractères gras à la place de la +vidéo inverse.</p> <p style="margin-left:11%;"><b>−C</b> -<i>répertoire</i> -<b>(−−backupdir=</b><i>répertoire</i><b>)</b></p> +<i>répertoire</i> +<b>(−−backupdir=</b><i>répertoire</i><b>)</b></p> -<p style="margin-left:22%;">Définit le -répertoire utilisé par <b>nano</b> pour -enregistrer les copies de sécurité uniques si -celles-ci sont activées.</p> +<p style="margin-left:22%;">Définit le +répertoire utilisé par <b>nano</b> +pour enregistrer les copies de +sécurité uniques si celles-ci sont +activées.</p> <p style="margin-left:11%;"><b>−E (−−tabstospaces)</b></p> @@ -155,18 +162,20 @@ clavier en espaces.</p> (−−multibuffer)</b></p> <p style="margin-left:22%;">Active le mode multi-espace, -autorisant l’édition simultanée de -plusieurs fichiers, si ce mode est disponible.</p> +autorisant l’édition +simultanée de plusieurs fichiers, si ce mode +est disponible.</p> <p style="margin-left:11%;"><b>−H (−−historylog)</b></p> -<p style="margin-left:22%;">Enregistre les chaînes -ayant fait l’objet d’une recherche ou d’un -remplacement dans le fichier <i>~/.nano_history</i> afin de -permettre leur réutilisation. Ceci n’est -possible que si <b>nano</b> est configuré pour -utiliser les fichiers nanorc.</p> +<p style="margin-left:22%;">Enregistre les +chaînes ayant fait l’objet d’une +recherche ou d’un remplacement dans le fichier +<i>~/.nano_history</i> afin de permettre leur +réutilisation. Ceci n’est possible que si +<b>nano</b> est configuré pour utiliser les +fichiers nanorc.</p> <p style="margin-left:11%;"><b>−I (−−ignorercfiles)</b></p> @@ -178,110 +187,120 @@ fichiers <i>SYSCONFDIR/nanorc</i> et <i>~/.nanorc</i> (si <p style="margin-left:11%;"><b>−K (−−rebindkeypad)</b></p> -<p style="margin-left:22%;">Interprète les touches -du pavé numérique afin qu’elles -fonctionnent toutes correctement. Vous ne devriez utiliser -cette option que si ce n’est pas le cas, car nano ne -sera plus capable d’utiliser la souris correctement -lorsque cette option sera activée.</p> +<p style="margin-left:22%;">Interprète les +touches du pavé numérique afin +qu’elles fonctionnent toutes correctement. Vous ne +devriez utiliser cette option que si ce n’est pas le +cas, car nano ne sera plus capable d’utiliser la +souris correctement lorsque cette option sera +activée.</p> <p style="margin-left:11%;"><b>−L (−−nonewlines)</b></p> <p style="margin-left:22%;">Ne pas ajouter de passage -à la ligne à la fin des fichiers.</p> +à la ligne à la fin des +fichiers.</p> <p style="margin-left:11%;"><b>−N (−−noconvert)</b></p> -<p style="margin-left:22%;">Désactive la conversion -automatique des fichiers depuis les formats Mac et DOS.</p> +<p style="margin-left:22%;">Désactive la +conversion automatique des fichiers depuis les formats Mac +et DOS.</p> <p style="margin-left:11%;"><b>−O (−−morespace)</b></p> <p style="margin-left:22%;">Utiliser la ligne blanche -située sous la ligne de titre comme espace -supplémentaire d’édition.</p> +située sous la ligne de titre comme espace +supplémentaire +d’édition.</p> <p style="margin-left:11%;"><b>−Q</b> -<i>chaîne</i> -<b>(−−quotestr=</b><i>chaîne</i><b>)</b></p> - -<p style="margin-left:22%;">Définit le -préfixe par défaut des citations. Nano utilise -ce préfixe pour réaliser une justification -correcte des citations. Si nano est capable d’utiliser -des expressions rationnelles, le préfixe par -défaut sera +<i>chaîne</i> +<b>(−−quotestr=</b><i>chaîne</i><b>)</b></p> + +<p style="margin-left:22%;">Définit le +préfixe par défaut des citations. +Nano utilise ce préfixe pour +réaliser une justification correcte des +citations. Si nano est capable d’utiliser des +expressions rationnelles, le préfixe par +défaut sera "<i>^([ \t]*[#:>\|}])+</i>", sinon, ce sera "<i>> </i>". Dans l’expression -rationnelle précédente, -« <i>\t </i>» représente une -tabulation.</p> +rationnelle précédente, +« <i>\t </i>» +représente une tabulation.</p> <p style="margin-left:11%;"><b>−R (−−restricted)</b></p> <p style="margin-left:22%;">Mode restreint : aucune -lecture ou écriture de fichiers non indiqués -sur la ligne de commande, pas de lecture des fichiers -nanorc, interdiction de suspendre, interdiction -d’ajouter au début, à la fin, de -sauvegarder un fichier ayant déjà un nom sous -un nom différent, d’utiliser une copie de -sécurité ou le correcteur orthographique. -Cette option peut aussi être activée en -appelant <b>nano</b> sous un nom commençant par -« r » (par exemple -« rnano »).</p> +lecture ou écriture de fichiers non +indiqués sur la ligne de commande, pas de +lecture des fichiers nanorc, interdiction de suspendre, +interdiction d’ajouter au début, +à la fin, de sauvegarder un fichier ayant +déjà un nom sous un nom +différent, d’utiliser une copie de +sécurité ou le correcteur +orthographique. Cette option peut aussi être +activée en appelant <b>nano</b> sous un nom +commençant par +« r » (par exemple +« rnano »).</p> <p style="margin-left:11%;"><b>−S (−−smooth)</b></p> -<p style="margin-left:22%;">Active le défilement -progressif. Le texte défilera ligne-par-ligne au lieu -de défiler morceau-par-morceau.</p> +<p style="margin-left:22%;">Active le +défilement progressif. Le texte +défilera ligne-par-ligne au lieu de +défiler morceau-par-morceau.</p> <p style="margin-left:11%;"><b>−T</b> <i>nombre</i> <b>(−−tabsize=</b><i>nombre</i><b>)</b></p> -<p style="margin-left:22%;">Définit la taille +<p style="margin-left:22%;">Définit la taille (largeur) des tabulations en nombre de colonnes. Le nombre -indiqué doit être strictement supérieur -à 0. La valeur par défaut est de 8.</p> +indiqué doit être strictement +supérieur à 0. La valeur par +défaut est de 8.</p> <p style="margin-left:11%;"><b>−U (−−quickblank)</b></p> <p style="margin-left:22%;">Effacement rapide de la ligne -d’état. Les messages affichés par la -ligne d’état disparaîtront après -une frappe clavier au lieu de 25. Notez que l’option -<b>-c</b> prend le pas sur cette option.</p> +d’état. Les messages +affichés par la ligne d’état +disparaîtront après une frappe +clavier au lieu de 25. Notez que l’option <b>-c</b> +prend le pas sur cette option.</p> <p style="margin-left:11%;"><b>−V (−−version)</b></p> <p style="margin-left:22%;">Affiche la version, puis -s’arrête.</p> +s’arrête.</p> <p style="margin-left:11%;"><b>−W (−−wordbounds)</b></p> -<p style="margin-left:22%;">Détection plus -précise des limites de mots, obtenue en -considérant les caractères de ponctuation -comme faisant partie des mots.</p> +<p style="margin-left:22%;">Détection plus +précise des limites de mots, obtenue en +considérant les caractères de +ponctuation comme faisant partie des mots.</p> <p style="margin-left:11%;"><b>−Y</b> -<i>chaîne</i> -<b>(−−syntax=</b><i>chaîne</i><b>)</b></p> +<i>chaîne</i> +<b>(−−syntax=</b><i>chaîne</i><b>)</b></p> <p style="margin-left:22%;">Indique quel mode de colorisation syntaxique adopter, parmi les modes -définis dans le fichier <i>.nanorc</i>, si cette -fonctionnalité est disponible.</p> +définis dans le fichier <i>.nanorc</i>, si +cette fonctionnalité est disponible.</p> <p style="margin-left:11%;"><b>−c (−−const)</b></p> @@ -293,89 +312,95 @@ l’option <b>-U</b>.</p> <p style="margin-left:11%;"><b>−d (−−rebinddelete)</b></p> -<p style="margin-left:22%;">Interprète -différemment la touche -« Supprimer », afin que les touches -« Effacement arrière » et -« Supprimer » fonctionnent -correctement. Vous ne devriez avoir besoin de cette option -que si, sur votre système, la touche -« Effacement arrière » produit +<p style="margin-left:22%;">Interprète +différemment la touche +« Supprimer », afin que +les touches « Effacement +arrière » et +« Supprimer » +fonctionnent correctement. Vous ne devriez avoir besoin de +cette option que si, sur votre système, la +touche « Effacement +arrière » produit l’effet de la touche -« Supprimer ».</p> +« Supprimer ».</p> <p style="margin-left:11%;"><b>−h (−−help)</b></p> -<p style="margin-left:22%;">Affiche un résumé -des options de lancement de nano, puis -s’arrête.</p> +<p style="margin-left:22%;">Affiche un +résumé des options de lancement de +nano, puis s’arrête.</p> <p style="margin-left:11%;"><b>−i (−−autoindent)</b></p> <p style="margin-left:22%;">Indentation automatique. -Commence chaque nouvelle ligne au même niveau que la -ligne précédente. Utile pour -l’édition de code source.</p> +Commence chaque nouvelle ligne au même niveau +que la ligne précédente. Utile +pour l’édition de code source.</p> <p style="margin-left:11%;"><b>−k (−−cut)</b></p> <p style="margin-left:22%;">Coupe le texte du curseur -à la fin de la ligne, au lieu de couper la ligne -entière.</p> +à la fin de la ligne, au lieu de couper la +ligne entière.</p> <p style="margin-left:11%;"><b>−l (−−nofollow)</b></p> <p style="margin-left:22%;">Si le fichier -édité est un lien symbolique, au lieu de le -suivre, remplace le lien par le nouveau fichier. Sans doute -utile pour éditer les fichiers de <i>/tmp</i>, -non ?</p> +édité est un lien symbolique, au +lieu de le suivre, remplace le lien par le nouveau fichier. +Sans doute utile pour éditer les fichiers de +<i>/tmp</i>, non ?</p> <p style="margin-left:11%;"><b>−m (−−mouse)</b></p> <p style="margin-left:22%;">Active l’utilisation de -la souris, si elle est disponible pour votre système. -Lorsque celle-ci est activée, il est possible -d’utiliser la souris pour positionner le curseur, pour -marquer le texte (avec un double-clic) et pour lancer les -fonctions correspondant aux raccourcis. Il est possible +la souris, si elle est disponible pour votre +système. Lorsque celle-ci est +activée, il est possible d’utiliser la +souris pour positionner le curseur, pour marquer le texte +(avec un double-clic) et pour lancer les fonctions +correspondant aux raccourcis. Il est possible d’utiliser la souris sous X Window ou en mode console avec gpm.</p> <p style="margin-left:11%;"><b>−o</b> -<i>répertoire</i> -<b>(−−operatingdir=</b><i>répertoire</i><b>)</b></p> - -<p style="margin-left:22%;">Définit le -répertoire de travail. Demande à <b>nano</b> -de mettre en place quelque chose de similaire à un -environnement d’exécution restreint +<i>répertoire</i> +<b>(−−operatingdir=</b><i>répertoire</i><b>)</b></p> + +<p style="margin-left:22%;">Définit le +répertoire de travail. Demande à +<b>nano</b> de mettre en place quelque chose de similaire +à un environnement +d’exécution restreint (<i>chroot</i>).</p> <p style="margin-left:11%;"><b>−p (−−preserve)</b></p> -<p style="margin-left:22%;">Préserve les -séquences XON et XOFF (^Q et ^S), afin qu’elle -soient reçues par le terminal.</p> +<p style="margin-left:22%;">Préserve les +séquences XON et XOFF (^Q et ^S), afin +qu’elle soient reçues par le +terminal.</p> <p style="margin-left:11%;"><b>−r</b> <i>colonne</i> <b>(−−fill=</b><i>colonne</i><b>)</b></p> -<p style="margin-left:22%;">Passe automatiquement à -la ligne une fois arrivé à la colonne -<i>colonne</i>. Si la valeur indiquée est de 0 ou -moins, le point de passage à la ligne aura lieu -à la taille de l’écran moins -<i>colonne</i>. Cela permet de faire varier le point de -passage à la ligne lorsque l’on change la -taille de l’écran. La valeur par défaut -est de −8.</p> +<p style="margin-left:22%;">Passe automatiquement +à la ligne une fois arrivé +à la colonne <i>colonne</i>. Si la valeur +indiquée est de 0 ou moins, le point de passage +à la ligne aura lieu à la taille +de l’écran moins <i>colonne</i>. Cela +permet de faire varier le point de passage à la +ligne lorsque l’on change la taille de +l’écran. La valeur par +défaut est de −8.</p> <p style="margin-left:11%;"><b>−s</b> <i>programme</i> @@ -387,10 +412,11 @@ orthographique de remplacement.</p> <p style="margin-left:11%;"><b>−t (−−tempfile)</b></p> -<p style="margin-left:22%;">S’il a été -modifié, le fichier sera sauvegardé -automatiquement sans demande de confirmation. Identique -à l’option <b>-t</b> de Pico.</p> +<p style="margin-left:22%;">S’il a +été modifié, le +fichier sera sauvegardé automatiquement sans +demande de confirmation. Identique à +l’option <b>-t</b> de Pico.</p> <p style="margin-left:11%;"><b>−v (−−view)</b></p> @@ -401,27 +427,27 @@ seule).</p> <p style="margin-left:11%;"><b>−w (−−nowrap)</b></p> -<p style="margin-left:22%;">Désactive le passage -automatique à la ligne.</p> +<p style="margin-left:22%;">Désactive le +passage automatique à la ligne.</p> <p style="margin-left:11%;"><b>−x (−−nohelp)</b></p> -<p style="margin-left:22%;">Désactive la barre -d’aide affichée en bas de -l’écran.</p> +<p style="margin-left:22%;">Désactive la barre +d’aide affichée en bas de +l’écran.</p> <p style="margin-left:11%;"><b>−z (−−suspend)</b></p> -<p style="margin-left:22%;">Autorise à suspendre -l’éditeur.</p> +<p style="margin-left:22%;">Autorise à +suspendre l’éditeur.</p> <p style="margin-left:11%;"><b>−a, −b, −e, −f, −g, −j</b></p> -<p style="margin-left:22%;">Ignoré, pour être -compatible avec Pico.</p> +<p style="margin-left:22%;">Ignoré, pour +être compatible avec Pico.</p> <h2>FICHIERS D’INITIALISATION <a name="FICHIERS D’INITIALISATION"></a> @@ -431,10 +457,11 @@ compatible avec Pico.</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> lit les fichiers d’initialisation dans l’ordre suivant : <i>SYSCONFDIR/nanorc</i>, puis -<i>~/.nanorc</i>. Référez-vous à la -page de manuel de <b>nanorc(5)</b> et au fichier -d’exemple <i>nanorc.sample</i>, qui devraient tous les -deux être livrés avec <b>nano</b>.</p> +<i>~/.nanorc</i>. Référez-vous +à la page de manuel de <b>nanorc(5)</b> et au +fichier d’exemple <i>nanorc.sample</i>, qui devraient +tous les deux être livrés avec +<b>nano</b>.</p> <h2>NOTES <a name="NOTES"></a> @@ -443,28 +470,31 @@ deux être livrés avec <b>nano</b>.</p> <p style="margin-left:11%; margin-top: 1em">Si aucun correcteur orthographique de remplacement n’est -indiqué dans la ligne de commande ou dans l’un -des fichiers nanorc, <b>nano</b> prendra la commande -indiquée par la variable d’environnement -<b>SPELL</b> si elle est définie.</p> +indiqué dans la ligne de commande ou dans +l’un des fichiers nanorc, <b>nano</b> prendra la +commande indiquée par la variable +d’environnement <b>SPELL</b> si elle est +définie.</p> <p style="margin-left:11%; margin-top: 1em">Dans certains cas, <b>nano</b> essaiera de sauvegarder le fichier en cours -d’édition dans un fichier de secours. Cela -arrivera principalement si <b>nano</b> reçoit un -signal SIGHUP ou SIGTERM, ou bien se trouve à court -de mémoire. Le nom de ce fichier de secours sera -<i>nano.save</i> si le fichier en cours n’avait pas -encore de nom, ou sera composé du nom du fichier en -cours suivi du suffixe « .save ». Si -un fichier de ce nom existe déjà dans le -répertoire, un « .save » et un -nombre seront ajoutés à la fin du nom du +d’édition dans un fichier de secours. +Cela arrivera principalement si <b>nano</b> +reçoit un signal SIGHUP ou SIGTERM, ou bien se +trouve à court de mémoire. Le nom +de ce fichier de secours sera <i>nano.save</i> si le fichier +en cours n’avait pas encore de nom, ou sera +composé du nom du fichier en cours suivi du +suffixe « .save ». Si un +fichier de ce nom existe déjà dans +le répertoire, un +« .save » et un nombre +seront ajoutés à la fin du nom du fichier en cours afin de le rendre unique (par exemple, -« .save.1 »). En mode multi-espace, -<b>nano</b> réalisera une sauvegarde de tous les -fichiers en cours dans leurs fichiers de secours -respectifs.</p> +« .save.1 »). En mode +multi-espace, <b>nano</b> réalisera une +sauvegarde de tous les fichiers en cours dans leurs fichiers +de secours respectifs.</p> <h2>BOGUES <a name="BOGUES"></a> @@ -473,24 +503,25 @@ respectifs.</p> <p style="margin-left:11%; margin-top: 1em">Merci de nous faire parvenir vos commentaires et de nous signaler les -bogues, en écrivant, en anglais, à +bogues, en écrivant, en anglais, à <b>nano@nano-editor.org</b>.</p> <p style="margin-left:11%; margin-top: 1em">La liste de -discussion anglophone <b>nano</b> est disponible à -l’adresse <b>nano-devel@gnu.org</b>.</p> +discussion anglophone <b>nano</b> est disponible +à l’adresse +<b>nano-devel@gnu.org</b>.</p> <p style="margin-left:11%; margin-top: 1em">Pour vous -abonner, envoyez un courrier électronique à -<b>nano-devel-request@gnu.org</b>, ayant pour objet -« subscribe ».</p> +abonner, envoyez un courrier électronique +à <b>nano-devel-request@gnu.org</b>, ayant pour +objet « subscribe ».</p> -<p style="margin-left:11%; margin-top: 1em">N’hésitez -pas également à envoyez vos commentaires, -suggestions et corrections relatives à -l’adaptation française de cette page de manuel -ou du logiciel à +<p style="margin-left:11%; margin-top: 1em">N’hésitez +pas également à envoyez vos +commentaires, suggestions et corrections relatives +à l’adaptation française de +cette page de manuel ou du logiciel à <b>jean-philippe.guerard@tigreraye.org</b>.</p> <h2>SITE INTERNET @@ -509,8 +540,8 @@ ou du logiciel à <p style="margin-left:11%; margin-top: 1em"><b>nanorc</b>(5) <i><br> -/usr/share/doc/nano/</i> (ou son équivalent sur votre -système)</p> +/usr/share/doc/nano/</i> (ou son équivalent sur +votre système)</p> <h2>AUTEUR <a name="AUTEUR"></a> @@ -521,9 +552,10 @@ système)</p> Allegretta <chrisa@asty.org> et d’autres (voir les fichiers <i>AUTHORS</i> et <i>THANKS</i> pour plus d’information). Cette page de manuel a -été initialement rédigée par -Jordi Mallach <jordi@gnu.org> pour le système -Debian (mais elle peut être utilisée par +été initialement +rédigée par Jordi Mallach +<jordi@gnu.org> pour le système Debian +(mais elle peut être utilisée par d’autres).</p> <h2>TRADUCTION @@ -532,26 +564,30 @@ d’autres).</p> <p style="margin-left:11%; margin-top: 1em">Cette -adaptation française a été -réalisée par Jean-Philippe Guérard +adaptation française a +été +réalisée par +Jean-Philippe Guérard <jean-philippe.guerard@tigreraye.org> le -29 novembre 2007 à partir de la version -1.54 du 11 octobre 2007 de la page de manuel de -nano 2.0.0. Cette page a été relue par -Gérard Delafond.</p> +29 novembre 2007 à partir de la +version 1.54 du 11 octobre 2007 de la page de +manuel de nano 2.0.0. Cette page a +été relue par Gérard +Delafond.</p> <p style="margin-left:11%; margin-top: 1em">Un maximum de -soin a été apporté lors de -l’élaboration de cette traduction ; -néanmoins, quelques imperfections peuvent subsister. -Si vous en rencontrez, que ce soit dans la version -française ou dans la version originale, -n’hésitez pas à les signaler à -l’auteur ou au traducteur.</p> +soin a été apporté +lors de l’élaboration de cette +traduction ; néanmoins, quelques +imperfections peuvent subsister. Si vous en rencontrez, que +ce soit dans la version française ou dans la +version originale, n’hésitez pas +à les signaler à l’auteur ou +au traducteur.</p> <p style="margin-left:11%; margin-top: 1em">La version -originale la plus à jour de ce document est toujours -consultable via la commande :</p> +originale la plus à jour de ce document est +toujours consultable via la commande :</p> <p style="margin-left:11%; margin-top: 1em">LANGUAGE=en man nano</p> diff --git a/doc/man/fr/nanorc.5 b/doc/man/fr/nanorc.5 index 0607045..9c25635 100644 --- a/doc/man/fr/nanorc.5 +++ b/doc/man/fr/nanorc.5 @@ -2,14 +2,14 @@ .\" Copyright (C) 2003, 2004, 2005, 2006, 2007 .\" Free Software Foundation, Inc. .\" -.\" Le travail d'adaptation française de cette page de manuel a été -.\" réalisé par Jean-Philippe Guérard, en 2003, 2004, 2005, 2006 et 2007. +.\" Le travail d'adaptation française de cette page de manuel a été +.\" réalisé par Jean-Philippe Guérard, en 2003, 2004, 2005, 2006 et 2007. .\" Ce travail d'adaptation est dans le domaine public. Attention, la .\" page traduite reste soumise au droit d'auteur de ses auteurs .\" originaux. .\" .\" The French translation of this document is a public domain work of -.\" Jean-Philippe Guérard. This translation work was made in 2003, 2004, +.\" Jean-Philippe Guérard. This translation work was made in 2003, 2004, .\" 2005, 2006 and 2007. The translated man page in itself is still .\" subject to the copyright of its original authors. .\" @@ -29,71 +29,71 @@ .\" Documentation License along with this program. If not, see .\" <http://www.gnu.org/licenses/>. .\" -.\" Ce document est publié sous une double licence. Vous pouvez +.\" Ce document est publié sous une double licence. Vous pouvez .\" le distribuer et le modifier selon les termes de l'une des deux -.\" licences ci-dessous : +.\" licences ci-dessous : .\" -.\" * La Licence publique générale GNU (GNU GPL) version 3 ou, à -.\" votre choix, supérieure, telle que publiée par la Free -.\" Software Foundation. Vous devriez avoir reçu une copie de la -.\" Licence publique générale GNU avec ce programme. Si ce n'est +.\" * La Licence publique générale GNU (GNU GPL) version 3 ou, à +.\" votre choix, supérieure, telle que publiée par la Free +.\" Software Foundation. Vous devriez avoir reçu une copie de la +.\" Licence publique générale GNU avec ce programme. Si ce n'est .\" pas le cas, consultez <http://www.gnu.org/licenses/>. .\" .\" * La Licence de documentation libre GNU (GNU FDL), version 1.2 -.\" ou, à votre choix, supérieure, telle que publiée par la Free +.\" ou, à votre choix, supérieure, telle que publiée par la Free .\" Software Foundation, sans section invariante, ni texte de -.\" première ou de quatrième de couverture. Vous devriez avoir reçu +.\" première ou de quatrième de couverture. Vous devriez avoir reçu .\" une copie de la Licence de documentation libre GNU avec ce .\" programme. Si ce n'est pas le cas, consultez .\" <http://www.gnu.org/licenses/>. .\" -.\" $Id: nanorc.5 4443 2009-11-27 02:50:12Z astyanax $ +.\" $Id: nanorc.5 5071 2014-07-16 17:25:55Z jordi $ .TH NANORC 5 "version 2.0.0" "29\ novembre\ 2007" .\" Please adjust this date whenever revising the manpage. -.\" Merci de modifier ces dates à chaque mise à jour de cette page. +.\" Merci de modifier ces dates à chaque mise à jour de cette page. .SH NOM -nanorc \- fichier de configuration de l'éditeur nano du projet GNU +nanorc \- fichier de configuration de l'éditeur nano du projet GNU .SH DESCRIPTION -Cette page de manuel décrit brièvement le fichier de configuration de -l'éditeur \fBnano\fP GNU. +Cette page de manuel décrit brièvement le fichier de configuration de +l'éditeur \fBnano\fP GNU. .PP -\fBnano\fP est un petit éditeur sympathique et libre, qui vise à -remplacer Pico, l'éditeur par défaut du logiciel non libre Pine. +\fBnano\fP est un petit éditeur sympathique et libre, qui vise à +remplacer Pico, l'éditeur par défaut du logiciel non libre Pine. \fBnano\fP ne se contentant pas de copier l'interface et l'ergonomie de -Pico, il offre également certaines fonctionnalités manquantes (ou -désactivées par défaut) de Pico. Ces fonctionnalités sont, par exemple, -les fonctions de recherche et de remplacement et la possibilité de -sauter directement à une ligne et à une colonne précise. +Pico, il offre également certaines fonctionnalités manquantes (ou +désactivées par défaut) de Pico. Ces fonctionnalités sont, par exemple, +les fonctions de recherche et de remplacement et la possibilité de +sauter directement à une ligne et à une colonne précise. .PP -Le fichier \fInanorc\fP contient les paramètres par défaut de -\fBnano\fP. Il ne doit pas être au format DOS ou Mac. Lors de son -démarrage, nano commencera par lire le fichier de configuration général +Le fichier \fInanorc\fP contient les paramètres par défaut de +\fBnano\fP. Il ne doit pas être au format DOS ou Mac. Lors de son +démarrage, nano commencera par lire le fichier de configuration général \fISYSCONFDIR/nanorc\fP, puis lira le fichier de configuration personnel de l'utilisateur \fI~/.nanorc\fP. .SH OPTIONS -Le fichier de configuration accepte une série de commandes \fBset\fP -(activer) et \fBunset\fP (désactiver), qui permettent de définir le -paramétrage de nano au démarrage sans avoir à utiliser d'options de +Le fichier de configuration accepte une série de commandes \fBset\fP +(activer) et \fBunset\fP (désactiver), qui permettent de définir le +paramétrage de nano au démarrage sans avoir à utiliser d'options de ligne de commande. De plus, les mots clefs \fBsyntax\fP (syntaxe), -\fBcolor\fP (couleur) et \fBicolor\fP (couleur insensible à la casse) -sont utilisés pour définir les règles de colorisation pour différents +\fBcolor\fP (couleur) et \fBicolor\fP (couleur insensible à la casse) +sont utilisés pour définir les règles de colorisation pour différents motifs de texte. \fBnano\fP lit une commande par ligne. -Les options du fichier de configuration ont priorité sur les valeurs par -défaut utilisées par nano. Les options de la ligne de commande sont +Les options du fichier de configuration ont priorité sur les valeurs par +défaut utilisées par nano. Les options de la ligne de commande sont prioritaires par rapport aux options du fichier de configuration. Les -options sont désactivées (unset) par défaut, sauf les options prenant un +options sont désactivées (unset) par défaut, sauf les options prenant un argument. -Les apostrophes («\ \fI'\fP\ ») et les guillemets droits («\ \fI"\fP\ ») -présents dans des chaînes de caractères utilisées comme paramètres n'ont -pas besoin d'être précédées d'une barre oblique inversée -(«\ \fI\\\fP\ »). La chaîne sera terminée par le dernier guillemet +Les apostrophes («\ \fI'\fP\ ») et les guillemets droits («\ \fI"\fP\ ») +présents dans des chaînes de caractères utilisées comme paramètres n'ont +pas besoin d'être précédées d'une barre oblique inversée +(«\ \fI\\\fP\ »). La chaîne sera terminée par le dernier guillemet droit. Par exemple, pour l'option \fBbrackets\fP, "\fI"')>]}\fP" -correspondra à \fI"\fP, \fI'\fP, \fI)\fP, \fI>\fP, \fI]\fP et \fI}\fP. +correspondra à \fI"\fP, \fI'\fP, \fI)\fP, \fI>\fP, \fI]\fP et \fI}\fP. Les commandes et arguments reconnus sont\ : @@ -102,69 +102,69 @@ Les commandes et arguments reconnus sont\ : Active l'indentation automatique. .TP .B set/unset backup -Crée des copies de sécurité nommées +Crée des copies de sécurité nommées .IR nom_du_fichier~ . .TP -.B set backupdir "\fIrépertoire\fP" -Définit le répertoire utilisé par \fBnano\fP pour enregistrer les copies -de sécurité uniques, si l'enregistrement de copies de sécurité est -activé. +.B set backupdir "\fIrépertoire\fP" +Définit le répertoire utilisé par \fBnano\fP pour enregistrer les copies +de sécurité uniques, si l'enregistrement de copies de sécurité est +activé. .TP .B set/unset backwards -Par défaut, les recherches se font vers l'arrière. +Par défaut, les recherches se font vers l'arrière. .TP .B set/unset boldtext -Utilise des caractères gras à la place de la vidéo inverse. +Utilise des caractères gras à la place de la vidéo inverse. .TP -.B set brackets "\fIchaîne\fP" -Définit les caractères considérés comme des crochets fermants lors de la -justification des paragraphes. Ces caractères ne doivent pas contenir -d'espaces. Seules les ponctuations terminales, éventuellement suivies +.B set brackets "\fIchaîne\fP" +Définit les caractères considérés comme des crochets fermants lors de la +justification des paragraphes. Ces caractères ne doivent pas contenir +d'espaces. Seules les ponctuations terminales, éventuellement suivies de crochets fermants, peuvent terminer une phrase. -La valeur par défaut de cette option est\ : "\fI"')>]}\fP". +La valeur par défaut de cette option est\ : "\fI"')>]}\fP". N.D.T.\ : reportez-vous au paragraphe sur l'option \fBpunct\fR pour plus d'informations. .TP .B set/unset casesensitive -Par défaut, les recherches ne tiennent pas compte de la casse. +Par défaut, les recherches ne tiennent pas compte de la casse. .TP .B set/unset const -Affiche en permanence la position du curseur dans la ligne d'état. +Affiche en permanence la position du curseur dans la ligne d'état. .TP .B set/unset cut -Par défaut, coupe le texte du curseur à la fin de la ligne, au lieu de -couper la ligne entière. +Par défaut, coupe le texte du curseur à la fin de la ligne, au lieu de +couper la ligne entière. .TP .B set fill \fIn\fP -Passe automatiquement à la ligne une fois arrivé à la colonne -\fIn\fR. Si la valeur indiquée est de 0 ou moins, le point de passage à -la ligne aura lieu à la taille de l'écran moins \fIn\fR. Cela permet de -faire varier le point de passage à la ligne lorsque l'on change la -taille de l'écran. La valeur par défaut est de \-8. +Passe automatiquement à la ligne une fois arrivé à la colonne +\fIn\fR. Si la valeur indiquée est de 0 ou moins, le point de passage à +la ligne aura lieu à la taille de l'écran moins \fIn\fR. Cela permet de +faire varier le point de passage à la ligne lorsque l'on change la +taille de l'écran. La valeur par défaut est de \-8. .TP .B set/unset historylog Active l'utilisation de .I ~/.nano_history -pour enregistrer et relire les chaînes ayant fait l'objet d'une +pour enregistrer et relire les chaînes ayant fait l'objet d'une recherche ou d'un remplacement. .TP -.B set matchbrackets "\fIchaîne\fP" -Définit les crochets ouvrants et fermant pour la recherche de crochets +.B set matchbrackets "\fIchaîne\fP" +Définit les crochets ouvrants et fermant pour la recherche de crochets correspondants. Cette liste ne doit pas contenir de blancs. L'ensemble -des crochets ouvrants doit être indiqué en premier, suivi de l'ensemble -des crochets fermant, qui doit être dans le même ordre. La valeur par -défaut de cette option est "\fI(<[{)>]}\fP". +des crochets ouvrants doit être indiqué en premier, suivi de l'ensemble +des crochets fermant, qui doit être dans le même ordre. La valeur par +défaut de cette option est "\fI(<[{)>]}\fP". .TP .B set/unset morespace -Utiliser la ligne blanche située sous la ligne de titre comme espace -supplémentaire d'édition. +Utiliser la ligne blanche située sous la ligne de titre comme espace +supplémentaire d'édition. .TP .B set/unset mouse Active l'utilisation de la souris, si elle est disponible pour votre -système. Lorsque celle-ci est activée, il est possible d'utiliser la +système. Lorsque celle-ci est activée, il est possible d'utiliser la souris pour positionner le curseur, pour marquer le texte (avec un double-clic) et pour lancer les fonctions correspondant aux raccourcis. Il est possible d'utiliser la souris sous X\ Window ou en mode console @@ -178,167 +178,167 @@ espace. Pas de conversion depuis les formats DOS et Mac. .TP .B set/unset nofollow -Ne suit pas les liens symboliques lors de l'écriture des fichiers. +Ne suit pas les liens symboliques lors de l'écriture des fichiers. .TP .B set/unset nohelp -Désactive les lignes d'aide affichée en bas de l'écran. +Désactive les lignes d'aide affichée en bas de l'écran. .TP .B set/unset nonewlines -Ne pas ajouter de passage à la ligne à la fin des fichiers. +Ne pas ajouter de passage à la ligne à la fin des fichiers. .TP .B set/unset nowrap -Désactive le passage automatique à la ligne. +Désactive le passage automatique à la ligne. .TP -.B set operatingdir "\fIrépertoire\fP" -\fBnano\fP ne lira et n'écrira des fichiers qu'à l'intérieur du -\fIrépertoire\fP et de ses sous-répertoires. De plus, celui-ci devient -le répertoire courant, afin que les fichiers soient lus depuis ce -répertoire. Par défaut, cette fonction est désactivée. +.B set operatingdir "\fIrépertoire\fP" +\fBnano\fP ne lira et n'écrira des fichiers qu'à l'intérieur du +\fIrépertoire\fP et de ses sous-répertoires. De plus, celui-ci devient +le répertoire courant, afin que les fichiers soient lus depuis ce +répertoire. Par défaut, cette fonction est désactivée. .TP .B set/unset preserve -Préserve les séquences XON et XOFF (^Q et ^S). +Préserve les séquences XON et XOFF (^Q et ^S). .TP -.B set punct "\fIchaîne\fP" -Définit les caractères interprétés comme des ponctuations terminales -lors de la justification des paragraphes. Ces caractères ne peuvent -inclure de blancs. Seules les ponctuations terminales, éventuellement +.B set punct "\fIchaîne\fP" +Définit les caractères interprétés comme des ponctuations terminales +lors de la justification des paragraphes. Ces caractères ne peuvent +inclure de blancs. Seules les ponctuations terminales, éventuellement suivies de crochets fermants, peuvent terminer une phrase. La valeur par -défaut de cette option est "\fI!.?\fP". +défaut de cette option est "\fI!.?\fP". -N.D.T.\ : ce réglage permet, lors de la justification, de conserver -2\ espaces au lieu d'une derrière les ponctuations terminales, ce qui +N.D.T.\ : ce réglage permet, lors de la justification, de conserver +2\ espaces au lieu d'une derrière les ponctuations terminales, ce qui correspond aux normes typographiques anglo-saxonnes, mais n'a pas lieu -d'être en français. Pour le français, le plus simple est d'indiquer, -dans le fichier nanorc, une chaîne vide pour ce paramètre. +d'être en français. Pour le français, le plus simple est d'indiquer, +dans le fichier nanorc, une chaîne vide pour ce paramètre. .TP .B set/unset quickblank -Effacement rapide de la ligne d'état. Les messages affichés par la ligne -d'état disparaîtront après une frappe clavier au lieu de 25. -.TP -.B set quotestr "\fIchaîne\fP" -Définit le préfixe par défaut utilisé pour les citations dans les -courriers électroniques. Ce préfixe est utilisé pour réaliser une -justification correcte de ces citations. Il s'agira, si votre système le -permet, d'une expression rationnelle étendue. Dans le cas -contraire, il s'agira d'une chaîne de texte brut. Si vous disposez des -expressions rationnelles, la valeur par défaut de cette option sera +Effacement rapide de la ligne d'état. Les messages affichés par la ligne +d'état disparaîtront après une frappe clavier au lieu de 25. +.TP +.B set quotestr "\fIchaîne\fP" +Définit le préfixe par défaut utilisé pour les citations dans les +courriers électroniques. Ce préfixe est utilisé pour réaliser une +justification correcte de ces citations. Il s'agira, si votre système le +permet, d'une expression rationnelle étendue. Dans le cas +contraire, il s'agira d'une chaîne de texte brut. Si vous disposez des +expressions rationnelles, la valeur par défaut de cette option sera "\fI^([\ \\t]*[#:>\\|}])+\fP", sinon, ce sera ">\ ". Notez que le -«\ \\t\ » ci-dessus correspond à un caractère de tabulation. +«\ \\t\ » ci-dessus correspond à un caractère de tabulation. .TP .B set/unset rebinddelete -Interprète différemment la touche «\ Supprimer\ », afin que les touches -«\ Effacement arrière\ » et «\ Supprimer\ » fonctionnent correctement. -Vous ne devriez avoir besoin de cette option que si, sur votre système, -la touche «\ Effacement arrière\ » produit l'effet de la touche «\ -Supprimer\ ». +Interprète différemment la touche «\ Supprimer\ », afin que les touches +«\ Effacement arrière\ » et «\ Supprimer\ » fonctionnent correctement. +Vous ne devriez avoir besoin de cette option que si, sur votre système, +la touche «\ Effacement arrière\ » produit l'effet de la touche «\ +Supprimer\ ». .TP .B set/unset rebindkeypad -Interprète les touches du pavé numérique afin qu'elles fonctionnent +Interprète les touches du pavé numérique afin qu'elles fonctionnent toutes correctement. Vous ne devriez utiliser cette option que si ce n'est pas le cas, car nano ne sera plus capable d'utiliser la souris -correctement lorsque cette option sera activée. +correctement lorsque cette option sera activée. .TP .B set/unset regexp -Utilise par défaut des expressions rationnelles étendues pour les +Utilise par défaut des expressions rationnelles étendues pour les recherches. .TP .B set/unset smarthome -Rend plus malin le fonctionnement de la touche «\ Début\ ». Lorsque -cette touche est pressée à n'importe quel endroit excepté au tout début -du texte d'une ligne (i.\ e. au premier caractère non blanc), le curseur -se positionnera au début du texte de la ligne (qu'il soit en avant ou en -arrière). Si le curseur est déjà là, il se placera au vrai début de la +Rend plus malin le fonctionnement de la touche «\ Début\ ». Lorsque +cette touche est pressée à n'importe quel endroit excepté au tout début +du texte d'une ligne (i.\ e. au premier caractère non blanc), le curseur +se positionnera au début du texte de la ligne (qu'il soit en avant ou en +arrière). Si le curseur est déjà là , il se placera au vrai début de la ligne. .TP .B set/unset smooth -Active le défilement ligne-par-ligne du texte. +Active le défilement ligne-par-ligne du texte. .TP .B set speller "\fIprogramme\fP" Utilise le correcteur orthographique \fIprogramme\fP au lieu du -correcteur intégré, qui s'appuie sur \fIspell\fP. +correcteur intégré, qui s'appuie sur \fIspell\fP. .TP .B set/unset suspend -Autorise à suspendre \fBnano\fP. +Autorise à suspendre \fBnano\fP. .TP .B set tabsize \fIn\fP Utilise une taille de tabulation de \fIn\fP colonnes. Cette valeur doit -être strictement supérieure à 0. La valeur par défaut est de\ 8. +être strictement supérieure à 0. La valeur par défaut est de\ 8. .TP .B set/unset tabstospaces Convertit les tabulations clavier en espaces. .TP .B set/unset tempfile -S'il a été modifié, le fichier sera sauvegardé automatiquement en +S'il a été modifié, le fichier sera sauvegardé automatiquement en quittant, sans demande de confirmation. .TP .B set/unset view Interdit de modifier les fichiers. .TP -.B set whitespace "\fIchaîne\fP" -Définit les deux caractères utilisés pour afficher les premiers -caractères des tabulations et des espaces. Ces deux caractères doivent -être mono-colonne. +.B set whitespace "\fIchaîne\fP" +Définit les deux caractères utilisés pour afficher les premiers +caractères des tabulations et des espaces. Ces deux caractères doivent +être mono-colonne. .TP .B set/unset wordbounds -Détection plus précise des limites de mots, obtenue en considérant les -caractères de ponctuation comme faisant partie des mots. +Détection plus précise des limites de mots, obtenue en considérant les +caractères de ponctuation comme faisant partie des mots. .TP -.B syntax "\fIchaîne\fP" ["\fImotif_de_fichier\fP" ... ] -Définit une syntaxe nommée \fIchaîne\fP qui pourra être activé via +.B syntax "\fIchaîne\fP" ["\fImotif_de_fichier\fP" ... ] +Définit une syntaxe nommée \fIchaîne\fP qui pourra être activé via l'option \fB-Y\fP (ou \fB--syntax\fP) ou qui sera automatiquement -activée si le nom du fichier en cours correspond à l'expression -rationnelle étendue \fImotif_de_fichier\fP. Toutes les instructions -suivantes de colorisation \fBcolor\fP ou \fBicolor\fP s'appliqueront à -cette syntaxe, jusqu'à la définition d'une nouvelle syntaxe. +activée si le nom du fichier en cours correspond à l'expression +rationnelle étendue \fImotif_de_fichier\fP. Toutes les instructions +suivantes de colorisation \fBcolor\fP ou \fBicolor\fP s'appliqueront à +cette syntaxe, jusqu'à la définition d'une nouvelle syntaxe. -La syntaxe nommée \fInone\fP (aucune) est réservée\ ; si elle est -indiquée dans la ligne de commande, cela revient à ne définir aucune -syntaxe. La syntaxe nommée \fIdefault\fP (par défaut) est spéciale, elle -ne nécessite aucun motif de \fImotif_de_fichier\fP, et s'applique aux -fichiers ne correspondant à aucun des \fImotif_de_fichier\fP des autres +La syntaxe nommée \fInone\fP (aucune) est réservée\ ; si elle est +indiquée dans la ligne de commande, cela revient à ne définir aucune +syntaxe. La syntaxe nommée \fIdefault\fP (par défaut) est spéciale, elle +ne nécessite aucun motif de \fImotif_de_fichier\fP, et s'applique aux +fichiers ne correspondant à aucun des \fImotif_de_fichier\fP des autres syntaxes. .TP .B color \fIcouleur_texte\fP[,\fIcouleur_fond\fP] "\fImotif\fP" ... -Pour la syntaxe en cours, affiche toutes les expressions correspondant à -l'expression rationnelle étendue \fImotif\fP en utilisant la couleur de +Pour la syntaxe en cours, affiche toutes les expressions correspondant à +l'expression rationnelle étendue \fImotif\fP en utilisant la couleur de texte \fIcouleur_texte\fP et la couleur de fond \fIcouleur_fond\fP, -l'une de ces deux couleurs au moins devant être définie. Les couleurs -acceptées par \fBnano\fP pour le texte et le fond sont\ : \fIwhite\fP +l'une de ces deux couleurs au moins devant être définie. Les couleurs +acceptées par \fBnano\fP pour le texte et le fond sont\ : \fIwhite\fP (blanc), \fIblack\fP (noir), \fIred\fP (rouge), \fIblue\fP (bleu), \fIgreen\fP (vert), \fIyellow\fP (jaune), \fImagenta\fP, et \fIcyan\fP. -Pour la couleur du texte, vous pouvez ajouter à ces couleurs le préfixe +Pour la couleur du texte, vous pouvez ajouter à ces couleurs le préfixe \fIbright\fP (lumineux) pour obtenir une couleur plus lumineuse. Si -votre terminal est capable de gérer la transparence, ne pas spécifier de -\fIcouleur_fond\fP indique à \fBnano\fP d'essayer d'utiliser un fond +votre terminal est capable de gérer la transparence, ne pas spécifier de +\fIcouleur_fond\fP indique à \fBnano\fP d'essayer d'utiliser un fond transparent. .TP .B icolor \fIcouleur_texte\fP[,\fIcouleur_fond\fP] "\fImotif\fP" ... -Comme ci-dessus, mais la recherche des motifs est effectuée sans tenir +Comme ci-dessus, mais la recherche des motifs est effectuée sans tenir compte de la casse. .TP -.B color \fIcouleur_texte\fP[,\fIcouleur_fond\fP] start="\fImotif_début\fP" end="\fImotif_fin\fP" -Affiche les expressions commençant par l'expression rationnelle étendue -\fImotif_début\fP et se terminant par l'expression rationnelle étendue +.B color \fIcouleur_texte\fP[,\fIcouleur_fond\fP] start="\fImotif_début\fP" end="\fImotif_fin\fP" +Affiche les expressions commençant par l'expression rationnelle étendue +\fImotif_début\fP et se terminant par l'expression rationnelle étendue \fImotif_fin\fP en utilisant la couleur de texte \fIcouleur_texte\fP et la couleur de fond \fIcouleur_fond\fP, l'une de ces deux couleurs au -moins devant être définie. Cela permet à la colorisation syntaxique de -s'étendre sur plusieurs lignes. Notez que toutes les occurrences -successives de \fImotif_début\fP après le \fImotif_début\fP initial -seront surlignées jusqu'à la prochaine instance de \fImotif_fin\fP. +moins devant être définie. Cela permet à la colorisation syntaxique de +s'étendre sur plusieurs lignes. Notez que toutes les occurrences +successives de \fImotif_début\fP après le \fImotif_début\fP initial +seront surlignées jusqu'à la prochaine instance de \fImotif_fin\fP. .TP -.B icolor \fIcouleur_texte\fP[,\fIcouleur_fond\fP] start="\fImotif_début\fP" end="\fImotif_fin\fP" -Comme ci-dessus, mais la recherche des motifs est effectuée sans tenir +.B icolor \fIcouleur_texte\fP[,\fIcouleur_fond\fP] start="\fImotif_début\fP" end="\fImotif_fin\fP" +Comme ci-dessus, mais la recherche des motifs est effectuée sans tenir compte de la casse. .TP .B include "\fIfichier_de_syntaxes\fP" Lit le fichier \fIfichier_de_syntaxes\fP contenant une liste -autosuffisante de définitions de syntaxes. Ce fichier ne doit contenir +autosuffisante de définitions de syntaxes. Ce fichier ne doit contenir que des commandes \fBsyntax\fP, \fBcolor\fP et \fBicolor\fP. .SH FICHIERS .TP .I $SYSCONFDIR/nanorc -Fichier de configuration général +Fichier de configuration général .TP .I ~/.nanorc Fichier de configuration personnel @@ -348,29 +348,29 @@ Fichier de configuration personnel .TP \fBnano\fP(1) .PP -\fI/usr/share/doc/nano/examples/nanorc.sample\fP (ou son équivalent sur -votre système) +\fI/usr/share/doc/nano/examples/nanorc.sample\fP (ou son équivalent sur +votre système) .SH AUTEUR Chris Allegretta <chrisa@asty.org> et d'autres (voir les fichiers \fIAUTHORS\fP et \fITHANKS\fP pour plus d'information). Cette page de -manuel a été initialement rédigée par Jordi Mallach <jordi@gnu.org> pour -le système Debian (mais elle peut être utilisée par d'autres). +manuel a été initialement rédigée par Jordi Mallach <jordi@gnu.org> pour +le système Debian (mais elle peut être utilisée par d'autres). .SH TRADUCTION -Cette adaptation française a été réalisée par Jean-Philippe\ Guérard -<jean-philippe.guerard@tigreraye.org> le 29\ novembre\ 2007 à partir de +Cette adaptation française a été réalisée par Jean-Philippe\ Guérard +<jean-philippe.guerard@tigreraye.org> le 29\ novembre\ 2007 à partir de la version 1.56 du 11\ octobre\ 2007 de la page de manuel de nanorc -(pour la version 2.0.0 de nano). Cette page a été relue par Gérard +(pour la version 2.0.0 de nano). Cette page a été relue par Gérard Delafond. -Un maximum de soin a été apporté lors de l'élaboration de cette -traduction\ ; néanmoins, quelques imperfections peuvent subsister. Si -vous en rencontrez, que ce soit dans la version française ou dans la -version originale, n'hésitez pas à les signaler à l'auteur ou au +Un maximum de soin a été apporté lors de l'élaboration de cette +traduction\ ; néanmoins, quelques imperfections peuvent subsister. Si +vous en rencontrez, que ce soit dans la version française ou dans la +version originale, n'hésitez pas à les signaler à l'auteur ou au traducteur. -La version originale la plus à jour de ce document est toujours +La version originale la plus à jour de ce document est toujours consultable via la commande\ : LANGUAGE=en man nano diff --git a/doc/man/fr/nanorc.5.html b/doc/man/fr/nanorc.5.html index e438be8..092aaef 100644 --- a/doc/man/fr/nanorc.5.html +++ b/doc/man/fr/nanorc.5.html @@ -1,5 +1,5 @@ -<!-- Creator : groff version 1.20.1 --> -<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Thu Jul 17 11:02:17 2014 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -37,8 +37,8 @@ <p style="margin-left:11%; margin-top: 1em">nanorc − -fichier de configuration de l’éditeur nano du -projet GNU</p> +fichier de configuration de l’éditeur +nano du projet GNU</p> <h2>DESCRIPTION <a name="DESCRIPTION"></a> @@ -46,29 +46,34 @@ projet GNU</p> <p style="margin-left:11%; margin-top: 1em">Cette page de -manuel décrit brièvement le fichier de -configuration de l’éditeur <b>nano</b> GNU.</p> +manuel décrit brièvement le fichier +de configuration de l’éditeur <b>nano</b> +GNU.</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> est -un petit éditeur sympathique et libre, qui vise -à remplacer Pico, l’éditeur par -défaut du logiciel non libre Pine. <b>nano</b> ne se -contentant pas de copier l’interface et -l’ergonomie de Pico, il offre également -certaines fonctionnalités manquantes (ou -désactivées par défaut) de Pico. Ces -fonctionnalités sont, par exemple, les fonctions de -recherche et de remplacement et la possibilité de -sauter directement à une ligne et à une -colonne précise.</p> +un petit éditeur sympathique et libre, qui vise +à remplacer Pico, l’éditeur +par défaut du logiciel non libre Pine. +<b>nano</b> ne se contentant pas de copier l’interface +et l’ergonomie de Pico, il offre +également certaines +fonctionnalités manquantes (ou +désactivées par +défaut) de Pico. Ces +fonctionnalités sont, par exemple, les +fonctions de recherche et de remplacement et la +possibilité de sauter directement +à une ligne et à une colonne +précise.</p> <p style="margin-left:11%; margin-top: 1em">Le fichier -<i>nanorc</i> contient les paramètres par -défaut de <b>nano</b>. Il ne doit pas être au -format DOS ou Mac. Lors de son démarrage, nano -commencera par lire le fichier de configuration -général <i>SYSCONFDIR/nanorc</i>, puis lira le -fichier de configuration personnel de l’utilisateur +<i>nanorc</i> contient les paramètres par +défaut de <b>nano</b>. Il ne doit pas +être au format DOS ou Mac. Lors de son +démarrage, nano commencera par lire le fichier +de configuration général +<i>SYSCONFDIR/nanorc</i>, puis lira le fichier de +configuration personnel de l’utilisateur <i>~/.nanorc</i>.</p> <h2>OPTIONS @@ -77,38 +82,44 @@ fichier de configuration personnel de l’utilisateur <p style="margin-left:11%; margin-top: 1em">Le fichier de -configuration accepte une série de commandes -<b>set</b> (activer) et <b>unset</b> (désactiver), -qui permettent de définir le paramétrage de -nano au démarrage sans avoir à utiliser +configuration accepte une série de commandes +<b>set</b> (activer) et <b>unset</b> +(désactiver), qui permettent de +définir le paramétrage de nano au +démarrage sans avoir à utiliser d’options de ligne de commande. De plus, les mots clefs <b>syntax</b> (syntaxe), <b>color</b> (couleur) et -<b>icolor</b> (couleur insensible à la casse) sont -utilisés pour définir les règles de -colorisation pour différents motifs de texte. -<b>nano</b> lit une commande par ligne.</p> +<b>icolor</b> (couleur insensible à la casse) +sont utilisés pour définir les +règles de colorisation pour +différents motifs de texte. <b>nano</b> lit une +commande par ligne.</p> <p style="margin-left:11%; margin-top: 1em">Les options du -fichier de configuration ont priorité sur les valeurs -par défaut utilisées par nano. Les options de -la ligne de commande sont prioritaires par rapport aux -options du fichier de configuration. Les options sont -désactivées (unset) par défaut, sauf -les options prenant un argument.</p> +fichier de configuration ont priorité sur les +valeurs par défaut utilisées par +nano. Les options de la ligne de commande sont prioritaires +par rapport aux options du fichier de configuration. Les +options sont désactivées (unset) +par défaut, sauf les options prenant un +argument.</p> <p style="margin-left:11%; margin-top: 1em">Les apostrophes -(« <i>’ </i>») et les guillemets -droits (« <i>" </i>») -présents dans des chaînes de caractères -utilisées comme paramètres n’ont pas -besoin d’être précédées -d’une barre oblique inversée -(« <i>\ </i>»). La chaîne sera -terminée par le dernier guillemet droit. Par exemple, -pour l’option <b>brackets</b>, -"<i>"’)>]}</i>" correspondra -à <i>"</i>, <i>’</i>, <i>)</i>, -<i>></i>, <i>]</i> et <i>}</i>.</p> +(« <i>’ </i>») et +les guillemets droits +(« <i>" </i>») +présents dans des chaînes de +caractères utilisées comme +paramètres n’ont pas besoin +d’être +précédées d’une +barre oblique inversée +(« <i>\ </i>»). La +chaîne sera terminée par le dernier +guillemet droit. Par exemple, pour l’option +<b>brackets</b>, "<i>"’)>]}</i>" +correspondra à <i>"</i>, <i>’</i>, +<i>)</i>, <i>></i>, <i>]</i> et <i>}</i>.</p> <p style="margin-left:11%; margin-top: 1em">Les commandes et arguments reconnus sont : <b><br> @@ -119,42 +130,45 @@ automatique.</p> <p style="margin-left:11%;"><b>set/unset backup</b></p> -<p style="margin-left:15%;">Crée des copies de -sécurité nommées +<p style="margin-left:15%;">Crée des copies de +sécurité nommées <i>nom_du_fichier~</i>.</p> <p style="margin-left:11%;"><b>set backupdir</b> -<i>répertoire</i></p> +<i>répertoire</i></p> -<p style="margin-left:15%;">Définit le -répertoire utilisé par <b>nano</b> pour -enregistrer les copies de sécurité uniques, si -l’enregistrement de copies de sécurité -est activé.</p> +<p style="margin-left:15%;">Définit le +répertoire utilisé par <b>nano</b> +pour enregistrer les copies de +sécurité uniques, si +l’enregistrement de copies de +sécurité est +activé.</p> <p style="margin-left:11%;"><b>set/unset backwards</b></p> -<p style="margin-left:15%;">Par défaut, les -recherches se font vers l’arrière.</p> +<p style="margin-left:15%;">Par défaut, les +recherches se font vers l’arrière.</p> <p style="margin-left:11%;"><b>set/unset boldtext</b></p> -<p style="margin-left:15%;">Utilise des caractères -gras à la place de la vidéo inverse.</p> +<p style="margin-left:15%;">Utilise des +caractères gras à la place de la +vidéo inverse.</p> <p style="margin-left:11%;"><b>set brackets</b> -<i>chaîne</i></p> +<i>chaîne</i></p> -<p style="margin-left:15%;">Définit les -caractères considérés comme des -crochets fermants lors de la justification des paragraphes. -Ces caractères ne doivent pas contenir -d’espaces. Seules les ponctuations terminales, -éventuellement suivies de crochets fermants, peuvent -terminer une phrase.</p> +<p style="margin-left:15%;">Définit les +caractères considérés +comme des crochets fermants lors de la justification des +paragraphes. Ces caractères ne doivent pas +contenir d’espaces. Seules les ponctuations +terminales, éventuellement suivies de crochets +fermants, peuvent terminer une phrase.</p> <p style="margin-left:15%; margin-top: 1em">La valeur par -défaut de cette option est : +défaut de cette option est : "<i>"’)>]}</i>".</p> <p style="margin-left:15%; margin-top: 1em">N.D.T. : @@ -164,64 +178,70 @@ pour plus d’informations.</p> <p style="margin-left:11%;"><b>set/unset casesensitive</b></p> -<p style="margin-left:15%;">Par défaut, les +<p style="margin-left:15%;">Par défaut, les recherches ne tiennent pas compte de la casse.</p> <p style="margin-left:11%;"><b>set/unset const</b></p> <p style="margin-left:15%;">Affiche en permanence la -position du curseur dans la ligne d’état.</p> +position du curseur dans la ligne +d’état.</p> <p style="margin-left:11%;"><b>set/unset cut</b></p> -<p style="margin-left:15%;">Par défaut, coupe le -texte du curseur à la fin de la ligne, au lieu de -couper la ligne entière.</p> +<p style="margin-left:15%;">Par défaut, coupe +le texte du curseur à la fin de la ligne, au +lieu de couper la ligne entière.</p> <p style="margin-left:11%;"><b>set fill</b> <i>n</i></p> -<p style="margin-left:15%;">Passe automatiquement à -la ligne une fois arrivé à la colonne -<i>n</i>. Si la valeur indiquée est de 0 ou moins, le -point de passage à la ligne aura lieu à la -taille de l’écran moins <i>n</i>. Cela permet -de faire varier le point de passage à la ligne -lorsque l’on change la taille de l’écran. -La valeur par défaut est de −8.</p> +<p style="margin-left:15%;">Passe automatiquement +à la ligne une fois arrivé +à la colonne <i>n</i>. Si la valeur +indiquée est de 0 ou moins, le point de passage +à la ligne aura lieu à la taille +de l’écran moins <i>n</i>. Cela permet de +faire varier le point de passage à la ligne +lorsque l’on change la taille de +l’écran. La valeur par +défaut est de −8.</p> <p style="margin-left:11%;"><b>set/unset historylog</b></p> <p style="margin-left:15%;">Active l’utilisation de <i>~/.nano_history</i> pour enregistrer et relire les -chaînes ayant fait l’objet d’une recherche -ou d’un remplacement.</p> +chaînes ayant fait l’objet d’une +recherche ou d’un remplacement.</p> <p style="margin-left:11%;"><b>set matchbrackets</b> -<i>chaîne</i></p> +<i>chaîne</i></p> -<p style="margin-left:15%;">Définit les crochets -ouvrants et fermant pour la recherche de crochets +<p style="margin-left:15%;">Définit les +crochets ouvrants et fermant pour la recherche de crochets correspondants. Cette liste ne doit pas contenir de blancs. -L’ensemble des crochets ouvrants doit être -indiqué en premier, suivi de l’ensemble des -crochets fermant, qui doit être dans le même -ordre. La valeur par défaut de cette option est +L’ensemble des crochets ouvrants doit +être indiqué en premier, suivi de +l’ensemble des crochets fermant, qui doit +être dans le même ordre. La valeur +par défaut de cette option est "<i>(<[{)>]}</i>".</p> <p style="margin-left:11%;"><b>set/unset morespace</b></p> <p style="margin-left:15%;">Utiliser la ligne blanche -située sous la ligne de titre comme espace -supplémentaire d’édition.</p> +située sous la ligne de titre comme espace +supplémentaire +d’édition.</p> <p style="margin-left:11%;"><b>set/unset mouse</b></p> <p style="margin-left:15%;">Active l’utilisation de -la souris, si elle est disponible pour votre système. -Lorsque celle-ci est activée, il est possible -d’utiliser la souris pour positionner le curseur, pour -marquer le texte (avec un double-clic) et pour lancer les -fonctions correspondant aux raccourcis. Il est possible +la souris, si elle est disponible pour votre +système. Lorsque celle-ci est +activée, il est possible d’utiliser la +souris pour positionner le curseur, pour marquer le texte +(avec un double-clic) et pour lancer les fonctions +correspondant aux raccourcis. Il est possible d’utiliser la souris sous X Window ou en mode console avec gpm.</p> @@ -239,155 +259,168 @@ formats DOS et Mac.</p> <p style="margin-left:11%;"><b>set/unset nofollow</b></p> <p style="margin-left:15%;">Ne suit pas les liens -symboliques lors de l’écriture des +symboliques lors de l’écriture des fichiers.</p> <p style="margin-left:11%;"><b>set/unset nohelp</b></p> -<p style="margin-left:15%;">Désactive les lignes -d’aide affichée en bas de -l’écran.</p> +<p style="margin-left:15%;">Désactive les +lignes d’aide affichée en bas de +l’écran.</p> <p style="margin-left:11%;"><b>set/unset nonewlines</b></p> <p style="margin-left:15%;">Ne pas ajouter de passage -à la ligne à la fin des fichiers.</p> +à la ligne à la fin des +fichiers.</p> <p style="margin-left:11%;"><b>set/unset nowrap</b></p> -<p style="margin-left:15%;">Désactive le passage -automatique à la ligne.</p> +<p style="margin-left:15%;">Désactive le +passage automatique à la ligne.</p> <p style="margin-left:11%;"><b>set operatingdir</b> -<i>répertoire</i></p> +<i>répertoire</i></p> <p style="margin-left:15%;"><b>nano</b> ne lira et -n’écrira des fichiers qu’à -l’intérieur du <i>répertoire</i> et de -ses sous-répertoires. De plus, celui-ci devient le -répertoire courant, afin que les fichiers soient lus -depuis ce répertoire. Par défaut, cette -fonction est désactivée.</p> +n’écrira des fichiers +qu’à l’intérieur du +<i>répertoire</i> et de ses +sous-répertoires. De plus, celui-ci devient le +répertoire courant, afin que les fichiers +soient lus depuis ce répertoire. Par +défaut, cette fonction est +désactivée.</p> <p style="margin-left:11%;"><b>set/unset preserve</b></p> -<p style="margin-left:15%;">Préserve les -séquences XON et XOFF (^Q et ^S).</p> +<p style="margin-left:15%;">Préserve les +séquences XON et XOFF (^Q et ^S).</p> <p style="margin-left:11%;"><b>set punct</b> -<i>chaîne</i></p> - -<p style="margin-left:15%;">Définit les -caractères interprétés comme des -ponctuations terminales lors de la justification des -paragraphes. Ces caractères ne peuvent inclure de -blancs. Seules les ponctuations terminales, -éventuellement suivies de crochets fermants, peuvent -terminer une phrase. La valeur par défaut de cette -option est "<i>!.?</i>".</p> +<i>chaîne</i></p> + +<p style="margin-left:15%;">Définit les +caractères interprétés +comme des ponctuations terminales lors de la justification +des paragraphes. Ces caractères ne peuvent +inclure de blancs. Seules les ponctuations terminales, +éventuellement suivies de crochets fermants, +peuvent terminer une phrase. La valeur par +défaut de cette option est +"<i>!.?</i>".</p> <p style="margin-left:15%; margin-top: 1em">N.D.T. : -ce réglage permet, lors de la justification, de -conserver 2 espaces au lieu d’une derrière -les ponctuations terminales, ce qui correspond aux normes -typographiques anglo-saxonnes, mais n’a pas lieu -d’être en français. Pour le -français, le plus simple est d’indiquer, dans -le fichier nanorc, une chaîne vide pour ce -paramètre.</p> +ce réglage permet, lors de la justification, de +conserver 2 espaces au lieu d’une +derrière les ponctuations terminales, ce qui +correspond aux normes typographiques anglo-saxonnes, mais +n’a pas lieu d’être en +français. Pour le français, le +plus simple est d’indiquer, dans le fichier nanorc, +une chaîne vide pour ce +paramètre.</p> <p style="margin-left:11%;"><b>set/unset quickblank</b></p> <p style="margin-left:15%;">Effacement rapide de la ligne -d’état. Les messages affichés par la -ligne d’état disparaîtront après -une frappe clavier au lieu de 25.</p> +d’état. Les messages +affichés par la ligne d’état +disparaîtront après une frappe +clavier au lieu de 25.</p> <p style="margin-left:11%;"><b>set quotestr</b> -<i>chaîne</i></p> +<i>chaîne</i></p> -<p style="margin-left:15%;">Définit le -préfixe par défaut utilisé pour les -citations dans les courriers électroniques. Ce -préfixe est utilisé pour réaliser une +<p style="margin-left:15%;">Définit le +préfixe par défaut +utilisé pour les citations dans les courriers +électroniques. Ce préfixe est +utilisé pour réaliser une justification correcte de ces citations. Il s’agira, -si votre système le permet, d’une expression -rationnelle étendue. Dans le cas contraire, il -s’agira d’une chaîne de texte brut. Si -vous disposez des expressions rationnelles, la valeur par -défaut de cette option sera -"<i>^([ \t]*[#:>\|}])+</i>", sinon, ce -sera "> ". Notez que le -« \t » ci-dessus correspond à -un caractère de tabulation.</p> +si votre système le permet, d’une +expression rationnelle étendue. Dans le cas +contraire, il s’agira d’une chaîne +de texte brut. Si vous disposez des expressions +rationnelles, la valeur par défaut de cette +option sera "<i>^([ \t]*[#:>\|}])+</i>", +sinon, ce sera "> ". Notez que le +« \t » ci-dessus +correspond à un caractère de +tabulation.</p> <p style="margin-left:11%;"><b>set/unset rebinddelete</b></p> -<p style="margin-left:15%;">Interprète -différemment la touche -« Supprimer », afin que les touches -« Effacement arrière » et -« Supprimer » fonctionnent -correctement. Vous ne devriez avoir besoin de cette option -que si, sur votre système, la touche -« Effacement arrière » produit -l’effet de la touche « -Supprimer ».</p> +<p style="margin-left:15%;">Interprète +différemment la touche +« Supprimer », afin que +les touches « Effacement +arrière » et +« Supprimer » +fonctionnent correctement. Vous ne devriez avoir besoin de +cette option que si, sur votre système, la +touche « Effacement +arrière » produit +l’effet de la touche « +Supprimer ».</p> <p style="margin-left:11%;"><b>set/unset rebindkeypad</b></p> -<p style="margin-left:15%;">Interprète les touches -du pavé numérique afin qu’elles -fonctionnent toutes correctement. Vous ne devriez utiliser -cette option que si ce n’est pas le cas, car nano ne -sera plus capable d’utiliser la souris correctement -lorsque cette option sera activée.</p> +<p style="margin-left:15%;">Interprète les +touches du pavé numérique afin +qu’elles fonctionnent toutes correctement. Vous ne +devriez utiliser cette option que si ce n’est pas le +cas, car nano ne sera plus capable d’utiliser la +souris correctement lorsque cette option sera +activée.</p> <p style="margin-left:11%;"><b>set/unset regexp</b></p> -<p style="margin-left:15%;">Utilise par défaut des -expressions rationnelles étendues pour les +<p style="margin-left:15%;">Utilise par défaut +des expressions rationnelles étendues pour les recherches.</p> <p style="margin-left:11%;"><b>set/unset smarthome</b></p> <p style="margin-left:15%;">Rend plus malin le fonctionnement de la touche -« Début ». Lorsque cette touche -est pressée à n’importe quel endroit -excepté au tout début du texte d’une -ligne (i. e. au premier caractère non blanc), le -curseur se positionnera au début du texte de la ligne -(qu’il soit en avant ou en arrière). Si le -curseur est déjà là, il se placera au -vrai début de la ligne.</p> +« Début ». +Lorsque cette touche est pressée à +n’importe quel endroit excepté au tout +début du texte d’une ligne (i. e. au +premier caractère non blanc), le curseur se +positionnera au début du texte de la ligne +(qu’il soit en avant ou en arrière). Si le +curseur est déjà là , +il se placera au vrai début de la ligne.</p> <p style="margin-left:11%;"><b>set/unset smooth</b></p> -<p style="margin-left:15%;">Active le défilement -ligne-par-ligne du texte.</p> +<p style="margin-left:15%;">Active le +défilement ligne-par-ligne du texte.</p> <p style="margin-left:11%;"><b>set speller</b> <i>programme</i></p> <p style="margin-left:15%;">Utilise le correcteur orthographique <i>programme</i> au lieu du correcteur -intégré, qui s’appuie sur +intégré, qui s’appuie sur <i>spell</i>.</p> <p style="margin-left:11%;"><b>set/unset suspend</b></p> -<p style="margin-left:15%;">Autorise à suspendre -<b>nano</b>.</p> +<p style="margin-left:15%;">Autorise à +suspendre <b>nano</b>.</p> <p style="margin-left:11%;"><b>set tabsize</b> <i>n</i></p> <p style="margin-left:15%;">Utilise une taille de tabulation de <i>n</i> colonnes. Cette valeur doit -être strictement supérieure à 0. La -valeur par défaut est de 8.</p> +être strictement supérieure +à 0. La valeur par défaut est +de 8.</p> <p style="margin-left:11%;"><b>set/unset tabstospaces</b></p> @@ -397,10 +430,10 @@ clavier en espaces.</p> <p style="margin-left:11%;"><b>set/unset tempfile</b></p> -<p style="margin-left:15%;">S’il a été -modifié, le fichier sera sauvegardé -automatiquement en quittant, sans demande de -confirmation.</p> +<p style="margin-left:15%;">S’il a +été modifié, le +fichier sera sauvegardé automatiquement en +quittant, sans demande de confirmation.</p> <p style="margin-left:11%;"><b>set/unset view</b></p> @@ -408,112 +441,119 @@ confirmation.</p> fichiers.</p> <p style="margin-left:11%;"><b>set whitespace</b> -<i>chaîne</i></p> +<i>chaîne</i></p> -<p style="margin-left:15%;">Définit les deux -caractères utilisés pour afficher les premiers -caractères des tabulations et des espaces. Ces deux -caractères doivent être mono-colonne.</p> +<p style="margin-left:15%;">Définit les deux +caractères utilisés pour afficher +les premiers caractères des tabulations et des +espaces. Ces deux caractères doivent +être mono-colonne.</p> <p style="margin-left:11%;"><b>set/unset wordbounds</b></p> -<p style="margin-left:15%;">Détection plus -précise des limites de mots, obtenue en -considérant les caractères de ponctuation -comme faisant partie des mots.</p> +<p style="margin-left:15%;">Détection plus +précise des limites de mots, obtenue en +considérant les caractères de +ponctuation comme faisant partie des mots.</p> <p style="margin-left:11%;"><b>syntax</b> -<i>chaîne</i> +<i>chaîne</i> <b>["</b><i>motif_de_fichier</i><b>" ... ]</b></p> -<p style="margin-left:15%;">Définit une syntaxe -nommée <i>chaîne</i> qui pourra être -activé via l’option <b>-Y</b> (ou -<b>--syntax</b>) ou qui sera automatiquement activée -si le nom du fichier en cours correspond à -l’expression rationnelle étendue -<i>motif_de_fichier</i>. Toutes les instructions suivantes -de colorisation <b>color</b> ou <b>icolor</b> -s’appliqueront à cette syntaxe, -jusqu’à la définition d’une -nouvelle syntaxe.</p> +<p style="margin-left:15%;">Définit une +syntaxe nommée <i>chaîne</i> qui +pourra être activé via +l’option <b>-Y</b> (ou <b>--syntax</b>) ou qui sera +automatiquement activée si le nom du fichier en +cours correspond à l’expression +rationnelle étendue <i>motif_de_fichier</i>. +Toutes les instructions suivantes de colorisation +<b>color</b> ou <b>icolor</b> s’appliqueront +à cette syntaxe, jusqu’à la +définition d’une nouvelle syntaxe.</p> <p style="margin-left:15%; margin-top: 1em">La syntaxe -nommée <i>none</i> (aucune) est -réservée ; si elle est indiquée -dans la ligne de commande, cela revient à ne -définir aucune syntaxe. La syntaxe nommée -<i>default</i> (par défaut) est spéciale, elle -ne nécessite aucun motif de <i>motif_de_fichier</i>, -et s’applique aux fichiers ne correspondant à -aucun des <i>motif_de_fichier</i> des autres syntaxes.</p> +nommée <i>none</i> (aucune) est +réservée ; si elle est +indiquée dans la ligne de commande, cela +revient à ne définir aucune +syntaxe. La syntaxe nommée <i>default</i> (par +défaut) est spéciale, elle ne +nécessite aucun motif de +<i>motif_de_fichier</i>, et s’applique aux fichiers ne +correspondant à aucun des +<i>motif_de_fichier</i> des autres syntaxes.</p> <p style="margin-left:11%;"><b>color</b> <i>couleur_texte</i><b>[,</b><i>couleur_fond</i><b>]</b> <i>motif</i> <b>...</b></p> <p style="margin-left:15%;">Pour la syntaxe en cours, -affiche toutes les expressions correspondant à -l’expression rationnelle étendue <i>motif</i> -en utilisant la couleur de texte <i>couleur_texte</i> et la -couleur de fond <i>couleur_fond</i>, l’une de ces deux -couleurs au moins devant être définie. Les -couleurs acceptées par <b>nano</b> pour le texte et -le fond sont : <i>white</i> (blanc), <i>black</i> -(noir), <i>red</i> (rouge), <i>blue</i> (bleu), <i>green</i> -(vert), <i>yellow</i> (jaune), <i>magenta</i>, et -<i>cyan</i>. Pour la couleur du texte, vous pouvez ajouter -à ces couleurs le préfixe <i>bright</i> -(lumineux) pour obtenir une couleur plus lumineuse. Si votre -terminal est capable de gérer la transparence, ne pas -spécifier de <i>couleur_fond</i> indique à -<b>nano</b> d’essayer d’utiliser un fond -transparent.</p> +affiche toutes les expressions correspondant à +l’expression rationnelle étendue +<i>motif</i> en utilisant la couleur de texte +<i>couleur_texte</i> et la couleur de fond +<i>couleur_fond</i>, l’une de ces deux couleurs au +moins devant être définie. Les +couleurs acceptées par <b>nano</b> pour le +texte et le fond sont : <i>white</i> (blanc), +<i>black</i> (noir), <i>red</i> (rouge), <i>blue</i> (bleu), +<i>green</i> (vert), <i>yellow</i> (jaune), <i>magenta</i>, +et <i>cyan</i>. Pour la couleur du texte, vous pouvez +ajouter à ces couleurs le préfixe +<i>bright</i> (lumineux) pour obtenir une couleur plus +lumineuse. Si votre terminal est capable de +gérer la transparence, ne pas +spécifier de <i>couleur_fond</i> indique +à <b>nano</b> d’essayer d’utiliser +un fond transparent.</p> <p style="margin-left:11%;"><b>icolor</b> <i>couleur_texte</i><b>[,</b><i>couleur_fond</i><b>]</b> <i>motif</i> <b>...</b></p> <p style="margin-left:15%;">Comme ci-dessus, mais la -recherche des motifs est effectuée sans tenir compte -de la casse.</p> +recherche des motifs est effectuée sans tenir +compte de la casse.</p> <p style="margin-left:11%;"><b>color</b> <i>couleur_texte</i><b>[,</b><i>couleur_fond</i><b>] -start="</b><i>motif_début</i><b>" +start="</b><i>motif_début</i><b>" end="</b><i>motif_fin</i><b>"</b></p> <p style="margin-left:15%;">Affiche les expressions -commençant par l’expression rationnelle -étendue <i>motif_début</i> et se terminant par -l’expression rationnelle étendue -<i>motif_fin</i> en utilisant la couleur de texte -<i>couleur_texte</i> et la couleur de fond +commençant par l’expression rationnelle +étendue <i>motif_début</i> et se +terminant par l’expression rationnelle +étendue <i>motif_fin</i> en utilisant la +couleur de texte <i>couleur_texte</i> et la couleur de fond <i>couleur_fond</i>, l’une de ces deux couleurs au -moins devant être définie. Cela permet à -la colorisation syntaxique de s’étendre sur -plusieurs lignes. Notez que toutes les occurrences -successives de <i>motif_début</i> après le -<i>motif_début</i> initial seront surlignées -jusqu’à la prochaine instance de -<i>motif_fin</i>.</p> +moins devant être définie. Cela +permet à la colorisation syntaxique de +s’étendre sur plusieurs lignes. Notez que +toutes les occurrences successives de +<i>motif_début</i> après le +<i>motif_début</i> initial seront +surlignées jusqu’à la +prochaine instance de <i>motif_fin</i>.</p> <p style="margin-left:11%;"><b>icolor</b> <i>couleur_texte</i><b>[,</b><i>couleur_fond</i><b>] -start="</b><i>motif_début</i><b>" +start="</b><i>motif_début</i><b>" +<br> end="</b><i>motif_fin</i><b>"</b></p> <p style="margin-left:15%;">Comme ci-dessus, mais la -recherche des motifs est effectuée sans tenir compte -de la casse.</p> +recherche des motifs est effectuée sans tenir +compte de la casse.</p> <p style="margin-left:11%;"><b>include</b> <i>fichier_de_syntaxes</i></p> <p style="margin-left:15%;">Lit le fichier <i>fichier_de_syntaxes</i> contenant une liste -autosuffisante de définitions de syntaxes. Ce fichier -ne doit contenir que des commandes <b>syntax</b>, +autosuffisante de définitions de syntaxes. Ce +fichier ne doit contenir que des commandes <b>syntax</b>, <b>color</b> et <b>icolor</b>.</p> <h2>FICHIERS @@ -525,7 +565,7 @@ ne doit contenir que des commandes <b>syntax</b>, <p style="margin-left:11%; margin-top: 1em"><i>$SYSCONFDIR/nanorc</i></p> <p style="margin-left:22%;">Fichier de configuration -général</p> +général</p> <p style="margin-left:11%;"><i>~/.nanorc</i></p> @@ -540,7 +580,7 @@ personnel</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b>(1) <i><br> /usr/share/doc/nano/examples/nanorc.sample</i> (ou son -équivalent sur votre système)</p> +équivalent sur votre système)</p> <h2>AUTEUR <a name="AUTEUR"></a> @@ -551,9 +591,10 @@ personnel</p> Allegretta <chrisa@asty.org> et d’autres (voir les fichiers <i>AUTHORS</i> et <i>THANKS</i> pour plus d’information). Cette page de manuel a -été initialement rédigée par -Jordi Mallach <jordi@gnu.org> pour le système -Debian (mais elle peut être utilisée par +été initialement +rédigée par Jordi Mallach +<jordi@gnu.org> pour le système Debian +(mais elle peut être utilisée par d’autres).</p> <h2>TRADUCTION @@ -562,26 +603,30 @@ d’autres).</p> <p style="margin-left:11%; margin-top: 1em">Cette -adaptation française a été -réalisée par Jean-Philippe Guérard +adaptation française a +été +réalisée par +Jean-Philippe Guérard <jean-philippe.guerard@tigreraye.org> le -29 novembre 2007 à partir de la version -1.56 du 11 octobre 2007 de la page de manuel de -nanorc (pour la version 2.0.0 de nano). Cette page a -été relue par Gérard Delafond.</p> +29 novembre 2007 à partir de la +version 1.56 du 11 octobre 2007 de la page de +manuel de nanorc (pour la version 2.0.0 de nano). Cette page +a été relue par +Gérard Delafond.</p> <p style="margin-left:11%; margin-top: 1em">Un maximum de -soin a été apporté lors de -l’élaboration de cette traduction ; -néanmoins, quelques imperfections peuvent subsister. -Si vous en rencontrez, que ce soit dans la version -française ou dans la version originale, -n’hésitez pas à les signaler à -l’auteur ou au traducteur.</p> +soin a été apporté +lors de l’élaboration de cette +traduction ; néanmoins, quelques +imperfections peuvent subsister. Si vous en rencontrez, que +ce soit dans la version française ou dans la +version originale, n’hésitez pas +à les signaler à l’auteur ou +au traducteur.</p> <p style="margin-left:11%; margin-top: 1em">La version -originale la plus à jour de ce document est toujours -consultable via la commande :</p> +originale la plus à jour de ce document est +toujours consultable via la commande :</p> <p style="margin-left:11%; margin-top: 1em">LANGUAGE=en man nano</p> diff --git a/doc/man/fr/rnano.1 b/doc/man/fr/rnano.1 index 2f64367..70c06f8 100644 --- a/doc/man/fr/rnano.1 +++ b/doc/man/fr/rnano.1 @@ -3,13 +3,13 @@ .\" Skeleton based on nano-tiny.1: .\" Copyright (C) 2002 Free Software Foundation, Inc. .\" -.\" Le travail d'adaptation française de cette page de manuel a été -.\" réalisé par Jean-Philippe Guérard, en 2006 et 2007. Ce travail +.\" Le travail d'adaptation française de cette page de manuel a été +.\" réalisé par Jean-Philippe Guérard, en 2006 et 2007. Ce travail .\" d'adaptation est dans le domaine public. Attention, la page traduite .\" reste soumise au droit d'auteur de ses auteurs originaux. .\" .\" The French translation of this document is a public domain work of -.\" Jean-Philippe Guérard. This translation work was made in 2006 and +.\" Jean-Philippe Guérard. This translation work was made in 2006 and .\" 2007. The translated man page in itself is still subject to the .\" copyright of its original authors. .\" @@ -29,126 +29,126 @@ .\" Documentation License along with this program. If not, see .\" <http://www.gnu.org/licenses/>. .\" -.\" Ce document est publié sous une double licence. Vous pouvez +.\" Ce document est publié sous une double licence. Vous pouvez .\" le distribuer et le modifier selon les termes de l'une des deux -.\" licences ci-dessous : +.\" licences ci-dessous : .\" -.\" * La Licence publique générale GNU (GNU GPL) version 3 ou, à -.\" votre choix, supérieure, telle que publiée par la Free -.\" Software Foundation. Vous devriez avoir reçu une copie de la -.\" Licence publique générale GNU avec ce programme. Si ce n'est pas +.\" * La Licence publique générale GNU (GNU GPL) version 3 ou, à +.\" votre choix, supérieure, telle que publiée par la Free +.\" Software Foundation. Vous devriez avoir reçu une copie de la +.\" Licence publique générale GNU avec ce programme. Si ce n'est pas .\" le cas, consultez <http://www.gnu.org/licenses/>. .\" .\" * La Licence de documentation libre GNU (GNU FDL), version 1.2 ou, -.\" à votre choix, supérieure, telle que publiée par la Free +.\" à votre choix, supérieure, telle que publiée par la Free .\" Software Foundation, sans section invariante, ni texte de -.\" première ou de quatrième de couverture. Vous devriez avoir reçu +.\" première ou de quatrième de couverture. Vous devriez avoir reçu .\" une copie de la Licence de documentation libre GNU avec ce .\" programme. Si ce n'est pas le cas, consultez .\" <http://www.gnu.org/licenses/>. .\" -.\" $Id: rnano.1 4188 2007-12-08 04:27:44Z dolorous $ +.\" $Id: rnano.1 5071 2014-07-16 17:25:55Z jordi $ .TH RNANO 1 "version 2.0.0" "29\ novembre\ 20O7" .\" Please adjust this date whenever revising the manpage. -.\" Merci de modifier ces dates à chaque mise à jour de cette page. +.\" Merci de modifier ces dates à chaque mise à jour de cette page. .\" .SH NOM -rnano \- Le mode restreint de NAno un NOuvel éditeur, un clone libre et -amélioré de Pico +rnano \- Le mode restreint de NAno un NOuvel éditeur, un clone libre et +amélioré de Pico .SH SYNOPSIS .B rnano -.I [OPTIONS]\ [[\+LIGNE,COLONNE]\ FICHIER]... +.I [OPTIONS]\ [[+LIGNE,COLONNE]\ FICHIER]... .br .SH DESCRIPTION -Cette page de manuel décrit brièvement la commande \fBrnano\fR. +Cette page de manuel décrit brièvement la commande \fBrnano\fR. .PP .\" TeX users may be more comfortable with the \fB<whatever>\fP and .\" \fI<whatever>\fP escape sequences to invoke bold face and italics, .\" respectively. -\fBnano\fR est un éditeur petit, sympathique et libre, qui vise à -remplacer Pico, l'éditeur par défaut du logiciel non libre Pine. +\fBnano\fR est un éditeur petit, sympathique et libre, qui vise à +remplacer Pico, l'éditeur par défaut du logiciel non libre Pine. \fBnano\fR ne se contentant pas de copier l'interface et l'ergonomie de -Pico, il offre également certaines fonctions manquantes (ou désactivées -par défaut) dans Pico. Ces fonctionnalités sont, par exemple, les -fonctions de recherche et de remplacement, et la possibilité de sauter -directement à une ligne et à une colonne précise.. +Pico, il offre également certaines fonctions manquantes (ou désactivées +par défaut) dans Pico. Ces fonctionnalités sont, par exemple, les +fonctions de recherche et de remplacement, et la possibilité de sauter +directement à une ligne et à une colonne précise.. .PP \fBrnano\fP est une version de \fBnano\fP fonctionnant en mode -restreint, qui ne permet d'éditer que les fichiers indiqués et qui -n'autorise pas l'utilisateur à accéder au système de fichier ou à un -interpréteur de commandes. +restreint, qui ne permet d'éditer que les fichiers indiqués et qui +n'autorise pas l'utilisateur à accéder au système de fichier ou à un +interpréteur de commandes. .PP En mode restreint, \fBnano\fP refusera\ : .IP \[bu] 2 -de lire ou d'écrire dans un fichier n'ayant pas été indiqué dans la +de lire ou d'écrire dans un fichier n'ayant pas été indiqué dans la ligne de commande\ ; .IP \[bu] de lire un fichier nanorc\ ; .IP \[bu] -de permettre de suspendre l'édition\ ; +de permettre de suspendre l'édition\ ; .IP \[bu] -de permettre d'ajouter en début ou en fin d'un fichier, ou de -l'enregistrer sous un nom différent\ ; +de permettre d'ajouter en début ou en fin d'un fichier, ou de +l'enregistrer sous un nom différent\ ; .IP \[bu] -l'utilisation de copies de sécurité ou de la correction orthographique. +l'utilisation de copies de sécurité ou de la correction orthographique. .SH OPTIONS .TP -.B \+\fILIGNE\fP,\fICOLONNE\fP -Démarre avec le curseur positionné à la colonne \fICOLONNE\fP de -la ligne \fILIGNE\fR (l'un des deux, au moins, devant être spécifié) au -lieu de démarrer à la colonne\ 1, ligne\ 1. +.B +\fILIGNE\fP,\fICOLONNE\fP +Démarre avec le curseur positionné à la colonne \fICOLONNE\fP de +la ligne \fILIGNE\fR (l'un des deux, au moins, devant être spécifié) au +lieu de démarrer à la colonne\ 1, ligne\ 1. .TP .B \-? -Identique à \fB-h (\-\-help)\fP. +Identique à \fB\-h (\-\-help)\fP. .TP .B \-h (\-\-help) -Affiche un résumé des options de lancement de nano, puis s'arrête. +Affiche un résumé des options de lancement de nano, puis s'arrête. .TP .B \-V (\-\-version) -Affiche la version, puis s'arrête. +Affiche la version, puis s'arrête. .PP -Reportez-vous à la page de manuel \fBnano\fP(1) si vous souhaitez -consulter la documentation complète de \fBnano\fP. +Reportez-vous à la page de manuel \fBnano\fP(1) si vous souhaitez +consulter la documentation complète de \fBnano\fP. .SH BOGUES Merci de nous faire parvenir vos commentaires et de nous signaler les -bogues, en écrivant, en anglais, à \fBnano@nano-editor.org\fR. +bogues, en écrivant, en anglais, à \fBnano@nano-editor.org\fR. -La liste de discussion anglophone \fBnano\fR est disponible à l'adresse +La liste de discussion anglophone \fBnano\fR est disponible à l'adresse \fBnano-devel@gnu.org\fR. -Pour vous abonner, envoyez un courrier électronique à -\fBnano-devel-request@gnu.org\fR, ayant pour objet «\ subscribe\ ». +Pour vous abonner, envoyez un courrier électronique à +\fBnano-devel-request@gnu.org\fR, ayant pour objet «\ subscribe\ ». -N'hésitez pas également à envoyez vos commentaires, suggestions et -corrections relatives à l'adaptation française de cette page de manuel -ou du logiciel à \fBjean-philippe.guerard@tigreraye.org\fR. +N'hésitez pas également à envoyez vos commentaires, suggestions et +corrections relatives à l'adaptation française de cette page de manuel +ou du logiciel à \fBjean-philippe.guerard@tigreraye.org\fR. .SH "SITE INTERNET" http://www.nano-editor.org/ .SH AUTEUR Chris Allegretta <chrisa@asty.org> et d'autres (voir le fichier -\fIAUTHORS\fR). Cette page de manuel a été initialement rédigée par -Thijs Kinkhorst <thijs@kinkhorst.com>, pour le système GNU Debian (mais -elle peut être utilisée par d'autres). +\fIAUTHORS\fR). Cette page de manuel a été initialement rédigée par +Thijs Kinkhorst <thijs@kinkhorst.com>, pour le système GNU Debian (mais +elle peut être utilisée par d'autres). .SH TRADUCTION -Cette adaptation française a été réalisée par Jean-Philippe\ Guérard -<jean-philippe.guerard@tigreraye.org> le 29\ novembre\ 2007 à partir +Cette adaptation française a été réalisée par Jean-Philippe\ Guérard +<jean-philippe.guerard@tigreraye.org> le 29\ novembre\ 2007 à partir de la version 1.19 du 6\ novembre\ 2007 de la page de manuel de rnano (pour la version 2.0.0 de nano). -Un maximum de soin a été apporté lors de l'élaboration de cette -traduction\ ; néanmoins, quelques imperfections peuvent subsister. Si -vous en rencontrez, que ce soit dans la version française ou dans la -version originale, n'hésitez pas à les signaler à l'auteur ou au +Un maximum de soin a été apporté lors de l'élaboration de cette +traduction\ ; néanmoins, quelques imperfections peuvent subsister. Si +vous en rencontrez, que ce soit dans la version française ou dans la +version originale, n'hésitez pas à les signaler à l'auteur ou au traducteur. -La version originale la plus à jour de ce document est toujours +La version originale la plus à jour de ce document est toujours consultable via la commande\ : LANGUAGE=en man nano diff --git a/doc/man/fr/rnano.1.html b/doc/man/fr/rnano.1.html index 26c2d1b..58d34fb 100644 --- a/doc/man/fr/rnano.1.html +++ b/doc/man/fr/rnano.1.html @@ -1,5 +1,5 @@ -<!-- Creator : groff version 1.20.1 --> -<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Thu Jul 17 11:02:17 2014 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -38,8 +38,9 @@ <p style="margin-left:11%; margin-top: 1em">rnano − -Le mode restreint de NAno un NOuvel éditeur, un clone -libre et amélioré de Pico</p> +Le mode restreint de NAno un NOuvel éditeur, un +clone libre et amélioré de +Pico</p> <h2>SYNOPSIS <a name="SYNOPSIS"></a> @@ -55,29 +56,31 @@ libre et amélioré de Pico</p> <p style="margin-left:11%; margin-top: 1em">Cette page de -manuel décrit brièvement la commande -<b>rnano</b>.</p> +manuel décrit brièvement la +commande <b>rnano</b>.</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> est -un éditeur petit, sympathique et libre, qui vise -à remplacer Pico, l’éditeur par -défaut du logiciel non libre Pine. <b>nano</b> ne se -contentant pas de copier l’interface et -l’ergonomie de Pico, il offre également -certaines fonctions manquantes (ou désactivées -par défaut) dans Pico. Ces fonctionnalités -sont, par exemple, les fonctions de recherche et de -remplacement, et la possibilité de sauter directement -à une ligne et à une colonne -précise..</p> +un éditeur petit, sympathique et libre, qui +vise à remplacer Pico, +l’éditeur par défaut du +logiciel non libre Pine. <b>nano</b> ne se contentant pas de +copier l’interface et l’ergonomie de Pico, il +offre également certaines fonctions manquantes +(ou désactivées par +défaut) dans Pico. Ces +fonctionnalités sont, par exemple, les +fonctions de recherche et de remplacement, et la +possibilité de sauter directement +à une ligne et à une colonne +précise..</p> <p style="margin-left:11%; margin-top: 1em"><b>rnano</b> est une version de <b>nano</b> fonctionnant en mode -restreint, qui ne permet d’éditer que les -fichiers indiqués et qui n’autorise pas -l’utilisateur à accéder au -système de fichier ou à un interpréteur -de commandes.</p> +restreint, qui ne permet d’éditer que les +fichiers indiqués et qui n’autorise pas +l’utilisateur à accéder au +système de fichier ou à un +interpréteur de commandes.</p> <p style="margin-left:11%; margin-top: 1em">En mode restreint, <b>nano</b> refusera :</p> @@ -94,9 +97,9 @@ restreint, <b>nano</b> refusera :</p> <td width="86%"> -<p>de lire ou d’écrire dans un fichier -n’ayant pas été indiqué dans la -ligne de commande ;</p></td></tr> +<p>de lire ou d’écrire dans un fichier +n’ayant pas été +indiqué dans la ligne de commande ;</p></td></tr> <tr valign="top" align="left"> <td width="11%"></td> <td width="1%"> @@ -119,7 +122,7 @@ ligne de commande ;</p></td></tr> <p>de permettre de suspendre -l’édition ;</p> </td></tr> +l’édition ;</p> </td></tr> <tr valign="top" align="left"> <td width="11%"></td> <td width="1%"> @@ -130,9 +133,9 @@ l’édition ;</p> </td></tr> <td width="86%"> -<p>de permettre d’ajouter en début ou en fin -d’un fichier, ou de l’enregistrer sous un nom -différent ;</p> </td></tr> +<p>de permettre d’ajouter en début ou en +fin d’un fichier, ou de l’enregistrer sous un +nom différent ;</p></td></tr> <tr valign="top" align="left"> <td width="11%"></td> <td width="1%"> @@ -143,8 +146,9 @@ différent ;</p> </td></tr> <td width="86%"> -<p>l’utilisation de copies de sécurité -ou de la correction orthographique.</p></td></tr> +<p>l’utilisation de copies de +sécurité ou de la correction +orthographique.</p> </td></tr> </table> <h2>OPTIONS @@ -155,11 +159,12 @@ ou de la correction orthographique.</p></td></tr> <p style="margin-left:11%; margin-top: 1em"><b>+</b><i>LIGNE</i><b>,</b><i>COLONNE</i></p> -<p style="margin-left:22%;">Démarre avec le curseur -positionné à la colonne <i>COLONNE</i> de la -ligne <i>LIGNE</i> (l’un des deux, au moins, devant -être spécifié) au lieu de -démarrer à la colonne 1, +<p style="margin-left:22%;">Démarre avec le +curseur positionné à la colonne +<i>COLONNE</i> de la ligne <i>LIGNE</i> (l’un des +deux, au moins, devant être +spécifié) au lieu de +démarrer à la colonne 1, ligne 1.</p> <table width="100%" border="0" rules="none" frame="void" @@ -171,30 +176,31 @@ ligne 1.</p> <p><b>−?</b></p></td> <td width="8%"></td> -<td width="36%"> +<td width="38%"> -<p>Identique à <b>-h (−−help)</b>.</p></td> -<td width="42%"> +<p>Identique à <b>−h +(−−help)</b>.</p> </td> +<td width="40%"> </td></tr> </table> <p style="margin-left:11%;"><b>−h (−−help)</b></p> -<p style="margin-left:22%;">Affiche un résumé -des options de lancement de nano, puis -s’arrête.</p> +<p style="margin-left:22%;">Affiche un +résumé des options de lancement de +nano, puis s’arrête.</p> <p style="margin-left:11%;"><b>−V (−−version)</b></p> <p style="margin-left:22%;">Affiche la version, puis -s’arrête.</p> +s’arrête.</p> <p style="margin-left:11%; margin-top: 1em">Reportez-vous -à la page de manuel <b>nano</b>(1) si vous souhaitez -consulter la documentation complète de +à la page de manuel <b>nano</b>(1) si vous +souhaitez consulter la documentation complète de <b>nano</b>.</p> <h2>BOGUES @@ -204,24 +210,25 @@ consulter la documentation complète de <p style="margin-left:11%; margin-top: 1em">Merci de nous faire parvenir vos commentaires et de nous signaler les -bogues, en écrivant, en anglais, à +bogues, en écrivant, en anglais, à <b>nano@nano-editor.org</b>.</p> <p style="margin-left:11%; margin-top: 1em">La liste de -discussion anglophone <b>nano</b> est disponible à -l’adresse <b>nano-devel@gnu.org</b>.</p> +discussion anglophone <b>nano</b> est disponible +à l’adresse +<b>nano-devel@gnu.org</b>.</p> <p style="margin-left:11%; margin-top: 1em">Pour vous -abonner, envoyez un courrier électronique à -<b>nano-devel-request@gnu.org</b>, ayant pour objet -« subscribe ».</p> +abonner, envoyez un courrier électronique +à <b>nano-devel-request@gnu.org</b>, ayant pour +objet « subscribe ».</p> -<p style="margin-left:11%; margin-top: 1em">N’hésitez -pas également à envoyez vos commentaires, -suggestions et corrections relatives à -l’adaptation française de cette page de manuel -ou du logiciel à +<p style="margin-left:11%; margin-top: 1em">N’hésitez +pas également à envoyez vos +commentaires, suggestions et corrections relatives +à l’adaptation française de +cette page de manuel ou du logiciel à <b>jean-philippe.guerard@tigreraye.org</b>.</p> <h2>SITE INTERNET @@ -240,10 +247,11 @@ ou du logiciel à <p style="margin-left:11%; margin-top: 1em">Chris Allegretta <chrisa@asty.org> et d’autres (voir le fichier <i>AUTHORS</i>). Cette page de manuel a -été initialement rédigée par -Thijs Kinkhorst <thijs@kinkhorst.com>, pour le -système GNU Debian (mais elle peut être -utilisée par d’autres).</p> +été initialement +rédigée par Thijs Kinkhorst +<thijs@kinkhorst.com>, pour le système GNU +Debian (mais elle peut être +utilisée par d’autres).</p> <h2>TRADUCTION <a name="TRADUCTION"></a> @@ -251,25 +259,28 @@ utilisée par d’autres).</p> <p style="margin-left:11%; margin-top: 1em">Cette -adaptation française a été -réalisée par Jean-Philippe Guérard +adaptation française a +été +réalisée par +Jean-Philippe Guérard <jean-philippe.guerard@tigreraye.org> le -29 novembre 2007 à partir de la version -1.19 du 6 novembre 2007 de la page de manuel de -rnano (pour la version 2.0.0 de nano).</p> +29 novembre 2007 à partir de la +version 1.19 du 6 novembre 2007 de la page de +manuel de rnano (pour la version 2.0.0 de nano).</p> <p style="margin-left:11%; margin-top: 1em">Un maximum de -soin a été apporté lors de -l’élaboration de cette traduction ; -néanmoins, quelques imperfections peuvent subsister. -Si vous en rencontrez, que ce soit dans la version -française ou dans la version originale, -n’hésitez pas à les signaler à -l’auteur ou au traducteur.</p> +soin a été apporté +lors de l’élaboration de cette +traduction ; néanmoins, quelques +imperfections peuvent subsister. Si vous en rencontrez, que +ce soit dans la version française ou dans la +version originale, n’hésitez pas +à les signaler à l’auteur ou +au traducteur.</p> <p style="margin-left:11%; margin-top: 1em">La version -originale la plus à jour de ce document est toujours -consultable via la commande :</p> +originale la plus à jour de ce document est +toujours consultable via la commande :</p> <p style="margin-left:11%; margin-top: 1em">LANGUAGE=en man nano</p> diff --git a/doc/man/nano.1 b/doc/man/nano.1 index 6921431..63ec8ec 100644 --- a/doc/man/nano.1 +++ b/doc/man/nano.1 @@ -1,6 +1,8 @@ .\" Hey, EMACS: -*- nroff -*- +.\" $Id: nano.1 5135 2015-03-08 15:59:15Z bens $ +.\" .\" Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, -.\" 2008, 2009 Free Software Foundation, Inc. +.\" 2009, 2010, 2013, 2014 Free Software Foundation, Inc. .\" .\" This document is dual-licensed. You may distribute and/or modify it .\" under the terms of either of the following licenses: @@ -18,8 +20,7 @@ .\" Documentation License along with this program. If not, see .\" <http://www.gnu.org/licenses/>. .\" -.\" $Id: nano.1 4502 2010-04-14 21:55:39Z astyanax $ -.TH NANO 1 "version 2.2.0" "November 30, 2009" +.TH NANO 1 "version 2.4.0" "March 2015" .\" Please adjust this date whenever revising the manpage. .\" @@ -28,203 +29,212 @@ nano \- Nano's ANOther editor, an enhanced free Pico clone .SH SYNOPSIS .B nano -.I [OPTIONS]\ [[\+LINE,COLUMN]\ FILE]... -.br +.RI [ options "] [[+" line , column "]\ " file "]..." .SH DESCRIPTION -This manual page briefly documents the \fBnano\fP command. -.PP -.\" TeX users may be more comfortable with the \fB<whatever>\fP and -.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, -.\" respectively. \fBnano\fP is a small, free and friendly editor which aims to replace -Pico, the default editor included in the non-free Pine package. Rather -than just copying Pico's look and feel, \fBnano\fP also implements some +Pico, the default editor included in the non-free Pine package. On +top of copying Pico's look and feel, \fBnano\fP also implements some missing (or disabled by default) features in Pico, such as "search and replace" and "go to line and column number". .SH OPTIONS .TP -.B \+\fILINE\fP,\fICOLUMN\fP -Places cursor at line number \fILINE\fP and column number \fICOLUMN\fP +.B +\fIline\fP,\fIcolumn\fP +Places the cursor on line number \fIline\fP and at column number \fIcolumn\fP (at least one of which must be specified) on startup, instead of the -default of line 1, column 1. +default line 1, column 1. .TP -.B \-? -Same as \fB-h (\-\-help)\fP. -.TP -.B \-A (\-\-smarthome) +.BR \-A ", " \-\-smarthome Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line. .TP -.B \-B (\-\-backup) +.BR \-B ", " \-\-backup When saving a file, back up the previous version of it to the current -filename suffixed with a ~. +filename suffixed with a tilde (\fB~\fP). .TP -.B \-C \fIdir\fP (\-\-backupdir=\fIdir\fP) -Set the directory where \fBnano\fP puts unique backup files if file +.BR \-C\ \fIdirectory\fR ", " \-\-backupdir= \fIdirectory +Set the directory where \fBnano\fP puts unique backup files, if file backups are enabled. .TP -.B \-D (\-\-boldtext) +.BR \-D ", " \-\-boldtext Use bold text instead of reverse video text. .TP -.B \-E (\-\-tabstospaces) +.BR \-E ", " \-\-tabstospaces Convert typed tabs to spaces. .TP -.B \-F (\-\-multibuffer) -Enable multiple file buffers, if available. +.BR \-F ", " \-\-multibuffer +Enable multiple file buffers (if support for them has been compiled in). +.TP +.BR \-G ", " \-\-locking +Enable vim-style file locking when editing files. .TP -.B \-H (\-\-historylog) -Log search and replace strings to \fI~/.nano_history\fP, so they can be -retrieved in later sessions, if \fInanorc\fP support is available. +.BR \-H ", " \-\-historylog +Log search and replace strings to \fI~/.nano/search_history\fP, so they can be +retrieved in later sessions. .TP -.B \-I (\-\-ignorercfiles) -Don't look at \fISYSCONFDIR/nanorc\fP or \fI~/.nanorc\fP, if -\fInanorc\fP support is available. +.BR \-I ", " \-\-ignorercfiles +Don't look at the system's \fBnanorc\fP nor at \fB~/.nanorc\fP. .TP -.B \-K (\-\-rebindkeypad) +.BR \-K ", " \-\-rebindkeypad Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. .TP -.B \-L (\-\-nonewlines) +.BR \-L ", " \-\-nonewlines Don't add newlines to the ends of files. .TP -.B \-N (\-\-noconvert) +.BR \-N ", " \-\-noconvert Disable automatic conversion of files from DOS/Mac format. .TP -.B \-O (\-\-morespace) +.BR \-O ", " \-\-morespace Use the blank line below the titlebar as extra editing space. .TP -.B \-Q \fIstr\fP (\-\-quotestr=\fIstr\fP) +.BR \-P ", " \-\-poslog +Log and later read back the location of the cursor and place it there +again. +.TP +.BR "\-Q ""\fIcharacters\fB""" ", " "\-\-quotestr=""" \fIcharacters\fR """ Set the quoting string for justifying. The default is -"\fI^([\ \\t]*[#:>\\|}])+\fP" if extended regular expression support is -available, or "\fI>\ \fP" otherwise. Note that \fI\\t\fP stands for a +\fB"^([\ \\t]*[#:>\\|}])+"\fP if extended regular expression support is +available, or \fB">\ "\fP otherwise. Note that \fB\\t\fP stands for a Tab. .TP -.B \-R (\-\-restricted) +.BR \-R ", " \-\-restricted Restricted mode: don't read or write to any file not specified on the -command line; read any \fInanorc\fP files; allow suspending; allow a -file to be appended to, prepended to, or saved under a different name if -it already has one; or use backup files or spell checking. Also -accessible by invoking \fBnano\fP with any name beginning with 'r' (e.g. -"rnano"). -.TP -.B \-S (\-\-smooth) +command line; don't read any \fInanorc\fP files nor history files; +don't allow suspending nor spell checking; +don't allow a file to be appended to, prepended to, or saved under a +different name if it already has one; and don't use backup files. +This restricted mode is also accessible by invoking \fBnano\fP +with any name beginning with 'r' (e.g. "rnano"). +.TP +.BR \-S ", " \-\-smooth Enable smooth scrolling. Text will scroll line-by-line, instead of the usual chunk-by-chunk behavior. .TP -.B \-T \fIcols\fP (\-\-tabsize=\fIcols\fP) -Set the size (width) of a tab to \fIcols\fP columns. The value of -\fIcols\fP must be greater than 0. The default value is 8. +.BR \-T\ \fInumber\fR ", " \-\-tabsize= \fInumber +Set the size (width) of a tab to \fInumber\fP columns. The value of +\fInumber\fP must be greater than 0. The default value is 8. .TP -.B \-U (\-\-quickblank) +.BR \-U ", " \-\-quickblank Do quick statusbar blanking. Statusbar messages will disappear after 1 -keystroke instead of 25. Note that \fB-c\fP overrides this. +keystroke instead of 25. Note that \fB\-c\fP overrides this. .TP -.B \-V (\-\-version) +.BR \-V ", " \-\-version Show the current version number and exit. .TP -.B \-W (\-\-wordbounds) +.BR \-W ", " \-\-wordbounds Detect word boundaries more accurately by treating punctuation characters as part of a word. .TP -.B \-Y \fIstr\fP (\-\-syntax=\fIstr\fP) -Specify a specific syntax highlighting from the \fInanorc\fP to use, if -available. +.BR \-Y\ \fIname\fR ", " \-\-syntax= \fIname +Specify the name of the syntax highlighting to use from among the ones +defined in the \fInanorc\fP files. .TP -.B \-c (\-\-const) -Constantly show the cursor position. Note that this overrides \fB-U\fP. +.BR \-c ", " \-\-const +Constantly show the cursor position. Note that this overrides \fB\-U\fP. .TP -.B \-d (\-\-rebinddelete) +.BR \-d ", " \-\-rebinddelete Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. .TP -.B \-h (\-\-help) -Show a summary of command line options and exit. +.BR \-h ", " \-\-help +Show a summary of the available command-line options and exit. .TP -.B \-i (\-\-autoindent) +.BR \-i ", " \-\-autoindent Indent new lines to the previous line's indentation. Useful when editing source code. .TP -.B \-k (\-\-cut) -Enable cut from cursor to end of line. +.BR \-k ", " \-\-cut +Make the 'Cut Text' command (normally ^K) cut from the current cursor +position to the end of the line, instead of cutting the entire line. .TP -.B \-l (\-\-nofollow) +.BR \-l ", " \-\-nofollow If the file being edited is a symbolic link, replace the link with a new file instead of following it. Good for editing files in \fI/tmp\fP, perhaps? .TP -.B \-m (\-\-mouse) +.BR \-m ", " \-\-mouse Enable mouse support, if available for your system. When enabled, mouse clicks can be used to place the cursor, set the mark (with a double click), and execute shortcuts. The mouse will work in the X Window -System, and on the console when gpm is running. +System, and on the console when gpm is running. Text can still be +selected through dragging by holding down the Shift key. .TP -.B \-o \fIdir\fP (\-\-operatingdir=\fIdir\fP) -Set operating directory. Makes \fBnano\fP set up something similar to a -chroot. +.BR \-n ", " \-\-noread +Treat any name given on the command line as a new file. This allows +\fBnano\fR to write to named pipes: it will start with a blank buffer, +and will write to the pipe when the user saves the "file". This way +\fBnano\fR can be used as an editor in combination with for instance +\fBgpg\fR without having to write sensitive data to disk first. .TP -.B \-p (\-\-preserve) +.BR \-o\ \fIdirectory\fR ", " \-\-operatingdir= \fIdirectory +Set the operating directory. This makes \fBnano\fP set up something +similar to a chroot. +.TP +.BR \-p ", " \-\-preserve Preserve the XON and XOFF sequences (^Q and ^S) so they will be caught by the terminal. .TP -.B \-q (\-\-quiet) -Do not report errors in the \fInanorc\fP file and ask them to be +.BR \-q ", " \-\-quiet +Do not report errors in the \fInanorc\fP files nor ask them to be acknowledged by pressing Enter at startup. .TP -.B \-r \fIcols\fP (\-\-fill=\fIcols\fP) -Wrap lines at column \fIcols\fP. If this value is 0 or less, wrapping -will occur at the width of the screen less \fIcols\fP columns, allowing +.BR \-r\ \fInumber\fR ", " \-\-fill= \fInumber +Hard-wrap lines at column \fInumber\fP. If this value is 0 or less, wrapping +will occur at the width of the screen less \fInumber\fP columns, allowing the wrap point to vary along with the width of the screen if the screen -is resized. The default value is \-8. +is resized. The default value is \-8. This option conflicts with +.B \-w +-- the last one given takes effect. .TP -.B \-s \fIprog\fP (\-\-speller=\fIprog\fP) -Enable alternative spell checker command. +.BR \-s\ \fIprogram\fR ", " \-\-speller= \fIprogram +Use this alternative spell checker command. .TP -.B \-t (\-\-tempfile) -Always save changed buffer without prompting. Same as Pico's \fB-t\fP +.BR \-t ", " \-\-tempfile +Always save a changed buffer without prompting. Same as Pico's \fB\-t\fP option. .TP -.B \-u (\-\-undo) -Enable experimental generic-purpose undo code. By default, the undo and redo -shortcuts are Meta-U and Meta-E, respectively. -.TP -.B \-v (\-\-view) -View file (read only) mode. +.BR \-v ", " \-\-view +View-file (read-only) mode. .TP -.B \-w (\-\-nowrap) -Disable wrapping of long lines. +.BR \-w ", " \-\-nowrap +Disable the hard-wrapping of long lines. This option conflicts with +.B \-r +-- the last one given takes effect. .TP -.B \-x (\-\-nohelp) -Disable help screen at bottom of editor. +.BR \-x ", " \-\-nohelp +Don't show the two help lines at the bottom of the screen. .TP -.B \-z (\-\-suspend) -Enable suspend ability. +.BR \-z ", " \-\-suspend +Enable the suspend ability. .TP -.B \-$ (\-\-softwrap) -Enable 'soft wrapping'. \fBnano\fP will attempt to display the entire -contents of a line, even if it is longer than the screen width. Since +.BR \-$ ", " \-\-softwrap +Enable 'soft wrapping'. This will make \fBnano\fP attempt to display the +entire contents of any line, even if it is longer than the screen width, by +continuing it over multiple screen lines. Since \&'$' normally refers to a variable in the Unix shell, you should specify -this option last when using other options (e.g. 'nano \-wS$') or pass it -separately (e.g. 'nano \-wS \-$'). +this option last when using other options (e.g.\& 'nano \-wS$') or pass it +separately (e.g.\& 'nano \-wS \-$'). .TP -.B \-a, \-b, \-e, \-f, \-g, \-j +.BR \-a ", " \-b ", " \-e ", " \-f ", " \-g ", " \-j Ignored, for compatibility with Pico. .SH INITIALIZATION FILE \fBnano\fP will read initialization files in the following order: -\fISYSCONFDIR/nanorc\fP, then \fI~/.nanorc\fP. Please see -\fBnanorc(5)\fP and the example file \fBnanorc.sample\fP, both of which -should be provided with \fBnano\fP. +the system's \fBnanorc\fP (if it exists), and then the user's +\fB~/.nanorc\fP (if it exists). Please see +.BR nanorc (5) +for more information on the possible contents of those files. .SH NOTES If no alternative spell checker command is specified on the command -line or in one of the \fInanorc\fP files, \fBnano\fP will check the +line nor in one of the \fInanorc\fP files, \fBnano\fP will check the \fBSPELL\fP environment variable for one. In some cases \fBnano\fP will try to dump the buffer into an emergency @@ -233,7 +243,7 @@ SIGTERM or runs out of memory. It will write the buffer into a file named \fInano.save\fP if the buffer didn't have a name already, or will add a ".save" suffix to the current filename. If an emergency file with that name already exists in the current directory, it will add ".save" -plus a number (e.g. ".save.1") to the current filename in order to make +plus a number (e.g.\& ".save.1") to the current filename in order to make it unique. In multibuffer mode, \fBnano\fP will write all the open buffers to their respective emergency files. @@ -256,7 +266,7 @@ http://www.nano-editor.org/ \fI/usr/share/doc/nano/\fP (or equivalent on your system) .SH AUTHOR -Chris Allegretta <chrisa@asty.org>, et al (see \fIAUTHORS\fP and +Chris Allegretta <chrisa@asty.org>, et al (see the files \fIAUTHORS\fP and \fITHANKS\fP for details). This manual page was originally written by Jordi Mallach <jordi@gnu.org>, for the Debian system (but may be used by others). diff --git a/doc/man/nano.1.html b/doc/man/nano.1.html index cb1101e..bd7b43f 100644 --- a/doc/man/nano.1.html +++ b/doc/man/nano.1.html @@ -1,5 +1,5 @@ -<!-- Creator : groff version 1.20.1 --> -<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Sun Mar 22 23:46:10 2015 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -48,22 +48,20 @@ Nano’s ANOther editor, an enhanced free Pico clone</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> -<i>[OPTIONS] [[+LINE,COLUMN] FILE]...</i></p> +[<i>options</i>] +[[+<i>line</i>,<i>column</i>] <i>file</i>]...</p> <h2>DESCRIPTION <a name="DESCRIPTION"></a> </h2> -<p style="margin-left:11%; margin-top: 1em">This manual -page briefly documents the <b>nano</b> command.</p> - <p style="margin-left:11%; margin-top: 1em"><b>nano</b> is a small, free and friendly editor which aims to replace Pico, the default editor included in the non-free Pine -package. Rather than just copying Pico’s look and -feel, <b>nano</b> also implements some missing (or disabled -by default) features in Pico, such as "search and +package. On top of copying Pico’s look and feel, +<b>nano</b> also implements some missing (or disabled by +default) features in Pico, such as "search and replace" and "go to line and column number".</p> @@ -73,32 +71,15 @@ number".</p> -<p style="margin-left:11%; margin-top: 1em"><b>+</b><i>LINE</i><b>,</b><i>COLUMN</i></p> - -<p style="margin-left:22%;">Places cursor at line number -<i>LINE</i> and column number <i>COLUMN</i> (at least one of -which must be specified) on startup, instead of the default -of line 1, column 1.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−?</b></p></td> -<td width="8%"></td> -<td width="30%"> +<p style="margin-left:11%; margin-top: 1em"><b>+</b><i>line</i><b>,</b><i>column</i></p> +<p style="margin-left:22%;">Places the cursor on line +number <i>line</i> and at column number <i>column</i> (at +least one of which must be specified) on startup, instead of +the default line 1, column 1.</p> -<p>Same as <b>-h (−−help)</b>.</p></td> -<td width="48%"> -</td></tr> -</table> - -<p style="margin-left:11%;"><b>−A -(−−smarthome)</b></p> +<p style="margin-left:11%;"><b>−A</b>, +<b>−−smarthome</b></p> <p style="margin-left:22%;">Make the Home key smarter. When Home is pressed anywhere but at the very beginning of @@ -107,277 +88,309 @@ that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line.</p> -<p style="margin-left:11%;"><b>−B -(−−backup)</b></p> +<p style="margin-left:11%;"><b>−B</b>, +<b>−−backup</b></p> <p style="margin-left:22%;">When saving a file, back up the previous version of it to the current filename suffixed with -a ~.</p> +a tilde (<b>~</b>).</p> + -<p style="margin-left:11%;"><b>−C</b> <i>dir</i> -<b>(−−backupdir=</b><i>dir</i><b>)</b></p> +<p style="margin-left:11%;"><b>−C </b><i>directory</i>, +<b>−−backupdir=</b><i>directory</i></p> <p style="margin-left:22%;">Set the directory where -<b>nano</b> puts unique backup files if file backups are +<b>nano</b> puts unique backup files, if file backups are enabled.</p> -<p style="margin-left:11%;"><b>−D -(−−boldtext)</b></p> +<p style="margin-left:11%;"><b>−D</b>, +<b>−−boldtext</b></p> <p style="margin-left:22%;">Use bold text instead of reverse video text.</p> -<p style="margin-left:11%;"><b>−E -(−−tabstospaces)</b></p> +<p style="margin-left:11%;"><b>−E</b>, +<b>−−tabstospaces</b></p> <p style="margin-left:22%;">Convert typed tabs to spaces.</p> -<p style="margin-left:11%;"><b>−F -(−−multibuffer)</b></p> +<p style="margin-left:11%;"><b>−F</b>, +<b>−−multibuffer</b></p> + +<p style="margin-left:22%;">Enable multiple file buffers +(if support for them has been compiled in).</p> -<p style="margin-left:22%;">Enable multiple file buffers, -if available.</p> +<p style="margin-left:11%;"><b>−G</b>, +<b>−−locking</b></p> -<p style="margin-left:11%;"><b>−H -(−−historylog)</b></p> +<p style="margin-left:22%;">Enable vim-style file locking +when editing files.</p> + +<p style="margin-left:11%;"><b>−H</b>, +<b>−−historylog</b></p> <p style="margin-left:22%;">Log search and replace strings -to <i>~/.nano_history</i>, so they can be retrieved in later -sessions, if <i>nanorc</i> support is available.</p> +to <i>~/.nano/search_history</i>, so they can be retrieved +in later sessions.</p> -<p style="margin-left:11%;"><b>−I -(−−ignorercfiles)</b></p> +<p style="margin-left:11%;"><b>−I</b>, +<b>−−ignorercfiles</b></p> -<p style="margin-left:22%;">Don’t look at -<i>SYSCONFDIR/nanorc</i> or <i>~/.nanorc</i>, if -<i>nanorc</i> support is available.</p> +<p style="margin-left:22%;">Don’t look at the +system’s <b>nanorc</b> nor at <b>~/.nanorc</b>.</p> -<p style="margin-left:11%;"><b>−K -(−−rebindkeypad)</b></p> +<p style="margin-left:11%;"><b>−K</b>, +<b>−−rebindkeypad</b></p> <p style="margin-left:22%;">Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don’t, as mouse support won’t work properly with this option enabled.</p> -<p style="margin-left:11%;"><b>−L -(−−nonewlines)</b></p> +<p style="margin-left:11%;"><b>−L</b>, +<b>−−nonewlines</b></p> <p style="margin-left:22%;">Don’t add newlines to the ends of files.</p> -<p style="margin-left:11%;"><b>−N -(−−noconvert)</b></p> +<p style="margin-left:11%;"><b>−N</b>, +<b>−−noconvert</b></p> <p style="margin-left:22%;">Disable automatic conversion of files from DOS/Mac format.</p> -<p style="margin-left:11%;"><b>−O -(−−morespace)</b></p> +<p style="margin-left:11%;"><b>−O</b>, +<b>−−morespace</b></p> <p style="margin-left:22%;">Use the blank line below the titlebar as extra editing space.</p> -<p style="margin-left:11%;"><b>−Q</b> <i>str</i> -<b>(−−quotestr=</b><i>str</i><b>)</b></p> +<p style="margin-left:11%;"><b>−P</b>, +<b>−−poslog</b></p> + +<p style="margin-left:22%;">Log and later read back the +location of the cursor and place it there again.</p> + +<p style="margin-left:11%;"><b>−Q +"</b><i>characters</i><b>"</b>, +<b>−−quotestr="</b><i>characters</i><b>"</b></p> <p style="margin-left:22%;">Set the quoting string for justifying. The default is -"<i>^([ \t]*[#:>\|}])+</i>" if extended +<b>"^([ \t]*[#:>\|}])+"</b> if extended regular expression support is available, or -"<i>> </i>" otherwise. Note that <i>\t</i> +<b>"> "</b> otherwise. Note that <b>\t</b> stands for a Tab.</p> -<p style="margin-left:11%;"><b>−R -(−−restricted)</b></p> +<p style="margin-left:11%;"><b>−R</b>, +<b>−−restricted</b></p> <p style="margin-left:22%;">Restricted mode: don’t read or write to any file not specified on the command line; -read any <i>nanorc</i> files; allow suspending; allow a file -to be appended to, prepended to, or saved under a different -name if it already has one; or use backup files or spell -checking. Also accessible by invoking <b>nano</b> with any -name beginning with ’r’ (e.g. -"rnano").</p> +don’t read any <i>nanorc</i> files nor history files; +don’t allow suspending nor spell checking; don’t +allow a file to be appended to, prepended to, or saved under +a different name if it already has one; and don’t use +backup files. This restricted mode is also accessible by +invoking <b>nano</b> with any name beginning with +’r’ (e.g. "rnano").</p> -<p style="margin-left:11%;"><b>−S -(−−smooth)</b></p> +<p style="margin-left:11%;"><b>−S</b>, +<b>−−smooth</b></p> <p style="margin-left:22%;">Enable smooth scrolling. Text will scroll line-by-line, instead of the usual chunk-by-chunk behavior.</p> -<p style="margin-left:11%;"><b>−T</b> <i>cols</i> -<b>(−−tabsize=</b><i>cols</i><b>)</b></p> + +<p style="margin-left:11%;"><b>−T </b><i>number</i>, +<b>−−tabsize=</b><i>number</i></p> <p style="margin-left:22%;">Set the size (width) of a tab -to <i>cols</i> columns. The value of <i>cols</i> must be +to <i>number</i> columns. The value of <i>number</i> must be greater than 0. The default value is 8.</p> -<p style="margin-left:11%;"><b>−U -(−−quickblank)</b></p> +<p style="margin-left:11%;"><b>−U</b>, +<b>−−quickblank</b></p> <p style="margin-left:22%;">Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead -of 25. Note that <b>-c</b> overrides this.</p> +of 25. Note that <b>−c</b> overrides this.</p> -<p style="margin-left:11%;"><b>−V -(−−version)</b></p> +<p style="margin-left:11%;"><b>−V</b>, +<b>−−version</b></p> <p style="margin-left:22%;">Show the current version number and exit.</p> -<p style="margin-left:11%;"><b>−W -(−−wordbounds)</b></p> +<p style="margin-left:11%;"><b>−W</b>, +<b>−−wordbounds</b></p> <p style="margin-left:22%;">Detect word boundaries more accurately by treating punctuation characters as part of a word.</p> -<p style="margin-left:11%;"><b>−Y</b> <i>str</i> -<b>(−−syntax=</b><i>str</i><b>)</b></p> -<p style="margin-left:22%;">Specify a specific syntax -highlighting from the <i>nanorc</i> to use, if -available.</p> +<p style="margin-left:11%;"><b>−Y </b><i>name</i>, +<b>−−syntax=</b><i>name</i></p> + +<p style="margin-left:22%;">Specify the name of the syntax +highlighting to use from among the ones defined in the +<i>nanorc</i> files.</p> -<p style="margin-left:11%;"><b>−c -(−−const)</b></p> +<p style="margin-left:11%;"><b>−c</b>, +<b>−−const</b></p> <p style="margin-left:22%;">Constantly show the cursor -position. Note that this overrides <b>-U</b>.</p> +position. Note that this overrides <b>−U</b>.</p> -<p style="margin-left:11%;"><b>−d -(−−rebinddelete)</b></p> +<p style="margin-left:11%;"><b>−d</b>, +<b>−−rebinddelete</b></p> <p style="margin-left:22%;">Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system.</p> -<p style="margin-left:11%;"><b>−h -(−−help)</b></p> +<p style="margin-left:11%;"><b>−h</b>, +<b>−−help</b></p> -<p style="margin-left:22%;">Show a summary of command line -options and exit.</p> +<p style="margin-left:22%;">Show a summary of the available +command-line options and exit.</p> -<p style="margin-left:11%;"><b>−i -(−−autoindent)</b></p> +<p style="margin-left:11%;"><b>−i</b>, +<b>−−autoindent</b></p> <p style="margin-left:22%;">Indent new lines to the previous line’s indentation. Useful when editing source code.</p> -<p style="margin-left:11%;"><b>−k -(−−cut)</b></p> +<p style="margin-left:11%;"><b>−k</b>, +<b>−−cut</b></p> -<p style="margin-left:22%;">Enable cut from cursor to end -of line.</p> +<p style="margin-left:22%;">Make the ’Cut Text’ +command (normally ^K) cut from the current cursor position +to the end of the line, instead of cutting the entire +line.</p> -<p style="margin-left:11%;"><b>−l -(−−nofollow)</b></p> +<p style="margin-left:11%;"><b>−l</b>, +<b>−−nofollow</b></p> <p style="margin-left:22%;">If the file being edited is a symbolic link, replace the link with a new file instead of following it. Good for editing files in <i>/tmp</i>, perhaps?</p> -<p style="margin-left:11%;"><b>−m -(−−mouse)</b></p> +<p style="margin-left:11%;"><b>−m</b>, +<b>−−mouse</b></p> <p style="margin-left:22%;">Enable mouse support, if available for your system. When enabled, mouse clicks can be used to place the cursor, set the mark (with a double click), and execute shortcuts. The mouse will work in the X -Window System, and on the console when gpm is running.</p> +Window System, and on the console when gpm is running. Text +can still be selected through dragging by holding down the +Shift key.</p> + +<p style="margin-left:11%;"><b>−n</b>, +<b>−−noread</b></p> + +<p style="margin-left:22%;">Treat any name given on the +command line as a new file. This allows <b>nano</b> to write +to named pipes: it will start with a blank buffer, and will +write to the pipe when the user saves the "file". +This way <b>nano</b> can be used as an editor in combination +with for instance <b>gpg</b> without having to write +sensitive data to disk first.</p> -<p style="margin-left:11%;"><b>−o</b> <i>dir</i> -<b>(−−operatingdir=</b><i>dir</i><b>)</b></p> -<p style="margin-left:22%;">Set operating directory. Makes -<b>nano</b> set up something similar to a chroot.</p> +<p style="margin-left:11%;"><b>−o </b><i>directory</i>, +<b>−−operatingdir=</b><i>directory</i></p> -<p style="margin-left:11%;"><b>−p -(−−preserve)</b></p> +<p style="margin-left:22%;">Set the operating directory. +This makes <b>nano</b> set up something similar to a +chroot.</p> + +<p style="margin-left:11%;"><b>−p</b>, +<b>−−preserve</b></p> <p style="margin-left:22%;">Preserve the XON and XOFF sequences (^Q and ^S) so they will be caught by the terminal.</p> -<p style="margin-left:11%;"><b>−q -(−−quiet)</b></p> +<p style="margin-left:11%;"><b>−q</b>, +<b>−−quiet</b></p> <p style="margin-left:22%;">Do not report errors in the -<i>nanorc</i> file and ask them to be acknowledged by +<i>nanorc</i> files nor ask them to be acknowledged by pressing Enter at startup.</p> -<p style="margin-left:11%;"><b>−r</b> <i>cols</i> -<b>(−−fill=</b><i>cols</i><b>)</b></p> -<p style="margin-left:22%;">Wrap lines at column -<i>cols</i>. If this value is 0 or less, wrapping will occur -at the width of the screen less <i>cols</i> columns, +<p style="margin-left:11%;"><b>−r </b><i>number</i>, +<b>−−fill=</b><i>number</i></p> + +<p style="margin-left:22%;">Hard-wrap lines at column +<i>number</i>. If this value is 0 or less, wrapping will +occur at the width of the screen less <i>number</i> columns, allowing the wrap point to vary along with the width of the screen if the screen is resized. The default value is -−8.</p> +−8. This option conflicts with <b>−w</b> -- the +last one given takes effect.</p> + -<p style="margin-left:11%;"><b>−s</b> <i>prog</i> -<b>(−−speller=</b><i>prog</i><b>)</b></p> +<p style="margin-left:11%;"><b>−s </b><i>program</i>, +<b>−−speller=</b><i>program</i></p> -<p style="margin-left:22%;">Enable alternative spell +<p style="margin-left:22%;">Use this alternative spell checker command.</p> -<p style="margin-left:11%;"><b>−t -(−−tempfile)</b></p> +<p style="margin-left:11%;"><b>−t</b>, +<b>−−tempfile</b></p> -<p style="margin-left:22%;">Always save changed buffer -without prompting. Same as Pico’s <b>-t</b> +<p style="margin-left:22%;">Always save a changed buffer +without prompting. Same as Pico’s <b>−t</b> option.</p> -<p style="margin-left:11%;"><b>−u -(−−undo)</b></p> - -<p style="margin-left:22%;">Enable experimental -generic-purpose undo code. By default, the undo and redo -shortcuts are Meta-U and Meta-E, respectively.</p> - -<p style="margin-left:11%;"><b>−v -(−−view)</b></p> +<p style="margin-left:11%;"><b>−v</b>, +<b>−−view</b></p> -<p style="margin-left:22%;">View file (read only) mode.</p> +<p style="margin-left:22%;">View-file (read-only) mode.</p> -<p style="margin-left:11%;"><b>−w -(−−nowrap)</b></p> +<p style="margin-left:11%;"><b>−w</b>, +<b>−−nowrap</b></p> -<p style="margin-left:22%;">Disable wrapping of long -lines.</p> +<p style="margin-left:22%;">Disable the hard-wrapping of +long lines. This option conflicts with <b>−r</b> -- +the last one given takes effect.</p> -<p style="margin-left:11%;"><b>−x -(−−nohelp)</b></p> +<p style="margin-left:11%;"><b>−x</b>, +<b>−−nohelp</b></p> -<p style="margin-left:22%;">Disable help screen at bottom -of editor.</p> +<p style="margin-left:22%;">Don’t show the two help +lines at the bottom of the screen.</p> -<p style="margin-left:11%;"><b>−z -(−−suspend)</b></p> +<p style="margin-left:11%;"><b>−z</b>, +<b>−−suspend</b></p> -<p style="margin-left:22%;">Enable suspend ability.</p> +<p style="margin-left:22%;">Enable the suspend ability.</p> -<p style="margin-left:11%;"><b>−$ -(−−softwrap)</b></p> +<p style="margin-left:11%;"><b>−$</b>, +<b>−−softwrap</b></p> <p style="margin-left:22%;">Enable ’soft -wrapping’. <b>nano</b> will attempt to display the -entire contents of a line, even if it is longer than the -screen width. Since ’$’ normally refers to a +wrapping’. This will make <b>nano</b> attempt to +display the entire contents of any line, even if it is +longer than the screen width, by continuing it over multiple +screen lines. Since ’$’ normally refers to a variable in the Unix shell, you should specify this option last when using other options (e.g. ’nano −wS$’) or pass it separately (e.g. ’nano −wS −$’).</p> -<p style="margin-left:11%;"><b>−a, −b, -−e, −f, −g, −j</b></p> +<p style="margin-left:11%;"><b>−a</b>, +<b>−b</b>, <b>−e</b>, <b>−f</b>, +<b>−g</b>, <b>−j</b></p> <p style="margin-left:22%;">Ignored, for compatibility with Pico.</p> @@ -388,10 +401,11 @@ Pico.</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> -will read initialization files in the following order: -<i>SYSCONFDIR/nanorc</i>, then <i>~/.nanorc</i>. Please see -<b>nanorc(5)</b> and the example file <b>nanorc.sample</b>, -both of which should be provided with <b>nano</b>.</p> +will read initialization files in the following order: the +system’s <b>nanorc</b> (if it exists), and then the +user’s <b>~/.nanorc</b> (if it exists). Please see +<b>nanorc</b>(5) for more information on the possible +contents of those files.</p> <h2>NOTES <a name="NOTES"></a> @@ -400,7 +414,7 @@ both of which should be provided with <b>nano</b>.</p> <p style="margin-left:11%; margin-top: 1em">If no alternative spell checker command is specified on the -command line or in one of the <i>nanorc</i> files, +command line nor in one of the <i>nanorc</i> files, <b>nano</b> will check the <b>SPELL</b> environment variable for one.</p> @@ -458,7 +472,7 @@ email to <b>nano-devel-request@gnu.org</b> with a subject of <p style="margin-left:11%; margin-top: 1em">Chris -Allegretta <chrisa@asty.org>, et al (see +Allegretta <chrisa@asty.org>, et al (see the files <i>AUTHORS</i> and <i>THANKS</i> for details). This manual page was originally written by Jordi Mallach <jordi@gnu.org>, for the Debian system (but may be diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5 index 3c69209..c2c802d 100644 --- a/doc/man/nanorc.5 +++ b/doc/man/nanorc.5 @@ -1,6 +1,8 @@ .\" Hey, EMACS: -*- nroff -*- -.\" Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 -.\" Free Software Foundation, Inc. +.\" $Id: nanorc.5 5135 2015-03-08 15:59:15Z bens $ +.\" +.\" Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, +.\" 2013, 2014, 2015 Free Software Foundation, Inc. .\" .\" This document is dual-licensed. You may distribute and/or modify it .\" under the terms of either of the following licenses: @@ -18,242 +20,296 @@ .\" Documentation License along with this program. If not, see .\" <http://www.gnu.org/licenses/>. .\" -.\" $Id: nanorc.5 4508 2010-06-21 03:10:10Z astyanax $ -.TH NANORC 5 "version 2.0.0" "August 23, 2007" +.TH NANORC 5 "version 2.4.0" "March 2015" .\" Please adjust this date whenever revising the manpage. .\" .SH NAME nanorc \- GNU nano's rcfile .SH DESCRIPTION -This manual page briefly documents GNU \fBnano\fP's rcfile. -.PP -\fBnano\fP is a small, free and friendly editor which aims to replace -Pico, the default editor included in the non-free Pine package. Rather -than just copying Pico's look and feel, \fBnano\fP also implements some -missing (or disabled by default) features in Pico, such as "search and -replace" and "go to line and column number". -.PP -The \fInanorc\fP file contains the default settings for \fBnano\fP. It -should not be in DOS or Mac format. During startup, \fBnano\fP will -first read its system-wide settings from \fISYSCONFDIR/nanorc\fP, and -then user-specific settings from \fI~/.nanorc\fP. +The \fInanorc\fP file contains the default settings for \fBnano\fP, a +small and friendly editor. The file should be in Unix format, not in +DOS or Mac format. During startup, \fBnano\fP will first read the +system-wide settings, from \fB/etc/nanorc\fP (the exact path might be +different), and then the user-specific settings, from \fB~/.nanorc\fP. .SH OPTIONS The configuration file accepts a series of \fBset\fP and \fBunset\fP commands, which can be used to configure nano on startup without using -the command line options. Additionally, the \fBsyntax\fP, \fBcolor\fP, -and \fBicolor\fP keywords are used to define syntax highlighting rules -for different text patterns. \fBnano\fP will read one command per line. - +command-line options. Additionally, there are some commands to define +syntax highlighting and to rebind keys -- see the two separate sections +on those. \fBnano\fP reads one command per line. +.PP Options in \fInanorc\fP files take precedence over nano's defaults, and -command line options override \fInanorc\fP settings. Also, options are -unset by default, except for those that take arguments. - -Quotes inside string parameters don't have to be escaped with +command-line options override \fInanorc\fP settings. Also, options that +do not take an argument are unset by default. So using the \fBunset\fR +command is only needed when wanting to override a setting of the system's +\fInanorc\fR file in your own \fB~/.nanorc\fR. Options that take an +argument cannot be unset. +.PP +Below, the \fIstring\fR parameters need to be enclosed in double quotes. +Quotes inside these string parameters don't have to be escaped with backslashes. The last double quote in the string will be treated as its -end. For example, for the \fBbrackets\fP option, "\fI"')>]}\fP" will -match \fI"\fP, \fI'\fP, \fI)\fP, \fI>\fP, \fI]\fP, and \fI}\fP. - +end. For example, for the \fBbrackets\fP option, "\fB"')>]}\fP" will +match \fB"\fP, \fB'\fP, \fB)\fP, \fB>\fP, \fB]\fP, and \fB}\fP. +.PP The supported commands and arguments are: .TP 3 -.B set/unset allow_insecure_backup +.B set allow_insecure_backup When backing up files, allow the backup to succeed even if its permissions -can't be (re)set due to special OS considerations. You should +can't be (re)set due to special OS considerations. You should NOT enable this option unless you are sure you need it. .TP -.B set/unset autoindent +.B set autoindent Use auto-indentation. .TP -.B set/unset backup -Create backup files in \fIfilename~\fP. +.B set backup +Create backup files by adding a tilde (\fB~\fP) to each file's name. .TP .B set backupdir "\fIdirectory\fP" -Set the directory where \fBnano\fP puts unique backup files if file +Set the directory where \fBnano\fP puts unique backup files, if file backups are enabled. .TP -.B set/unset backwards +.B set backwards Do backwards searches by default. .TP -.B set/unset boldtext -Use bold text instead of reverse video text. +.B set boldtext +Use bold instead of reverse video for the titlebar, statusbar, key combos, +and selected text. This can be overridden for the first three by setting +the options \fBtitlecolor\fP, \fBstatuscolor\fP, and \fBkeycolor\fP. .TP .B set brackets "\fIstring\fP" Set the characters treated as closing brackets when justifying -paragraphs. They cannot contain blank characters. Only closing -punctuation, optionally followed by closing brackets, can end sentences. -The default value is "\fI"')>]}\fP". +paragraphs. This may not include blank characters. Only closing +punctuation (see \fBpunct\fP), optionally followed by the specified +closing brackets, can end sentences. The default value is "\fB"')>]}\fP". .TP -.B set/unset casesensitive -Do case sensitive searches by default. +.B set casesensitive +Do case-sensitive searches by default. .TP -.B set/unset const +.B set const Constantly display the cursor position in the status bar. .TP -.B set/unset cut -Use cut to end of line by default. +.B set cut +Use cut-to-end-of-line by default, instead of cutting the whole line. +.TP +.B set fill \fInumber\fR +Hard-wrap lines at column number \fInumber\fR. If \fInumber\fR is 0 or less, +the maximum line length will be the screen width less \fInumber\fP columns. +The default value is \fB\-8\fR. .TP -.B set fill \fIn\fP -Wrap lines at column number \fIn\fP. If \fIn\fP is 0 or less, the -maximum line length will be the screen width less \fIn\fP columns. The -default value is \-8. +.B set functioncolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the function descriptions +in the two help lines at the bottom of the screen. +See \fBset titlecolor\fR for more details. .TP -.B set/unset historylog -Enable \fI~/.nano_history\fP for saving and reading search/replace -strings. +.B set historylog +Enable the use of \fB~/.nano/search_history\fP for saving and reading +search/replace strings. +.TP +.B set keycolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the shortcut key combos +in the two help lines at the bottom of the screen. +See \fBset titlecolor\fR for more details. +.TP +.B set locking +Enable vim-style lock-files for when editing files. .TP .B set matchbrackets "\fIstring\fP" Set the opening and closing brackets that can be found by bracket -searches. They cannot contain blank characters. The former set must -come before the latter set, and both must be in the same order. The -default value is "\fI(<[{)>]}\fP". +searches. This may not include blank characters. The opening set must +come before the closing set, and the two sets must be in the same order. +The default value is "\fB(<[{)>]}\fP". .TP -.B set/unset morespace +.B set morespace Use the blank line below the titlebar as extra editing space. .TP -.B set/unset mouse +.B set mouse Enable mouse support, if available for your system. When enabled, mouse clicks can be used to place the cursor, set the mark (with a double click), and execute shortcuts. The mouse will work in the X Window -System, and on the console when gpm is running. +System, and on the console when gpm is running. Text can still be +selected through dragging by holding down the Shift key. .TP -.B set/unset multibuffer +.B set multibuffer Allow inserting files into their own buffers. .TP -.B set/unset noconvert +.B set noconvert Don't convert files from DOS/Mac format. .TP -.B set/unset nofollow +.B set nofollow Don't follow symlinks when writing files. .TP -.B set/unset nohelp -Don't display the help lists at the bottom of the screen. +.B set nohelp +Don't display the two help lines at the bottom of the screen. .TP -.B set/unset nonewlines -Don't add newlines to the ends of files. +.B set nonewlines +Don't automatically add a newline to the ends of files. .TP -.B set/unset nowrap -Don't wrap text at all. +.B set nowrap +Don't hard-wrap text at all. .TP .B set operatingdir "\fIdirectory\fP" \fBnano\fP will only read and write files inside \fIdirectory\fP and its subdirectories. Also, the current directory is changed to here, so -files are inserted from this diractory. By default, the operating +files are inserted from this directory. By default, the operating directory feature is turned off. .TP -.B set/unset preserve +.B set poslog +Save the cursor position of files between editing sessions. +.TP +.B set preserve Preserve the XON and XOFF keys (^Q and ^S). .TP .B set punct "\fIstring\fP" Set the characters treated as closing punctuation when justifying -paragraphs. They cannot contain blank characters. Only closing -punctuation, optionally followed by closing brackets, can end sentences. -The default value is "\fI!.?\fP". +paragraphs. This may not include blank characters. Only the +specfified closing punctuation, optionally followed by closing brackets +(see \fBbrackets\fP), can end sentences. The default value is "\fB!.?\fP". .TP -.B set/unset quiet -\fBnano\fP will not report errors in the \fInanorc\fP file and ask them -to be acknowledged by pressing enter at startup. If this is used it -should be placed at the top of the file to be fully effective. -.TP -.B set/unset quickblank +.B set quickblank Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25. .TP +.B set quiet +\fBnano\fP will not report errors in the \fInanorc\fP file nor ask them +to be acknowledged by pressing Enter at startup. If this is used, it +should be placed at the top of the file to be fully effective. +.TP .B set quotestr "\fIstring\fP" The email-quote string, used to justify email-quoted paragraphs. This is an extended regular expression if your system supports them, otherwise a literal string. The default value is -"\fI^([\ \\t]*[#:>\\|}])+\fP" if you have extended regular expression -support, or "\fI>\ \fP" otherwise. Note that '\\t' stands for a literal +"\fB^([\ \\t]*[#:>\\|}])+\fP" if you have extended regular expression +support, and "\fB>\ \fP" otherwise. Note that '\\t' stands for a literal Tab character. .TP -.B set/unset rebinddelete +.B set rebinddelete Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. .TP -.B set/unset rebindkeypad +.B set rebindkeypad Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. .TP -.B set/unset regexp +.B set regexp Do extended regular expression searches by default. .TP -.B set/unset smarthome +.B set smarthome Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line. .TP -.B set/unset smooth +.B set smooth Use smooth scrolling by default. .TP -.B set/unset softwrap -Enable soft line wrapping for easier viewing of very long lones. +.B set softwrap +Enable soft line wrapping for easier viewing of very long lines. .TP .B set speller "\fIspellprog\fP" Use spelling checker \fIspellprog\fP instead of the built-in one, which calls \fIspell\fP. .TP -.B set/unset suspend +.B set statuscolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the statusbar. +See \fBset titlecolor\fR for more details. +.TP +.B set suspend Allow \fBnano\fP to be suspended. .TP -.B set tabsize \fIn\fP -Use a tab size of \fIn\fP columns. The value of \fIn\fP must be greater -than 0. The default value is 8. +.B set tabsize \fInumber\fR +Use a tab size of \fInumber\fR columns. The value of \fInumber\fP must be +greater than 0. The default value is \fB8\fR. .TP -.B set/unset tabstospaces +.B set tabstospaces Convert typed tabs to spaces. .TP -.B set/unset tempfile +.B set tempfile Save automatically on exit, don't prompt. .TP -.B set/unset undo -Enable experimental generic-purpose undo code. +.B set titlecolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the titlebar. +Valid color names for foreground and background are: +.BR white , \ black , \ red , \ blue , \ green , \ yellow , \ magenta ", and " cyan . +And either "\fIfgcolor\fR" or ",\fIbgcolor\fR" may be left out. .TP -.B set/unset view +.B set view Disallow file modification. .TP -.B set/unset softwrap -Enable soft line wrapping for easier viewing of very long lones. -.TP .B set whitespace "\fIstring\fP" -Set the two characters used to display the first characters of tabs and +Set the two characters used to indicate the presence of tabs and spaces. They must be single-column characters. .TP -.B set/unset wordbounds +.B set wordbounds Detect word boundaries more accurately by treating punctuation characters as parts of words. -.TP -.B syntax "\fIstr\fP" ["\fIfileregex\fP" ... ] + +.SH SYNTAX HIGHLIGHTING +Coloring the different syntactic elements of a file +is done via regular expressions (see the \fBcolor\fR command below). +This is inherently imperfect, because regular expressions are not +powerful enough to fully parse a file. Nevertheless, regular +expressions can do a lot and are easy to make, so they are a +good fit for a small editor like \fBnano\fR. +.sp +A separate syntax can be defined for each kind of file +via the following commands: +.TP +.BR syntax " ""\fIstr\fR"" [""\fIfileregex\fR"" ...]" Defines a syntax named \fIstr\fP which can be activated via the -\-Y/\-\-syntax command line option, or will be automatically activated if +.BR \-Y / \-\-syntax +command-line option, or will be automatically activated if the current filename matches the extended regular expression \fIfileregex\fP. All following \fBcolor\fP and \fBicolor\fP statements -will apply to \fIsyntax\fP until a new syntax is defined. +will apply to this \fIstr\fP syntax until a new syntax is defined. -The \fInone\fP syntax is reserved; specifying it on the command line is -the same as not having a syntax at all. The \fIdefault\fP syntax is +The \fBnone\fP syntax is reserved; specifying it on the command line is +the same as not having a syntax at all. The \fBdefault\fP syntax is special: it takes no \fIfileregex\fP, and applies to files that don't match any other syntax's \fIfileregex\fP. .TP -.B color \fIfgcolor\fP,\fIbgcolor\fP "\fIregex\fP" ... +.BI linter " program " \fR[ "arg " \fR...] +For the currently defined syntax, use the given \fIprogram\fR +to invoke the linter (this overrides the speller function when +defined). +.TP +.BI formatter " program " \fR[ "arg " \fR...] +For the currently defined syntax, use the given \fIprogram\fR +to automatically reformat text. Useful in certain programming +languages (e.g. go). +.TP +.BR header " \fIregex\fR " ... +For the currently defined syntax, add one or more regexes which will +be compared against the very first line of the file to be edited, +to determine whether this syntax should be used for that file. +.TP +.BR magic " \fIregex\fR " ... +For the currently defined syntax, add one or more regexes which +will be compared against the result of querying the \fBmagic\fP +database about the file to be edited, to determine whether this +syntax should be used for that file. This +functionality only works when \fBlibmagic\fP is installed on the +system and will be silently ignored otherwise. +.TP +.B color \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ... For the currently defined syntax, display all expressions matching the extended regular expression \fIregex\fP with foreground color \fIfgcolor\fP and background color \fIbgcolor\fP, at least one of which -must be specified. Legal colors for foreground and background color +must be specified. Valid colors for foreground and background are: white, black, red, blue, green, yellow, magenta, and cyan. You may -use the prefix "bright" to force a stronger color highlight for the +use the prefix "bright" to get a stronger color highlight for the foreground. If your terminal supports transparency, not specifying a \fIbgcolor\fP tells \fBnano\fP to attempt to use a transparent background. .TP -.B icolor \fIfgcolor\fP,\fIbgcolor\fP "\fIregex\fP" ... +.B icolor \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ... Same as above, except that the expression matching is case insensitive. .TP -.B color \fIfgcolor\fP,\fIbgcolor\fP start="\fIsr\fP" end="\fIer\fP" +.BR color " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIsr\fR"" " end= """\fIer\fR"" Display expressions which start with the extended regular expression \fIsr\fP and end with the extended regular expression \fIer\fP with foreground color \fIfgcolor\fP and background color \fIbgcolor\fP, @@ -262,244 +318,322 @@ highlighting to span multiple lines. Note that all subsequent instances of \fIsr\fP after an initial \fIsr\fP is found will be highlighted until the first instance of \fIer\fP. .TP -.B icolor \fIfgcolor\fP,\fIbgcolor\fP start="\fIsr\fP" end="\fIer\fP" +.BR icolor " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIsr\fR"" " end= """\fIer\fR"" Same as above, except that the expression matching is case insensitive. .TP -.B include "\fIsyntaxfile\fP" +.BR include " ""\fIsyntaxfile\fR""" Read in self-contained color syntaxes from \fIsyntaxfile\fP. Note that -\fIsyntaxfile\fP can only contain \fBsyntax\fP, \fBcolor\fP, and -\fBicolor\fP commands. -.SH KEY BINDINGS +\fIsyntaxfile\fP can only contain the above commands, from \fBsyntax\fP +to \fBicolor\fP. +.TP +.BI extendsyntax " str directive " \fR[ "arg " \fR...] +Extend the syntax previously defined as \fIstr\fP to include +new information. This allows you to add a new \fIcolor\fP, \fIicolor\fP, +\fImagic\fP, \fIheader\fP, or \fIlinter\fP directive to an already +defined syntax -- useful when you want to add to definitions from the +system-installed syntax definitions (which are normally not writable). + +.SH REBINDING KEYS Key bindings may be reassigned via the following commands: .TP -.B bind \fIkey\fP \fIfunction\fP \fImenu\fP +.BI bind " key function menu" Rebinds the key \fIkey\fP to a new function named \fIfunction\fP in the -context of menu \fImenu\fP. The format of \fIkey\fP should be one of: +context of menu \fImenu\fP (or in all menus where the function exists +by using \fBall\fP). .TP -.B ^ +.BI unbind " key menu" +Unbinds the key \fIkey\fP from the menu named \fImenu\fP (or from all +menus where it exists by using \fBall\fP). + +.TP +The format of \fIkey\fP should be one of: +.RS 3 +.TP 3 +.B ^ followed by an alpha character or the word "Space". Example: ^C .TP -.B M- +.B M- followed by a printable character or the word "Space". Example: M-C .TP -.B F +.B F followed by a numeric value from 1 to 16. Example: F10 +.RE + .TP -Valid function names to be bound include: -.TP 3 +Valid \fIfunction\fP names to be bound include: +.RS 3 +.TP 2 .B help -Invoke the help menu. +Invokes the help viewer. .TP .B cancel -Cancel the current command. +Cancels the current command. .TP .B exit -Exit from the program. +Exits from the program (or from the help viewer or the file browser). .TP .B writeout -Write the current buffer to disk. -.TP -.B justify -Justify the current text. +Writes the current buffer to disk. .TP .B insert -Insert a file into the current buffer (or into a new buffer when multibuffer +Inserts a file into the current buffer (or into a new buffer when multibuffer is enabled). .TP .B whereis -Search for text in the current buffer. +Searches for text in the current buffer -- or for filenames matching +a string in the current list in the file browser. .TP .B searchagain -Repeat the last search command. +Repeats the last search command. .TP -.B up -Move up in the editor or browser. -.TP -.B down -Move down in the editor or browser. -.TP -.B left -Move left in the editor or browser. -.TP -.B right -Move right in the editor or browser. +.B replace +Interactively replaces text within the current buffer. .TP .B cut -Cut the current line of text and store it. +Cuts and stores the current line (or the marked region). +.TP +.B copytext +Copies the current line (or the marked region) without deleting it. .TP .B uncut -Copy the currently stored text into the current buffer position. +Copies the currently stored text into the current buffer at the +current cursor position. .TP -.B curpos -Show the current line, column, word positions in the file. +.B mark +Sets the mark at the current position, to start selecting text. .TP -.B firstline -Move to the first line of the file. +.B cutrestoffile +Cuts all text from the cursor position till the end of the buffer. .TP -.B lastline -Move to the last line of the file. +.B curpos +Shows the current cursor position: the line, column, and character positions. .TP -.B gotoline -Move to a specific line (and column if specified). +.B wordcount +Counts the number of words, lines and characters in the current buffer. .TP -.B replace -Interactively replace text within the current buffer. +.B speller +Invokes a spell-checking program (or a linting program, if the current +syntax highlighting defines one). .TP -.B mark -Begin selecting text for cutting or pasting at the current position. +.B justify +Justifies the current paragraph. .TP -.B copytext -Copy the currently marked text without deleting it. +.B fulljustify +Justifies the entire current buffer. .TP .B indent -Indent the currently marked text (shift to the right). +Indents (shifts to the right) the currently marked text. .TP .B unindent -Un-indent the currently marked text (shift to the left). +Unindents (shifts to the left) the currently marked text. +.TP +.B left +Goes left one position (in the editor or browser). +.TP +.B right +Goes right one position (in the editor or browser). +.TP +.B up +Goes one line up (in the editor or browser). +.TP +.B down +Goes one line down (in the editor or browser). +.TP +.B scrollup +Scrolls up one line of text from the current position. +.TP +.B scrolldown +Scrolls down one line of text from the current position. .TP .B nextword -Move the cursor to the beginning of the next word. +Moves the cursor to the beginning of the next word. .TP .B prevword -Move the cursor to the beginning of the previous word. +Moves the cursor to the beginning of the previous word. .TP .B home -Move the cursor to the beginning of the current line. +Moves the cursor to the beginning of the current line. .TP .B end -Move the cursor to the end of the current line. +Moves the cursor to the end of the current line. .TP .B beginpara -Move the cursor to the beginning of the current paragraph. +Moves the cursor to the beginning of the current paragraph. .TP .B endpara -Move the cursor to the end of the current paragraph. +Moves the cursor to the end of the current paragraph. .TP -.B findbracket -Move the cursor to the matching bracket (brace, parenthesis, etc.) of the one -under the cursor. +.B prevpage +Goes up one screenful. .TP -.B scrollup -Scroll up one line of text from the current position. +.B nextpage +Goes down one screenful. .TP -.B scrolldown -Scroll down one line of text from the current position. +.B firstline +Goes to the first line of the file. +.TP +.B lastline +Goes to the last line of the file. +.TP +.B gotoline +Goes to a specific line (and column if specified). +.TP +.B gototext +Switches from targeting a line number to searching for text. +.TP +.B findbracket +Moves the cursor to the bracket (brace, parenthesis, etc.) that matches +(pairs) with the one under the cursor. .TP .B prevbuf -Switch to editing/viewing the previous buffer when using multibuffer mode. +Switches to editing/viewing the previous buffer when using multibuffer mode. .TP .B nextbuf -Switch to editing/viewing the next buffer when using multibuffer mode. +Switches to editing/viewing the next buffer when using multibuffer mode. .TP .B verbatim -Insert the next character verbatim into the file. +Inserts the next character verbatim into the file. .TP .B tab -Insert a tab at the current cursor location. +Inserts a tab at the current cursor location. .TP .B enter -Insert a new line below the current one. +Inserts a new line below the current one. .TP .B delete -Delete the character under the cursor. +Deletes the character under the cursor. .TP -.B fulljustify -Justify the entire current file. -.TP -.B wordcount -Count the number of words in the current buffer. -.TP -.B refresh -Refresh the screen. +.B backspace +Deletes the character before the cursor. .TP .B undo -Undo the text action peformed (add text, delete text, etc). +Undoes the last performed text action (add text, delete text, etc). .TP .B redo -Redo the last undone action (i.e., undo an undo). +Redoes the last undone action (i.e., it undoes an undo). +.TP +.B refresh +Refreshes the screen. .TP .B suspend -Suspend the editor (if the suspend function is enabled, see the +Suspends the editor (if the suspending function is enabled, see the "suspendenable" entry below). .TP .B casesens -Toggle case sensitivity in searching (search/replace menus only). +Toggles case sensitivity in searching (search/replace menus only). .TP .B regexp -Toggle whether searching/replacing is based on literal strings or regular expressions. +Toggles whether searching/replacing is based on literal strings or regular expressions. +.TP +.B backwards +Toggles whether searching/replacing goes forward or backward. .TP .B prevhistory -Show the previous history entry in the prompt menus (e.g. search). +Shows the previous history entry in the prompt menus (e.g. search). .TP .B nexthistory -Show the next history entry in the prompt menus (e.g. search). +Shows the next history entry in the prompt menus (e.g. search). .TP -.B dontreplace -Switch back to searching instead of replacing. +.B flipreplace +Toggles between searching for something and replacing something. .TP -.B gototext -Search for files matching a string in the file browser (reading or writing files). +.B flipexecute +Toggles between inserting a file and executing a command. +.TP +.B flipnewbuffer +Toggles between inserting into the current buffer and into a new +empty buffer. +.TP +.B tofiles +Starts the file browser, allowing to select a file from a list. +.TP +.B gotodir +Goes to a directory to be specified, allowing to browse anywhere +in the filesystem. .TP .B dosformat -When writing a file, switch to writing a DOS format (CR/LF). +When writing a file, switches to writing a DOS format (CR/LF). .TP .B macformat -When writing a file, switch to writing a Mac format. +When writing a file, switches to writing a Mac format. .TP .B append -When writing a file, append to the end instead of overwriting. +When writing a file, appends to the end instead of overwriting. .TP .B prepend -When writing a file, 'prepend' (write at the beginning) instead of overwriting. +When writing a file, 'prepends' (writes at the beginning) instead of overwriting. .TP .B backup -When writing a file, create a backup of the current file. +When writing a file, creates a backup of the current file. .TP .B firstfile -Move to the first file when using the file browser (reading or writing files). +Goes to the first file when using the file browser (reading or writing files). .TP .B lastfile -Move to the last file when using the file browser (reading or writing files). +Goes to the last file when using the file browser (reading or writing files). .TP .B nohelp -Toggle showing/hiding the two-line list of key bindings at the bottom of the screen. +Toggles the presence of the two-line list of key bindings at the bottom of the screen. .TP .B constupdate -Constantly display the current line, column, word positions. +Toggles the constant display of the current line, column, and character positions. .TP .B morespace -Toggle showing/hiding the blank line which 'separates' the 'title' from the file text. +Toggles the presence of the blank line which 'separates' the titlebar from the file text. .TP .B smoothscroll -Toggle smooth scrolling when moving via the arrow keys. +Toggles smooth scrolling (when moving around with the arrow keys). +.TP +.B softwrap +Toggles the displaying of overlong lines on multiple screen lines. .TP .B whitespacedisplay -Toggle whether whitespace is shown. +Toggles the showing of whitespace. +.TP +.B nosyntax +Toggles syntax highlighting. .TP .B smarthome -Toggle whether the smart home key function is enabled. +Toggles the smartness of the Home key. .TP .B autoindent -Toggle whether new lines will contain the same amount of whitespace as the line above. +Toggles whether new lines will contain the same amount of whitespace as the preceding line. .TP .B cuttoend -Toggle whether cutting text will cut the whole line or just from the current cursor +Toggles whether cutting text will cut the whole line or just from the current cursor position to the end of the line. .TP .B nowrap -Toggle whether long lines will be wrapped to the next line. +Toggles whether long lines will be hard-wrapped to the next line. .TP -.B suspendenable -Toggle whether the suspend sequence (normally ^Z) will suspend the editor window. +.B tabstospaces +Toggles whether typed tabs will be converted to spaces. +.TP +.B backupfile +Toggles whether a backup will be made of the file to be edited. +.TP +.B multibuffer +Toggles the use of multiple file buffers (if support for them has been compiled in). .TP +.B mouse +Toggles mouse support. +.TP +.B noconvert +Toggles automatic conversion of files from DOS/Mac format. +.TP +.B suspendenable +Toggles whether the suspend sequence (normally ^Z) will suspend the editor window. +.RE -Valid menu sections are: .TP +Valid \fImenu\fP sections are: +.RS 3 +.TP 2 .B main -The main editor window where text is entered. +The main editor window where text is entered and edited. .TP .B search The search menu (AKA whereis). @@ -520,14 +654,17 @@ The 'write file' menu. The 'insert file' menu. .TP .B extcmd -The menu for inserting output from an external comman, reached from the insert menu. +The menu for inserting output from an external command, reached from the insert menu. .TP .B help -The help menu. +The help-viewer menu. .TP .B spell The interactive spell checker Yes/no menu. .TP +.B linter +The linter menu. +.TP .B browser The file browser for inserting or writing a file. .TP @@ -535,26 +672,22 @@ The file browser for inserting or writing a file. The 'search for a file' menu in the file browser. .TP .B gotodir -The 'go to directory' menu. +The 'go to directory' menu in the file browser. .TP .B all -A special name meaning: apply to all menus where this function exists. +A special name that encompasses all menus. +For \fBbind\fR it means all menus where the specified \fIfunction\fR exists; +for \fBunbind\fR it means all menus where the specified \fIkey\fR exists. +.RE -.TP -.B unbind \fIkey\fP \fImenu\fP -Unbind the key \fIkey\fP from the menu named \fImenu\fP or from all -menus by using \fIall\fP. Same key syntax as for binding. -Rebinds the key \fIkey\fP to a new function named \fIfunction\fP in the -context of menu \fImenu\fP. The format of \fIkey\fP should be one of: .SH FILES .TP -.I SYSCONFDIR/nanorc -System-wide configuration file +.B /etc/nanorc +System-wide configuration file. .TP -.I ~/.nanorc -Per-user configuration file +.B ~/.nanorc +Per-user configuration file. .SH SEE ALSO -.PD 0 .TP \fBnano\fP(1) .PP diff --git a/doc/man/nanorc.5.html b/doc/man/nanorc.5.html index 94e2b6d..9f1ea5d 100644 --- a/doc/man/nanorc.5.html +++ b/doc/man/nanorc.5.html @@ -1,5 +1,5 @@ -<!-- Creator : groff version 1.20.1 --> -<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Sun Mar 22 23:46:10 2015 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -23,7 +23,8 @@ <a href="#NAME">NAME</a><br> <a href="#DESCRIPTION">DESCRIPTION</a><br> <a href="#OPTIONS">OPTIONS</a><br> -<a href="#KEY BINDINGS">KEY BINDINGS</a><br> +<a href="#SYNTAX HIGHLIGHTING">SYNTAX HIGHLIGHTING</a><br> +<a href="#REBINDING KEYS">REBINDING KEYS</a><br> <a href="#FILES">FILES</a><br> <a href="#SEE ALSO">SEE ALSO</a><br> <a href="#AUTHOR">AUTHOR</a><br> @@ -44,24 +45,13 @@ GNU nano’s rcfile</p> </h2> -<p style="margin-left:11%; margin-top: 1em">This manual -page briefly documents GNU <b>nano</b>’s rcfile.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>nano</b> is -a small, free and friendly editor which aims to replace -Pico, the default editor included in the non-free Pine -package. Rather than just copying Pico’s look and -feel, <b>nano</b> also implements some missing (or disabled -by default) features in Pico, such as "search and -replace" and "go to line and column -number".</p> - <p style="margin-left:11%; margin-top: 1em">The <i>nanorc</i> file contains the default settings for -<b>nano</b>. It should not be in DOS or Mac format. During -startup, <b>nano</b> will first read its system-wide -settings from <i>SYSCONFDIR/nanorc</i>, and then -user-specific settings from <i>~/.nanorc</i>.</p> +<b>nano</b>, a small and friendly editor. The file should be +in Unix format, not in DOS or Mac format. During startup, +<b>nano</b> will first read the system-wide settings, from +<b>/etc/nanorc</b> (the exact path might be different), and +then the user-specific settings, from <b>~/.nanorc</b>.</p> <h2>OPTIONS <a name="OPTIONS"></a> @@ -71,150 +61,182 @@ user-specific settings from <i>~/.nanorc</i>.</p> <p style="margin-left:11%; margin-top: 1em">The configuration file accepts a series of <b>set</b> and <b>unset</b> commands, which can be used to configure nano -on startup without using the command line options. -Additionally, the <b>syntax</b>, <b>color</b>, and -<b>icolor</b> keywords are used to define syntax -highlighting rules for different text patterns. <b>nano</b> -will read one command per line.</p> +on startup without using command-line options. Additionally, +there are some commands to define syntax highlighting and to +rebind keys -- see the two separate sections on those. +<b>nano</b> reads one command per line.</p> <p style="margin-left:11%; margin-top: 1em">Options in <i>nanorc</i> files take precedence over nano’s -defaults, and command line options override <i>nanorc</i> -settings. Also, options are unset by default, except for -those that take arguments.</p> - -<p style="margin-left:11%; margin-top: 1em">Quotes inside -string parameters don’t have to be escaped with -backslashes. The last double quote in the string will be -treated as its end. For example, for the <b>brackets</b> -option, "<i>"’)>]}</i>" will match -<i>"</i>, <i>’</i>, <i>)</i>, <i>></i>, -<i>]</i>, and <i>}</i>.</p> +defaults, and command-line options override <i>nanorc</i> +settings. Also, options that do not take an argument are +unset by default. So using the <b>unset</b> command is only +needed when wanting to override a setting of the +system’s <i>nanorc</i> file in your own +<b>~/.nanorc</b>. Options that take an argument cannot be +unset.</p> + +<p style="margin-left:11%; margin-top: 1em">Below, the +<i>string</i> parameters need to be enclosed in double +quotes. Quotes inside these string parameters don’t +have to be escaped with backslashes. The last double quote +in the string will be treated as its end. For example, for +the <b>brackets</b> option, +"<b>"’)>]}</b>" will match +<b>"</b>, <b>’</b>, <b>)</b>, <b>></b>, +<b>]</b>, and <b>}</b>.</p> <p style="margin-left:11%; margin-top: 1em">The supported commands and arguments are: <b><br> -set/unset allow_insecure_backup</b></p> +set allow_insecure_backup</b></p> <p style="margin-left:15%;">When backing up files, allow the backup to succeed even if its permissions can’t be (re)set due to special OS considerations. You should NOT enable this option unless you are sure you need it.</p> -<p style="margin-left:11%;"><b>set/unset autoindent</b></p> +<p style="margin-left:11%;"><b>set autoindent</b></p> <p style="margin-left:15%;">Use auto-indentation.</p> -<p style="margin-left:11%;"><b>set/unset backup</b></p> +<p style="margin-left:11%;"><b>set backup</b></p> -<p style="margin-left:15%;">Create backup files in -<i>filename~</i>.</p> +<p style="margin-left:15%;">Create backup files by adding a +tilde (<b>~</b>) to each file’s name.</p> <p style="margin-left:11%;"><b>set backupdir</b> <i>directory</i></p> <p style="margin-left:15%;">Set the directory where -<b>nano</b> puts unique backup files if file backups are +<b>nano</b> puts unique backup files, if file backups are enabled.</p> -<p style="margin-left:11%;"><b>set/unset backwards</b></p> +<p style="margin-left:11%;"><b>set backwards</b></p> <p style="margin-left:15%;">Do backwards searches by default.</p> -<p style="margin-left:11%;"><b>set/unset boldtext</b></p> +<p style="margin-left:11%;"><b>set boldtext</b></p> -<p style="margin-left:15%;">Use bold text instead of -reverse video text.</p> +<p style="margin-left:15%;">Use bold instead of reverse +video for the titlebar, statusbar, key combos, and selected +text. This can be overridden for the first three by setting +the options <b>titlecolor</b>, <b>statuscolor</b>, and +<b>keycolor</b>.</p> <p style="margin-left:11%;"><b>set brackets</b> <i>string</i></p> <p style="margin-left:15%;">Set the characters treated as -closing brackets when justifying paragraphs. They cannot -contain blank characters. Only closing punctuation, -optionally followed by closing brackets, can end sentences. -The default value is -"<i>"’)>]}</i>".</p> +closing brackets when justifying paragraphs. This may not +include blank characters. Only closing punctuation (see +<b>punct</b>), optionally followed by the specified closing +brackets, can end sentences. The default value is +"<b>"’)>]}</b>".</p> -<p style="margin-left:11%;"><b>set/unset -casesensitive</b></p> +<p style="margin-left:11%;"><b>set casesensitive</b></p> -<p style="margin-left:15%;">Do case sensitive searches by +<p style="margin-left:15%;">Do case-sensitive searches by default.</p> -<p style="margin-left:11%;"><b>set/unset const</b></p> +<p style="margin-left:11%;"><b>set const</b></p> <p style="margin-left:15%;">Constantly display the cursor position in the status bar.</p> -<p style="margin-left:11%;"><b>set/unset cut</b></p> +<p style="margin-left:11%;"><b>set cut</b></p> -<p style="margin-left:15%;">Use cut to end of line by -default.</p> +<p style="margin-left:15%;">Use cut-to-end-of-line by +default, instead of cutting the whole line.</p> + +<p style="margin-left:11%;"><b>set fill</b> +<i>number</i></p> + +<p style="margin-left:15%;">Hard-wrap lines at column +number <i>number</i>. If <i>number</i> is 0 or less, the +maximum line length will be the screen width less +<i>number</i> columns. The default value is +<b>−8</b>.</p> + +<p style="margin-left:11%;"><b>set functioncolor</b> +<i>fgcolor</i>,<i>bgcolor</i></p> + +<p style="margin-left:15%;">Specify the color combination +to use for the function descriptions in the two help lines +at the bottom of the screen. See <b>set titlecolor</b> for +more details.</p> + +<p style="margin-left:11%;"><b>set historylog</b></p> -<p style="margin-left:11%;"><b>set fill</b> <i>n</i></p> +<p style="margin-left:15%;">Enable the use of +<b>~/.nano/search_history</b> for saving and reading +search/replace strings.</p> -<p style="margin-left:15%;">Wrap lines at column number -<i>n</i>. If <i>n</i> is 0 or less, the maximum line length -will be the screen width less <i>n</i> columns. The default -value is −8.</p> +<p style="margin-left:11%;"><b>set keycolor</b> +<i>fgcolor</i>,<i>bgcolor</i></p> -<p style="margin-left:11%;"><b>set/unset historylog</b></p> +<p style="margin-left:15%;">Specify the color combination +to use for the shortcut key combos in the two help lines at +the bottom of the screen. See <b>set titlecolor</b> for more +details.</p> -<p style="margin-left:15%;">Enable <i>~/.nano_history</i> -for saving and reading search/replace strings.</p> +<p style="margin-left:11%;"><b>set locking</b></p> + +<p style="margin-left:15%;">Enable vim-style lock-files for +when editing files.</p> <p style="margin-left:11%;"><b>set matchbrackets</b> <i>string</i></p> <p style="margin-left:15%;">Set the opening and closing -brackets that can be found by bracket searches. They cannot -contain blank characters. The former set must come before -the latter set, and both must be in the same order. The -default value is "<i>(<[{)>]}</i>".</p> +brackets that can be found by bracket searches. This may not +include blank characters. The opening set must come before +the closing set, and the two sets must be in the same order. +The default value is "<b>(<[{)>]}</b>".</p> -<p style="margin-left:11%;"><b>set/unset morespace</b></p> +<p style="margin-left:11%;"><b>set morespace</b></p> <p style="margin-left:15%;">Use the blank line below the titlebar as extra editing space.</p> -<p style="margin-left:11%;"><b>set/unset mouse</b></p> +<p style="margin-left:11%;"><b>set mouse</b></p> <p style="margin-left:15%;">Enable mouse support, if available for your system. When enabled, mouse clicks can be used to place the cursor, set the mark (with a double click), and execute shortcuts. The mouse will work in the X -Window System, and on the console when gpm is running.</p> +Window System, and on the console when gpm is running. Text +can still be selected through dragging by holding down the +Shift key.</p> -<p style="margin-left:11%;"><b>set/unset -multibuffer</b></p> +<p style="margin-left:11%;"><b>set multibuffer</b></p> <p style="margin-left:15%;">Allow inserting files into their own buffers.</p> -<p style="margin-left:11%;"><b>set/unset noconvert</b></p> +<p style="margin-left:11%;"><b>set noconvert</b></p> <p style="margin-left:15%;">Don’t convert files from DOS/Mac format.</p> -<p style="margin-left:11%;"><b>set/unset nofollow</b></p> +<p style="margin-left:11%;"><b>set nofollow</b></p> <p style="margin-left:15%;">Don’t follow symlinks when writing files.</p> -<p style="margin-left:11%;"><b>set/unset nohelp</b></p> +<p style="margin-left:11%;"><b>set nohelp</b></p> -<p style="margin-left:15%;">Don’t display the help -lists at the bottom of the screen.</p> +<p style="margin-left:15%;">Don’t display the two +help lines at the bottom of the screen.</p> -<p style="margin-left:11%;"><b>set/unset nonewlines</b></p> +<p style="margin-left:11%;"><b>set nonewlines</b></p> -<p style="margin-left:15%;">Don’t add newlines to the -ends of files.</p> +<p style="margin-left:15%;">Don’t automatically add a +newline to the ends of files.</p> -<p style="margin-left:11%;"><b>set/unset nowrap</b></p> +<p style="margin-left:11%;"><b>set nowrap</b></p> -<p style="margin-left:15%;">Don’t wrap text at +<p style="margin-left:15%;">Don’t hard-wrap text at all.</p> <p style="margin-left:11%;"><b>set operatingdir</b> @@ -223,10 +245,15 @@ all.</p> <p style="margin-left:15%;"><b>nano</b> will only read and write files inside <i>directory</i> and its subdirectories. Also, the current directory is changed to here, so files are -inserted from this diractory. By default, the operating +inserted from this directory. By default, the operating directory feature is turned off.</p> -<p style="margin-left:11%;"><b>set/unset preserve</b></p> +<p style="margin-left:11%;"><b>set poslog</b></p> + +<p style="margin-left:15%;">Save the cursor position of +files between editing sessions.</p> + +<p style="margin-left:11%;"><b>set preserve</b></p> <p style="margin-left:15%;">Preserve the XON and XOFF keys (^Q and ^S).</p> @@ -235,25 +262,26 @@ directory feature is turned off.</p> <i>string</i></p> <p style="margin-left:15%;">Set the characters treated as -closing punctuation when justifying paragraphs. They cannot -contain blank characters. Only closing punctuation, -optionally followed by closing brackets, can end sentences. -The default value is "<i>!.?</i>".</p> - -<p style="margin-left:11%;"><b>set/unset quiet</b></p> - -<p style="margin-left:15%;"><b>nano</b> will not report -errors in the <i>nanorc</i> file and ask them to be -acknowledged by pressing enter at startup. If this is used -it should be placed at the top of the file to be fully -effective.</p> +closing punctuation when justifying paragraphs. This may not +include blank characters. Only the specfified closing +punctuation, optionally followed by closing brackets (see +<b>brackets</b>), can end sentences. The default value is +"<b>!.?</b>".</p> -<p style="margin-left:11%;"><b>set/unset quickblank</b></p> +<p style="margin-left:11%;"><b>set quickblank</b></p> <p style="margin-left:15%;">Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25.</p> +<p style="margin-left:11%;"><b>set quiet</b></p> + +<p style="margin-left:15%;"><b>nano</b> will not report +errors in the <i>nanorc</i> file nor ask them to be +acknowledged by pressing Enter at startup. If this is used, +it should be placed at the top of the file to be fully +effective.</p> + <p style="margin-left:11%;"><b>set quotestr</b> <i>string</i></p> @@ -261,33 +289,31 @@ of 25.</p> justify email-quoted paragraphs. This is an extended regular expression if your system supports them, otherwise a literal string. The default value is -"<i>^([ \t]*[#:>\|}])+</i>" if you have -extended regular expression support, or -"<i>> </i>" otherwise. Note that +"<b>^([ \t]*[#:>\|}])+</b>" if you have +extended regular expression support, and +"<b>> </b>" otherwise. Note that ’\t’ stands for a literal Tab character.</p> -<p style="margin-left:11%;"><b>set/unset -rebinddelete</b></p> +<p style="margin-left:11%;"><b>set rebinddelete</b></p> <p style="margin-left:15%;">Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system.</p> -<p style="margin-left:11%;"><b>set/unset -rebindkeypad</b></p> +<p style="margin-left:11%;"><b>set rebindkeypad</b></p> <p style="margin-left:15%;">Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don’t, as mouse support won’t work properly with this option enabled.</p> -<p style="margin-left:11%;"><b>set/unset regexp</b></p> +<p style="margin-left:11%;"><b>set regexp</b></p> <p style="margin-left:15%;">Do extended regular expression searches by default.</p> -<p style="margin-left:11%;"><b>set/unset smarthome</b></p> +<p style="margin-left:11%;"><b>set smarthome</b></p> <p style="margin-left:15%;">Make the Home key smarter. When Home is pressed anywhere but at the very beginning of @@ -296,15 +322,15 @@ that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line.</p> -<p style="margin-left:11%;"><b>set/unset smooth</b></p> +<p style="margin-left:11%;"><b>set smooth</b></p> <p style="margin-left:15%;">Use smooth scrolling by default.</p> -<p style="margin-left:11%;"><b>set/unset softwrap</b></p> +<p style="margin-left:11%;"><b>set softwrap</b></p> <p style="margin-left:15%;">Enable soft line wrapping for -easier viewing of very long lones.</p> +easier viewing of very long lines.</p> <p style="margin-left:11%;"><b>set speller</b> <i>spellprog</i></p> @@ -313,100 +339,161 @@ easier viewing of very long lones.</p> <i>spellprog</i> instead of the built-in one, which calls <i>spell</i>.</p> -<p style="margin-left:11%;"><b>set/unset suspend</b></p> +<p style="margin-left:11%;"><b>set statuscolor</b> +<i>fgcolor</i>,<i>bgcolor</i></p> + +<p style="margin-left:15%;">Specify the color combination +to use for the statusbar. See <b>set titlecolor</b> for more +details.</p> + +<p style="margin-left:11%;"><b>set suspend</b></p> <p style="margin-left:15%;">Allow <b>nano</b> to be suspended.</p> -<p style="margin-left:11%;"><b>set tabsize</b> <i>n</i></p> +<p style="margin-left:11%;"><b>set tabsize</b> +<i>number</i></p> -<p style="margin-left:15%;">Use a tab size of <i>n</i> -columns. The value of <i>n</i> must be greater than 0. The -default value is 8.</p> +<p style="margin-left:15%;">Use a tab size of <i>number</i> +columns. The value of <i>number</i> must be greater than 0. +The default value is <b>8</b>.</p> -<p style="margin-left:11%;"><b>set/unset -tabstospaces</b></p> +<p style="margin-left:11%;"><b>set tabstospaces</b></p> <p style="margin-left:15%;">Convert typed tabs to spaces.</p> -<p style="margin-left:11%;"><b>set/unset tempfile</b></p> +<p style="margin-left:11%;"><b>set tempfile</b></p> <p style="margin-left:15%;">Save automatically on exit, don’t prompt.</p> -<p style="margin-left:11%;"><b>set/unset undo</b></p> +<p style="margin-left:11%;"><b>set titlecolor</b> +<i>fgcolor</i>,<i>bgcolor</i></p> -<p style="margin-left:15%;">Enable experimental -generic-purpose undo code.</p> +<p style="margin-left:15%;">Specify the color combination +to use for the titlebar. Valid color names for foreground +and background are: +<b>white</b>, <b>black</b>, <b>red</b>, <b>blue</b>, <b>green</b>, <b>yellow</b>, <b>magenta</b>, +and <b>cyan</b>. And either "<i>fgcolor</i>" or +",<i>bgcolor</i>" may be left out.</p> -<p style="margin-left:11%;"><b>set/unset view</b></p> +<p style="margin-left:11%;"><b>set view</b></p> <p style="margin-left:15%;">Disallow file modification.</p> -<p style="margin-left:11%;"><b>set/unset softwrap</b></p> - -<p style="margin-left:15%;">Enable soft line wrapping for -easier viewing of very long lones.</p> - <p style="margin-left:11%;"><b>set whitespace</b> <i>string</i></p> <p style="margin-left:15%;">Set the two characters used to -display the first characters of tabs and spaces. They must -be single-column characters.</p> +indicate the presence of tabs and spaces. They must be +single-column characters.</p> -<p style="margin-left:11%;"><b>set/unset wordbounds</b></p> +<p style="margin-left:11%;"><b>set wordbounds</b></p> <p style="margin-left:15%;">Detect word boundaries more accurately by treating punctuation characters as parts of words.</p> -<p style="margin-left:11%;"><b>syntax</b> <i>str</i> -<b>["</b><i>fileregex</i><b>" ... ]</b></p> +<h2>SYNTAX HIGHLIGHTING +<a name="SYNTAX HIGHLIGHTING"></a> +</h2> -<p style="margin-left:15%;">Defines a syntax named -<i>str</i> which can be activated via the -−Y/−−syntax command line option, or will -be automatically activated if the current filename matches -the extended regular expression <i>fileregex</i>. All -following <b>color</b> and <b>icolor</b> statements will -apply to <i>syntax</i> until a new syntax is defined.</p> -<p style="margin-left:15%; margin-top: 1em">The <i>none</i> +<p style="margin-left:11%; margin-top: 1em">Coloring the +different syntactic elements of a file is done via regular +expressions (see the <b>color</b> command below). This is +inherently imperfect, because regular expressions are not +powerful enough to fully parse a file. Nevertheless, regular +expressions can do a lot and are easy to make, so they are a +good fit for a small editor like <b>nano</b>.</p> + +<p style="margin-left:11%; margin-top: 1em">A separate +syntax can be defined for each kind of file via the +following commands: <b><br> +syntax</b> "<i>str</i>" +["<i>fileregex</i>" ...]</p> + +<p style="margin-left:22%;">Defines a syntax named +<i>str</i> which can be activated via the +<b>−Y</b>/<b>−−syntax</b> command-line +option, or will be automatically activated if the current +filename matches the extended regular expression +<i>fileregex</i>. All following <b>color</b> and +<b>icolor</b> statements will apply to this <i>str</i> +syntax until a new syntax is defined.</p> + +<p style="margin-left:22%; margin-top: 1em">The <b>none</b> syntax is reserved; specifying it on the command line is the -same as not having a syntax at all. The <i>default</i> +same as not having a syntax at all. The <b>default</b> syntax is special: it takes no <i>fileregex</i>, and applies to files that don’t match any other syntax’s <i>fileregex</i>.</p> +<p style="margin-left:11%;"><b>linter</b> <i>program</i> +[<i>arg</i> ...]</p> + +<p style="margin-left:22%;">For the currently defined +syntax, use the given <i>program</i> to invoke the linter +(this overrides the speller function when defined).</p> + +<p style="margin-left:11%;"><b>formatter</b> <i>program</i> +[<i>arg</i> ...]</p> + +<p style="margin-left:22%;">For the currently defined +syntax, use the given <i>program</i> to automatically +reformat text. Useful in certain programming languages (e.g. +go).</p> + +<p style="margin-left:11%;"><b>header</b> <i>regex</i> +<b>...</b></p> + +<p style="margin-left:22%;">For the currently defined +syntax, add one or more regexes which will be compared +against the very first line of the file to be edited, to +determine whether this syntax should be used for that +file.</p> + +<p style="margin-left:11%;"><b>magic</b> <i>regex</i> +<b>...</b></p> + +<p style="margin-left:22%;">For the currently defined +syntax, add one or more regexes which will be compared +against the result of querying the <b>magic</b> database +about the file to be edited, to determine whether this +syntax should be used for that file. This functionality only +works when <b>libmagic</b> is installed on the system and +will be silently ignored otherwise.</p> + <p style="margin-left:11%;"><b>color</b> -<i>fgcolor</i><b>,</b><i>bgcolor regex</i> <b>...</b></p> +<i>fgcolor</i>,<i>bgcolor</i> "<i>regex</i>" +...</p> -<p style="margin-left:15%;">For the currently defined +<p style="margin-left:22%;">For the currently defined syntax, display all expressions matching the extended regular expression <i>regex</i> with foreground color <i>fgcolor</i> and background color <i>bgcolor</i>, at least -one of which must be specified. Legal colors for foreground -and background color are: white, black, red, blue, green, -yellow, magenta, and cyan. You may use the prefix -"bright" to force a stronger color highlight for -the foreground. If your terminal supports transparency, not -specifying a <i>bgcolor</i> tells <b>nano</b> to attempt to -use a transparent background.</p> +one of which must be specified. Valid colors for foreground +and background are: white, black, red, blue, green, yellow, +magenta, and cyan. You may use the prefix "bright" +to get a stronger color highlight for the foreground. If +your terminal supports transparency, not specifying a +<i>bgcolor</i> tells <b>nano</b> to attempt to use a +transparent background.</p> <p style="margin-left:11%;"><b>icolor</b> -<i>fgcolor</i><b>,</b><i>bgcolor regex</i> <b>...</b></p> +<i>fgcolor</i>,<i>bgcolor</i> "<i>regex</i>" +...</p> -<p style="margin-left:15%;">Same as above, except that the +<p style="margin-left:22%;">Same as above, except that the expression matching is case insensitive.</p> <p style="margin-left:11%;"><b>color</b> -<i>fgcolor</i><b>,</b><i>bgcolor</i> -<b>start="</b><i>sr</i><b>" -end="</b><i>er</i><b>"</b></p> +<i>fgcolor</i>,<i>bgcolor</i> +<b>start=</b>"<i>sr</i>" +<b>end=</b>"<i>er</i>"</p> -<p style="margin-left:15%;">Display expressions which start +<p style="margin-left:22%;">Display expressions which start with the extended regular expression <i>sr</i> and end with the extended regular expression <i>er</i> with foreground color <i>fgcolor</i> and background color <i>bgcolor</i>, at @@ -417,23 +504,34 @@ is found will be highlighted until the first instance of <i>er</i>.</p> <p style="margin-left:11%;"><b>icolor</b> -<i>fgcolor</i><b>,</b><i>bgcolor</i> -<b>start="</b><i>sr</i><b>" -end="</b><i>er</i><b>"</b></p> +<i>fgcolor</i>,<i>bgcolor</i> +<b>start=</b>"<i>sr</i>" +<b>end=</b>"<i>er</i>"</p> -<p style="margin-left:15%;">Same as above, except that the +<p style="margin-left:22%;">Same as above, except that the expression matching is case insensitive.</p> <p style="margin-left:11%;"><b>include</b> -<i>syntaxfile</i></p> +"<i>syntaxfile</i>"</p> -<p style="margin-left:15%;">Read in self-contained color +<p style="margin-left:22%;">Read in self-contained color syntaxes from <i>syntaxfile</i>. Note that <i>syntaxfile</i> -can only contain <b>syntax</b>, <b>color</b>, and -<b>icolor</b> commands.</p> - -<h2>KEY BINDINGS -<a name="KEY BINDINGS"></a> +can only contain the above commands, from <b>syntax</b> to +<b>icolor</b>.</p> + +<p style="margin-left:11%;"><b>extendsyntax</b> <i>str +directive</i> [<i>arg</i> ...]</p> + +<p style="margin-left:22%;">Extend the syntax previously +defined as <i>str</i> to include new information. This +allows you to add a new <i>color</i>, <i>icolor</i>, +<i>magic</i>, <i>header</i>, or <i>linter</i> directive to +an already defined syntax -- useful when you want to add to +definitions from the system-installed syntax definitions +(which are normally not writable).</p> + +<h2>REBINDING KEYS +<a name="REBINDING KEYS"></a> </h2> @@ -443,481 +541,568 @@ bind</b> <i>key function menu</i></p> <p style="margin-left:22%;">Rebinds the key <i>key</i> to a new function named <i>function</i> in the context of menu -<i>menu</i>. The format of <i>key</i> should be one of:</p> +<i>menu</i> (or in all menus where the function exists by +using <b>all</b>).</p> + +<p style="margin-left:11%;"><b>unbind</b> <i>key +menu</i></p> + +<p style="margin-left:22%;">Unbinds the key <i>key</i> from +the menu named <i>menu</i> (or from all menus where it +exists by using <b>all</b>).</p> + +<p style="margin-left:11%;">The format of <i>key</i> should +be one of:</p> <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> -<td width="11%"></td> +<td width="15%"></td> <td width="3%"> <p><b>^</b></p></td> -<td width="8%"></td> -<td width="78%"> +<td width="2%"></td> +<td width="80%"> <p>followed by an alpha character or the word "Space". Example: ^C</p></td></tr> <tr valign="top" align="left"> -<td width="11%"></td> +<td width="15%"></td> <td width="3%"> <p><b>M-</b></p></td> -<td width="8%"></td> -<td width="78%"> +<td width="2%"></td> +<td width="80%"> <p>followed by a printable character or the word "Space". Example: M-C</p></td></tr> <tr valign="top" align="left"> -<td width="11%"></td> +<td width="15%"></td> <td width="3%"> <p><b>F</b></p></td> -<td width="8%"></td> -<td width="78%"> +<td width="2%"></td> +<td width="80%"> <p>followed by a numeric value from 1 to 16. Example: F10</p> </td></tr> </table> -<p style="margin-left:11%;">Valid function names to be -bound include: <b><br> -help</b></p> - -<p style="margin-left:15%;">Invoke the help menu.</p> +<p style="margin-left:11%;">Valid <i>function</i> names to +be bound include:</p> -<p style="margin-left:11%;"><b>cancel</b></p> +<p style="margin-left:15%;"><b>help</b></p> -<p style="margin-left:15%;">Cancel the current command.</p> +<p style="margin-left:18%;">Invokes the help viewer.</p> -<p style="margin-left:11%;"><b>exit</b></p> +<p style="margin-left:15%;"><b>cancel</b></p> -<p style="margin-left:15%;">Exit from the program.</p> +<p style="margin-left:18%;">Cancels the current +command.</p> -<p style="margin-left:11%;"><b>writeout</b></p> +<p style="margin-left:15%;"><b>exit</b></p> -<p style="margin-left:15%;">Write the current buffer to -disk.</p> +<p style="margin-left:18%;">Exits from the program (or from +the help viewer or the file browser).</p> -<p style="margin-left:11%;"><b>justify</b></p> +<p style="margin-left:15%;"><b>writeout</b></p> -<p style="margin-left:15%;">Justify the current text.</p> +<p style="margin-left:18%;">Writes the current buffer to +disk.</p> -<p style="margin-left:11%;"><b>insert</b></p> +<p style="margin-left:15%;"><b>insert</b></p> -<p style="margin-left:15%;">Insert a file into the current +<p style="margin-left:18%;">Inserts a file into the current buffer (or into a new buffer when multibuffer is enabled).</p> -<p style="margin-left:11%;"><b>whereis</b></p> +<p style="margin-left:15%;"><b>whereis</b></p> -<p style="margin-left:15%;">Search for text in the current -buffer.</p> +<p style="margin-left:18%;">Searches for text in the +current buffer -- or for filenames matching a string in the +current list in the file browser.</p> -<p style="margin-left:11%;"><b>searchagain</b></p> +<p style="margin-left:15%;"><b>searchagain</b></p> -<p style="margin-left:15%;">Repeat the last search +<p style="margin-left:18%;">Repeats the last search command.</p> -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> +<p style="margin-left:15%;"><b>replace</b></p> +<p style="margin-left:18%;">Interactively replaces text +within the current buffer.</p> -<p><b>up</b></p></td> -<td width="1%"></td> -<td width="51%"> +<p style="margin-left:15%;"><b>cut</b></p> +<p style="margin-left:18%;">Cuts and stores the current +line (or the marked region).</p> -<p>Move up in the editor or browser.</p></td> -<td width="34%"> -</td></tr> -</table> +<p style="margin-left:15%;"><b>copytext</b></p> -<p style="margin-left:11%;"><b>down</b></p> +<p style="margin-left:18%;">Copies the current line (or the +marked region) without deleting it.</p> -<p style="margin-left:15%;">Move down in the editor or -browser.</p> +<p style="margin-left:15%;"><b>uncut</b></p> -<p style="margin-left:11%;"><b>left</b></p> +<p style="margin-left:18%;">Copies the currently stored +text into the current buffer at the current cursor +position.</p> -<p style="margin-left:15%;">Move left in the editor or -browser.</p> +<p style="margin-left:15%;"><b>mark</b></p> -<p style="margin-left:11%;"><b>right</b></p> +<p style="margin-left:18%;">Sets the mark at the current +position, to start selecting text.</p> -<p style="margin-left:15%;">Move right in the editor or -browser.</p> +<p style="margin-left:15%;"><b>cutrestoffile</b></p> -<p style="margin-left:11%;"><b>cut</b></p> +<p style="margin-left:18%;">Cuts all text from the cursor +position till the end of the buffer.</p> -<p style="margin-left:15%;">Cut the current line of text -and store it.</p> +<p style="margin-left:15%;"><b>curpos</b></p> -<p style="margin-left:11%;"><b>uncut</b></p> +<p style="margin-left:18%;">Shows the current cursor +position: the line, column, and character positions.</p> -<p style="margin-left:15%;">Copy the currently stored text -into the current buffer position.</p> +<p style="margin-left:15%;"><b>wordcount</b></p> -<p style="margin-left:11%;"><b>curpos</b></p> +<p style="margin-left:18%;">Counts the number of words, +lines and characters in the current buffer.</p> -<p style="margin-left:15%;">Show the current line, column, -word positions in the file.</p> +<p style="margin-left:15%;"><b>speller</b></p> -<p style="margin-left:11%;"><b>firstline</b></p> +<p style="margin-left:18%;">Invokes a spell-checking +program (or a linting program, if the current syntax +highlighting defines one).</p> -<p style="margin-left:15%;">Move to the first line of the -file.</p> +<p style="margin-left:15%;"><b>justify</b></p> -<p style="margin-left:11%;"><b>lastline</b></p> +<p style="margin-left:18%;">Justifies the current +paragraph.</p> -<p style="margin-left:15%;">Move to the last line of the -file.</p> +<p style="margin-left:15%;"><b>fulljustify</b></p> -<p style="margin-left:11%;"><b>gotoline</b></p> +<p style="margin-left:18%;">Justifies the entire current +buffer.</p> -<p style="margin-left:15%;">Move to a specific line (and -column if specified).</p> +<p style="margin-left:15%;"><b>indent</b></p> -<p style="margin-left:11%;"><b>replace</b></p> +<p style="margin-left:18%;">Indents (shifts to the right) +the currently marked text.</p> -<p style="margin-left:15%;">Interactively replace text -within the current buffer.</p> +<p style="margin-left:15%;"><b>unindent</b></p> + +<p style="margin-left:18%;">Unindents (shifts to the left) +the currently marked text.</p> + +<p style="margin-left:15%;"><b>left</b></p> -<p style="margin-left:11%;"><b>mark</b></p> +<p style="margin-left:18%;">Goes left one position (in the +editor or browser).</p> -<p style="margin-left:15%;">Begin selecting text for -cutting or pasting at the current position.</p> +<p style="margin-left:15%;"><b>right</b></p> -<p style="margin-left:11%;"><b>copytext</b></p> +<p style="margin-left:18%;">Goes right one position (in the +editor or browser).</p> -<p style="margin-left:15%;">Copy the currently marked text -without deleting it.</p> +<p style="margin-left:15%;"><b>up</b></p> -<p style="margin-left:11%;"><b>indent</b></p> +<p style="margin-left:18%;">Goes one line up (in the editor +or browser).</p> -<p style="margin-left:15%;">Indent the currently marked -text (shift to the right).</p> +<p style="margin-left:15%;"><b>down</b></p> -<p style="margin-left:11%;"><b>unindent</b></p> +<p style="margin-left:18%;">Goes one line down (in the +editor or browser).</p> -<p style="margin-left:15%;">Un-indent the currently marked -text (shift to the left).</p> +<p style="margin-left:15%;"><b>scrollup</b></p> -<p style="margin-left:11%;"><b>nextword</b></p> +<p style="margin-left:18%;">Scrolls up one line of text +from the current position.</p> + +<p style="margin-left:15%;"><b>scrolldown</b></p> + +<p style="margin-left:18%;">Scrolls down one line of text +from the current position.</p> -<p style="margin-left:15%;">Move the cursor to the +<p style="margin-left:15%;"><b>nextword</b></p> + +<p style="margin-left:18%;">Moves the cursor to the beginning of the next word.</p> -<p style="margin-left:11%;"><b>prevword</b></p> +<p style="margin-left:15%;"><b>prevword</b></p> -<p style="margin-left:15%;">Move the cursor to the +<p style="margin-left:18%;">Moves the cursor to the beginning of the previous word.</p> -<p style="margin-left:11%;"><b>home</b></p> +<p style="margin-left:15%;"><b>home</b></p> -<p style="margin-left:15%;">Move the cursor to the +<p style="margin-left:18%;">Moves the cursor to the beginning of the current line.</p> -<p style="margin-left:11%;"><b>end</b></p> +<p style="margin-left:15%;"><b>end</b></p> -<p style="margin-left:15%;">Move the cursor to the end of +<p style="margin-left:18%;">Moves the cursor to the end of the current line.</p> -<p style="margin-left:11%;"><b>beginpara</b></p> +<p style="margin-left:15%;"><b>beginpara</b></p> -<p style="margin-left:15%;">Move the cursor to the +<p style="margin-left:18%;">Moves the cursor to the beginning of the current paragraph.</p> -<p style="margin-left:11%;"><b>endpara</b></p> +<p style="margin-left:15%;"><b>endpara</b></p> -<p style="margin-left:15%;">Move the cursor to the end of +<p style="margin-left:18%;">Moves the cursor to the end of the current paragraph.</p> -<p style="margin-left:11%;"><b>findbracket</b></p> +<p style="margin-left:15%;"><b>prevpage</b></p> -<p style="margin-left:15%;">Move the cursor to the matching -bracket (brace, parenthesis, etc.) of the one under the -cursor.</p> +<p style="margin-left:18%;">Goes up one screenful.</p> -<p style="margin-left:11%;"><b>scrollup</b></p> +<p style="margin-left:15%;"><b>nextpage</b></p> -<p style="margin-left:15%;">Scroll up one line of text from -the current position.</p> +<p style="margin-left:18%;">Goes down one screenful.</p> -<p style="margin-left:11%;"><b>scrolldown</b></p> +<p style="margin-left:15%;"><b>firstline</b></p> -<p style="margin-left:15%;">Scroll down one line of text -from the current position.</p> +<p style="margin-left:18%;">Goes to the first line of the +file.</p> + +<p style="margin-left:15%;"><b>lastline</b></p> + +<p style="margin-left:18%;">Goes to the last line of the +file.</p> -<p style="margin-left:11%;"><b>prevbuf</b></p> +<p style="margin-left:15%;"><b>gotoline</b></p> -<p style="margin-left:15%;">Switch to editing/viewing the +<p style="margin-left:18%;">Goes to a specific line (and +column if specified).</p> + +<p style="margin-left:15%;"><b>gototext</b></p> + +<p style="margin-left:18%;">Switches from targeting a line +number to searching for text.</p> + +<p style="margin-left:15%;"><b>findbracket</b></p> + +<p style="margin-left:18%;">Moves the cursor to the bracket +(brace, parenthesis, etc.) that matches (pairs) with the one +under the cursor.</p> + +<p style="margin-left:15%;"><b>prevbuf</b></p> + +<p style="margin-left:18%;">Switches to editing/viewing the previous buffer when using multibuffer mode.</p> -<p style="margin-left:11%;"><b>nextbuf</b></p> +<p style="margin-left:15%;"><b>nextbuf</b></p> -<p style="margin-left:15%;">Switch to editing/viewing the +<p style="margin-left:18%;">Switches to editing/viewing the next buffer when using multibuffer mode.</p> -<p style="margin-left:11%;"><b>verbatim</b></p> +<p style="margin-left:15%;"><b>verbatim</b></p> -<p style="margin-left:15%;">Insert the next character +<p style="margin-left:18%;">Inserts the next character verbatim into the file.</p> -<p style="margin-left:11%;"><b>tab</b></p> +<p style="margin-left:15%;"><b>tab</b></p> -<p style="margin-left:15%;">Insert a tab at the current +<p style="margin-left:18%;">Inserts a tab at the current cursor location.</p> -<p style="margin-left:11%;"><b>enter</b></p> +<p style="margin-left:15%;"><b>enter</b></p> -<p style="margin-left:15%;">Insert a new line below the +<p style="margin-left:18%;">Inserts a new line below the current one.</p> -<p style="margin-left:11%;"><b>delete</b></p> +<p style="margin-left:15%;"><b>delete</b></p> -<p style="margin-left:15%;">Delete the character under the +<p style="margin-left:18%;">Deletes the character under the cursor.</p> -<p style="margin-left:11%;"><b>fulljustify</b></p> +<p style="margin-left:15%;"><b>backspace</b></p> -<p style="margin-left:15%;">Justify the entire current -file.</p> +<p style="margin-left:18%;">Deletes the character before +the cursor.</p> -<p style="margin-left:11%;"><b>wordcount</b></p> +<p style="margin-left:15%;"><b>undo</b></p> -<p style="margin-left:15%;">Count the number of words in -the current buffer.</p> +<p style="margin-left:18%;">Undoes the last performed text +action (add text, delete text, etc).</p> -<p style="margin-left:11%;"><b>refresh</b></p> +<p style="margin-left:15%;"><b>redo</b></p> -<p style="margin-left:15%;">Refresh the screen.</p> +<p style="margin-left:18%;">Redoes the last undone action +(i.e., it undoes an undo).</p> -<p style="margin-left:11%;"><b>undo</b></p> +<p style="margin-left:15%;"><b>refresh</b></p> -<p style="margin-left:15%;">Undo the text action peformed -(add text, delete text, etc).</p> +<p style="margin-left:18%;">Refreshes the screen.</p> -<p style="margin-left:11%;"><b>redo</b></p> +<p style="margin-left:15%;"><b>suspend</b></p> -<p style="margin-left:15%;">Redo the last undone action -(i.e., undo an undo).</p> - -<p style="margin-left:11%;"><b>suspend</b></p> - -<p style="margin-left:15%;">Suspend the editor (if the -suspend function is enabled, see the +<p style="margin-left:18%;">Suspends the editor (if the +suspending function is enabled, see the "suspendenable" entry below).</p> -<p style="margin-left:11%;"><b>casesens</b></p> +<p style="margin-left:15%;"><b>casesens</b></p> -<p style="margin-left:15%;">Toggle case sensitivity in +<p style="margin-left:18%;">Toggles case sensitivity in searching (search/replace menus only).</p> -<p style="margin-left:11%;"><b>regexp</b></p> +<p style="margin-left:15%;"><b>regexp</b></p> -<p style="margin-left:15%;">Toggle whether +<p style="margin-left:18%;">Toggles whether searching/replacing is based on literal strings or regular expressions.</p> -<p style="margin-left:11%;"><b>prevhistory</b></p> +<p style="margin-left:15%;"><b>backwards</b></p> + +<p style="margin-left:18%;">Toggles whether +searching/replacing goes forward or backward.</p> + +<p style="margin-left:15%;"><b>prevhistory</b></p> -<p style="margin-left:15%;">Show the previous history entry -in the prompt menus (e.g. search).</p> +<p style="margin-left:18%;">Shows the previous history +entry in the prompt menus (e.g. search).</p> -<p style="margin-left:11%;"><b>nexthistory</b></p> +<p style="margin-left:15%;"><b>nexthistory</b></p> -<p style="margin-left:15%;">Show the next history entry in +<p style="margin-left:18%;">Shows the next history entry in the prompt menus (e.g. search).</p> -<p style="margin-left:11%;"><b>dontreplace</b></p> +<p style="margin-left:15%;"><b>flipreplace</b></p> + +<p style="margin-left:18%;">Toggles between searching for +something and replacing something.</p> + +<p style="margin-left:15%;"><b>flipexecute</b></p> + +<p style="margin-left:18%;">Toggles between inserting a +file and executing a command.</p> -<p style="margin-left:15%;">Switch back to searching -instead of replacing.</p> +<p style="margin-left:15%;"><b>flipnewbuffer</b></p> -<p style="margin-left:11%;"><b>gototext</b></p> +<p style="margin-left:18%;">Toggles between inserting into +the current buffer and into a new empty buffer.</p> -<p style="margin-left:15%;">Search for files matching a -string in the file browser (reading or writing files).</p> +<p style="margin-left:15%;"><b>tofiles</b></p> -<p style="margin-left:11%;"><b>dosformat</b></p> +<p style="margin-left:18%;">Starts the file browser, +allowing to select a file from a list.</p> -<p style="margin-left:15%;">When writing a file, switch to -writing a DOS format (CR/LF).</p> +<p style="margin-left:15%;"><b>gotodir</b></p> -<p style="margin-left:11%;"><b>macformat</b></p> +<p style="margin-left:18%;">Goes to a directory to be +specified, allowing to browse anywhere in the +filesystem.</p> -<p style="margin-left:15%;">When writing a file, switch to -writing a Mac format.</p> +<p style="margin-left:15%;"><b>dosformat</b></p> -<p style="margin-left:11%;"><b>append</b></p> +<p style="margin-left:18%;">When writing a file, switches +to writing a DOS format (CR/LF).</p> -<p style="margin-left:15%;">When writing a file, append to +<p style="margin-left:15%;"><b>macformat</b></p> + +<p style="margin-left:18%;">When writing a file, switches +to writing a Mac format.</p> + +<p style="margin-left:15%;"><b>append</b></p> + +<p style="margin-left:18%;">When writing a file, appends to the end instead of overwriting.</p> -<p style="margin-left:11%;"><b>prepend</b></p> +<p style="margin-left:15%;"><b>prepend</b></p> -<p style="margin-left:15%;">When writing a file, -’prepend’ (write at the beginning) instead of +<p style="margin-left:18%;">When writing a file, +’prepends’ (writes at the beginning) instead of overwriting.</p> -<p style="margin-left:11%;"><b>backup</b></p> +<p style="margin-left:15%;"><b>backup</b></p> -<p style="margin-left:15%;">When writing a file, create a +<p style="margin-left:18%;">When writing a file, creates a backup of the current file.</p> -<p style="margin-left:11%;"><b>firstfile</b></p> +<p style="margin-left:15%;"><b>firstfile</b></p> -<p style="margin-left:15%;">Move to the first file when +<p style="margin-left:18%;">Goes to the first file when using the file browser (reading or writing files).</p> -<p style="margin-left:11%;"><b>lastfile</b></p> +<p style="margin-left:15%;"><b>lastfile</b></p> -<p style="margin-left:15%;">Move to the last file when +<p style="margin-left:18%;">Goes to the last file when using the file browser (reading or writing files).</p> -<p style="margin-left:11%;"><b>nohelp</b></p> +<p style="margin-left:15%;"><b>nohelp</b></p> -<p style="margin-left:15%;">Toggle showing/hiding the +<p style="margin-left:18%;">Toggles the presence of the two-line list of key bindings at the bottom of the screen.</p> -<p style="margin-left:11%;"><b>constupdate</b></p> +<p style="margin-left:15%;"><b>constupdate</b></p> + +<p style="margin-left:18%;">Toggles the constant display of +the current line, column, and character positions.</p> -<p style="margin-left:15%;">Constantly display the current -line, column, word positions.</p> +<p style="margin-left:15%;"><b>morespace</b></p> -<p style="margin-left:11%;"><b>morespace</b></p> +<p style="margin-left:18%;">Toggles the presence of the +blank line which ’separates’ the titlebar from +the file text.</p> -<p style="margin-left:15%;">Toggle showing/hiding the blank -line which ’separates’ the ’title’ -from the file text.</p> +<p style="margin-left:15%;"><b>smoothscroll</b></p> -<p style="margin-left:11%;"><b>smoothscroll</b></p> +<p style="margin-left:18%;">Toggles smooth scrolling (when +moving around with the arrow keys).</p> -<p style="margin-left:15%;">Toggle smooth scrolling when -moving via the arrow keys.</p> +<p style="margin-left:15%;"><b>softwrap</b></p> -<p style="margin-left:11%;"><b>whitespacedisplay</b></p> +<p style="margin-left:18%;">Toggles the displaying of +overlong lines on multiple screen lines.</p> -<p style="margin-left:15%;">Toggle whether whitespace is -shown.</p> +<p style="margin-left:15%;"><b>whitespacedisplay</b></p> -<p style="margin-left:11%;"><b>smarthome</b></p> +<p style="margin-left:18%;">Toggles the showing of +whitespace.</p> -<p style="margin-left:15%;">Toggle whether the smart home -key function is enabled.</p> +<p style="margin-left:15%;"><b>nosyntax</b></p> -<p style="margin-left:11%;"><b>autoindent</b></p> +<p style="margin-left:18%;">Toggles syntax +highlighting.</p> -<p style="margin-left:15%;">Toggle whether new lines will -contain the same amount of whitespace as the line above.</p> +<p style="margin-left:15%;"><b>smarthome</b></p> -<p style="margin-left:11%;"><b>cuttoend</b></p> +<p style="margin-left:18%;">Toggles the smartness of the +Home key.</p> -<p style="margin-left:15%;">Toggle whether cutting text +<p style="margin-left:15%;"><b>autoindent</b></p> + +<p style="margin-left:18%;">Toggles whether new lines will +contain the same amount of whitespace as the preceding +line.</p> + +<p style="margin-left:15%;"><b>cuttoend</b></p> + +<p style="margin-left:18%;">Toggles whether cutting text will cut the whole line or just from the current cursor position to the end of the line.</p> -<p style="margin-left:11%;"><b>nowrap</b></p> +<p style="margin-left:15%;"><b>nowrap</b></p> + +<p style="margin-left:18%;">Toggles whether long lines will +be hard-wrapped to the next line.</p> + +<p style="margin-left:15%;"><b>tabstospaces</b></p> + +<p style="margin-left:18%;">Toggles whether typed tabs will +be converted to spaces.</p> + +<p style="margin-left:15%;"><b>backupfile</b></p> + +<p style="margin-left:18%;">Toggles whether a backup will +be made of the file to be edited.</p> + +<p style="margin-left:15%;"><b>multibuffer</b></p> + +<p style="margin-left:18%;">Toggles the use of multiple +file buffers (if support for them has been compiled in).</p> + +<p style="margin-left:15%;"><b>mouse</b></p> -<p style="margin-left:15%;">Toggle whether long lines will -be wrapped to the next line.</p> +<p style="margin-left:18%;">Toggles mouse support.</p> -<p style="margin-left:11%;"><b>suspendenable</b></p> +<p style="margin-left:15%;"><b>noconvert</b></p> -<p style="margin-left:15%;">Toggle whether the suspend +<p style="margin-left:18%;">Toggles automatic conversion of +files from DOS/Mac format.</p> + +<p style="margin-left:15%;"><b>suspendenable</b></p> + +<p style="margin-left:18%;">Toggles whether the suspend sequence (normally ^Z) will suspend the editor window.</p> -<p style="margin-left:11%; margin-top: 1em">Valid menu -sections are: <b><br> -main</b></p> +<p style="margin-left:11%;">Valid <i>menu</i> sections +are:</p> -<p style="margin-left:15%;">The main editor window where -text is entered.</p> +<p style="margin-left:15%;"><b>main</b></p> -<p style="margin-left:11%;"><b>search</b></p> +<p style="margin-left:18%;">The main editor window where +text is entered and edited.</p> -<p style="margin-left:15%;">The search menu (AKA +<p style="margin-left:15%;"><b>search</b></p> + +<p style="margin-left:18%;">The search menu (AKA whereis).</p> -<p style="margin-left:11%;"><b>replace</b></p> +<p style="margin-left:15%;"><b>replace</b></p> -<p style="margin-left:15%;">The ’search to +<p style="margin-left:18%;">The ’search to replace’ menu.</p> -<p style="margin-left:11%;"><b>replacewith</b></p> +<p style="margin-left:15%;"><b>replacewith</b></p> -<p style="margin-left:15%;">The ’replace with’ +<p style="margin-left:18%;">The ’replace with’ menu, which comes up after ’search to replace’.</p> -<p style="margin-left:11%;"><b>gotoline</b></p> +<p style="margin-left:15%;"><b>gotoline</b></p> -<p style="margin-left:15%;">The ’goto line (and +<p style="margin-left:18%;">The ’goto line (and column)’ menu.</p> -<p style="margin-left:11%;"><b>writeout</b></p> +<p style="margin-left:15%;"><b>writeout</b></p> -<p style="margin-left:15%;">The ’write file’ +<p style="margin-left:18%;">The ’write file’ menu.</p> -<p style="margin-left:11%;"><b>insert</b></p> +<p style="margin-left:15%;"><b>insert</b></p> -<p style="margin-left:15%;">The ’insert file’ +<p style="margin-left:18%;">The ’insert file’ menu.</p> -<p style="margin-left:11%;"><b>extcmd</b></p> +<p style="margin-left:15%;"><b>extcmd</b></p> -<p style="margin-left:15%;">The menu for inserting output -from an external comman, reached from the insert menu.</p> +<p style="margin-left:18%;">The menu for inserting output +from an external command, reached from the insert menu.</p> -<p style="margin-left:11%;"><b>help</b></p> +<p style="margin-left:15%;"><b>help</b></p> -<p style="margin-left:15%;">The help menu.</p> +<p style="margin-left:18%;">The help-viewer menu.</p> -<p style="margin-left:11%;"><b>spell</b></p> +<p style="margin-left:15%;"><b>spell</b></p> -<p style="margin-left:15%;">The interactive spell checker +<p style="margin-left:18%;">The interactive spell checker Yes/no menu.</p> -<p style="margin-left:11%;"><b>browser</b></p> +<p style="margin-left:15%;"><b>linter</b></p> + +<p style="margin-left:18%;">The linter menu.</p> -<p style="margin-left:15%;">The file browser for inserting +<p style="margin-left:15%;"><b>browser</b></p> + +<p style="margin-left:18%;">The file browser for inserting or writing a file.</p> -<p style="margin-left:11%;"><b>whereisfile</b></p> +<p style="margin-left:15%;"><b>whereisfile</b></p> -<p style="margin-left:15%;">The ’search for a +<p style="margin-left:18%;">The ’search for a file’ menu in the file browser.</p> -<p style="margin-left:11%;"><b>gotodir</b></p> - -<p style="margin-left:15%;">The ’go to -directory’ menu.</p> +<p style="margin-left:15%;"><b>gotodir</b></p> -<p style="margin-left:11%;"><b>all</b></p> +<p style="margin-left:18%;">The ’go to +directory’ menu in the file browser.</p> -<p style="margin-left:15%;">A special name meaning: apply -to all menus where this function exists.</p> +<p style="margin-left:15%;"><b>all</b></p> -<p style="margin-left:11%;"><b>unbind</b> <i>key -menu</i></p> - -<p style="margin-left:15%;">Unbind the key <i>key</i> from -the menu named <i>menu</i> or from all menus by using -<i>all</i>. Same key syntax as for binding. Rebinds the key -<i>key</i> to a new function named <i>function</i> in the -context of menu <i>menu</i>. The format of <i>key</i> should -be one of:</p> +<p style="margin-left:18%;">A special name that encompasses +all menus. For <b>bind</b> it means all menus where the +specified <i>function</i> exists; for <b>unbind</b> it means +all menus where the specified <i>key</i> exists.</p> <h2>FILES <a name="FILES"></a> @@ -925,35 +1110,39 @@ be one of:</p> -<p style="margin-left:11%; margin-top: 1em"><i>SYSCONFDIR/nanorc</i></p> +<p style="margin-left:11%; margin-top: 1em"><b>/etc/nanorc</b></p> <p style="margin-left:22%;">System-wide configuration -file</p> +file.</p> -<p style="margin-left:11%;"><i>~/.nanorc</i></p> +<p style="margin-left:11%;"><b>~/.nanorc</b></p> -<p style="margin-left:22%;">Per-user configuration file</p> +<p style="margin-left:22%;">Per-user configuration +file.</p> <h2>SEE ALSO <a name="SEE ALSO"></a> </h2> -<p style="margin-left:11%; margin-top: 1em"><b>nano</b>(1) -<i><br> -/usr/share/doc/nano/examples/nanorc.sample</i> (or -equivalent on your system)</p> + +<p style="margin-left:11%; margin-top: 1em"><b>nano</b>(1)</p> + + +<p style="margin-left:11%; margin-top: 1em"><i>/usr/share/doc/nano/examples/nanorc.sample</i> +(or equivalent on your system)</p> <h2>AUTHOR <a name="AUTHOR"></a> </h2> -<p style="margin-left:11%;">Chris Allegretta -<chrisa@asty.org>, et al (see <i>AUTHORS</i> and -<i>THANKS</i> for details). This manual page was originally -written by Jordi Mallach <jordi@gnu.org>, for the -Debian system (but may be used by others).</p> +<p style="margin-left:11%; margin-top: 1em">Chris +Allegretta <chrisa@asty.org>, et al (see +<i>AUTHORS</i> and <i>THANKS</i> for details). This manual +page was originally written by Jordi Mallach +<jordi@gnu.org>, for the Debian system (but may be +used by others).</p> <hr> </body> </html> diff --git a/doc/man/rnano.1 b/doc/man/rnano.1 index 6b8a9b8..24851b2 100644 --- a/doc/man/rnano.1 +++ b/doc/man/rnano.1 @@ -1,7 +1,7 @@ .\" Hey, EMACS: -*- nroff -*- -.\" Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc. -.\" Skeleton based on nano-tiny.1: -.\" Copyright (C) 2002 Free Software Foundation, Inc. +.\" $Id: rnano.1 5135 2015-03-08 15:59:15Z bens $ +.\" +.\" Copyright (C) 2002, 2005, 2006, 2007, 2014 Free Software Foundation, Inc. .\" .\" This document is dual-licensed. You may distribute and/or modify it .\" under the terms of either of the following licenses: @@ -19,8 +19,7 @@ .\" Documentation License along with this program. If not, see .\" <http://www.gnu.org/licenses/>. .\" -.\" $Id: rnano.1 4188 2007-12-08 04:27:44Z dolorous $ -.TH RNANO 1 "version 2.0.0" "August 23, 2007" +.TH RNANO 1 "version 2.4.0" "March 2015" .\" Please adjust this date whenever revising the manpage. .\" .SH NAME @@ -29,18 +28,12 @@ Pico clone .SH SYNOPSIS .B rnano -.I [OPTIONS]\ [[\+LINE,COLUMN]\ FILE]... -.br +.RI [ options "] [[+" line , column "]\ " file "]..." .SH DESCRIPTION -This manual page briefly documents the \fBrnano\fP command. -.PP -.\" TeX users may be more comfortable with the \fB<whatever>\fP and -.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, -.\" respectively. \fBnano\fP is a small, free and friendly editor which aims to replace -Pico, the default editor included in the non-free Pine package. Rather -than just copying Pico's look and feel, \fBnano\fP also implements some +Pico, the default editor included in the non-free Pine package. On +top of copying Pico's look and feel, \fBnano\fP also implements some missing (or disabled by default) features in Pico, such as "search and replace" and "go to line and column number". .PP @@ -48,7 +41,7 @@ replace" and "go to line and column number". specific files and doesn't allow the user access to the filesystem or a command shell. .PP -In restricted mode, \fBnano\fP will \fInot\fP: +In restricted mode, \fBnano\fP will \fInot\/\fP: .IP \[bu] 2 read or write to any file not specified on the command line; .IP \[bu] @@ -63,22 +56,13 @@ use backup files or spell checking. .SH OPTIONS .TP -.B \+\fILINE\fP,\fICOLUMN\fP -Places cursor at line number \fILINE\fP and column number \fICOLUMN\fP -(at least one of which must be specified) on startup, instead of the -default of line 1, column 1. -.TP -.B \-? -Same as \fB-h (\-\-help)\fP. -.TP -.B \-h (\-\-help) -Show a summary of command line options and exit. +.BR \-h ", " \-\-help +Show a summary of command-line options and exit. .TP -.B \-V (\-\-version) +.BR \-V ", " \-\-version Show the current version number and exit. .PP -See the \fBnano\fP(1) manpage for the complete documentation of -\fBnano\fP. +See the \fBnano\fP(1) manpage for all of the possible options. .SH BUGS Please send any comments or bug reports to \fBnano@nano-editor.org\fP. @@ -92,7 +76,7 @@ of "subscribe". http://www.nano-editor.org/ .SH AUTHOR -Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS for details). +Chris Allegretta <chrisa@asty.org>, et al (see the file AUTHORS for details). This manual page was originally written by Thijs Kinkhorst <thijs@kinkhorst.com>, for the Debian system (but may be used by others). diff --git a/doc/man/rnano.1.html b/doc/man/rnano.1.html index 5fc5991..0dd2db0 100644 --- a/doc/man/rnano.1.html +++ b/doc/man/rnano.1.html @@ -1,5 +1,5 @@ -<!-- Creator : groff version 1.20.1 --> -<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Sun Mar 22 23:46:10 2015 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -46,22 +46,20 @@ free Pico clone</p> <p style="margin-left:11%; margin-top: 1em"><b>rnano</b> -<i>[OPTIONS] [[+LINE,COLUMN] FILE]...</i></p> +[<i>options</i>] +[[+<i>line</i>,<i>column</i>] <i>file</i>]...</p> <h2>DESCRIPTION <a name="DESCRIPTION"></a> </h2> -<p style="margin-left:11%; margin-top: 1em">This manual -page briefly documents the <b>rnano</b> command.</p> - <p style="margin-left:11%; margin-top: 1em"><b>nano</b> is a small, free and friendly editor which aims to replace Pico, the default editor included in the non-free Pine -package. Rather than just copying Pico’s look and -feel, <b>nano</b> also implements some missing (or disabled -by default) features in Pico, such as "search and +package. On top of copying Pico’s look and feel, +<b>nano</b> also implements some missing (or disabled by +default) features in Pico, such as "search and replace" and "go to line and column number".</p> @@ -140,45 +138,20 @@ under a different name;</p></td></tr> -<p style="margin-left:11%; margin-top: 1em"><b>+</b><i>LINE</i><b>,</b><i>COLUMN</i></p> - -<p style="margin-left:22%;">Places cursor at line number -<i>LINE</i> and column number <i>COLUMN</i> (at least one of -which must be specified) on startup, instead of the default -of line 1, column 1.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−?</b></p></td> -<td width="8%"></td> -<td width="30%"> - - -<p>Same as <b>-h (−−help)</b>.</p></td> -<td width="48%"> -</td></tr> -</table> - -<p style="margin-left:11%;"><b>−h -(−−help)</b></p> +<p style="margin-left:11%; margin-top: 1em"><b>−h</b>, +<b>−−help</b></p> -<p style="margin-left:22%;">Show a summary of command line +<p style="margin-left:22%;">Show a summary of command-line options and exit.</p> -<p style="margin-left:11%;"><b>−V -(−−version)</b></p> +<p style="margin-left:11%;"><b>−V</b>, +<b>−−version</b></p> <p style="margin-left:22%;">Show the current version number and exit.</p> <p style="margin-left:11%; margin-top: 1em">See the -<b>nano</b>(1) manpage for the complete documentation of -<b>nano</b>.</p> +<b>nano</b>(1) manpage for all of the possible options.</p> <h2>BUGS <a name="BUGS"></a> @@ -210,10 +183,10 @@ email to <b>nano-devel-request@gnu.org</b> with a subject of <p style="margin-left:11%; margin-top: 1em">Chris -Allegretta <chrisa@asty.org>, et al (see AUTHORS for -details). This manual page was originally written by Thijs -Kinkhorst <thijs@kinkhorst.com>, for the Debian system -(but may be used by others).</p> +Allegretta <chrisa@asty.org>, et al (see the file +AUTHORS for details). This manual page was originally +written by Thijs Kinkhorst <thijs@kinkhorst.com>, for +the Debian system (but may be used by others).</p> <hr> </body> </html> diff --git a/doc/nanorc.sample.in b/doc/nanorc.sample.in index f164c26..911f2b9 100644 --- a/doc/nanorc.sample.in +++ b/doc/nanorc.sample.in @@ -5,7 +5,7 @@ ## DOS or Mac format, and that characters specially interpreted by the ## shell should not be escaped here. ## -## To make sure a value is disabled, use "unset <option>". +## To make sure an option is disabled, use "unset <option>". ## ## For the options that take parameters, the default value is given. ## Other options are unset by default. @@ -15,10 +15,15 @@ ## its end. For example, for the "brackets" option, ""')>]}" will match ## ", ', ), >, ], and }. +## Silently ignore problems with unknown directives in the nanorc file. +## Useful when your nanorc file might be read on systems with multiple +## versions of nano installed (e.g. your home directory is on NFS). +# set quiet + ## Use auto-indentation. # set autoindent -## Backup files to filename~. +## Back up files to the current filename plus a tilde. # set backup ## The directory to put unique backup files in. @@ -34,32 +39,34 @@ ## paragraphs. They cannot contain blank characters. Only closing ## punctuation, optionally followed by closing brackets, can end ## sentences. -## # set brackets ""')>]}" -## Do case sensitive searches by default. +## Do case-sensitive searches by default. # set casesensitive ## Constantly display the cursor position in the statusbar. Note that ## this overrides "quickblank". # set const -## Use cut to end of line by default. +## Use cut-to-end-of-line by default. # set cut ## Set the line length for wrapping text and justifying paragraphs. -## If fill is 0 or less, the line length will be the screen width less -## this number. -## +## If the value is 0 or less, the wrapping point will be the screen +## width less this number. # set fill -8 ## Enable ~/.nano_history for saving and reading search/replace strings. # set historylog +## Enable vim-style lock-files. This is just to let a vim user know you +## are editing a file [s]he is trying to edit and vice versa. There are +## no plans to implement vim-style undo state in these files. +# set locking + ## The opening and closing brackets that can be found by bracket ## searches. They cannot contain blank characters. The former set must ## come before the latter set, and both must be in the same order. -## # set matchbrackets "(<[{)>]}" ## Use the blank line below the titlebar as extra editing space. @@ -69,13 +76,10 @@ ## mouse clicks can be used to place the cursor, set the mark (with a ## double click), and execute shortcuts. The mouse will work in the X ## Window System, and on the console when gpm is running. -## # set mouse -## Allow multiple file buffers (inserting a file will put it into a -## separate buffer). You must have configured with --enable-multibuffer -## for this to work. -## +## Switch on multiple file buffers (inserting a file will put it into +## a separate buffer). # set multibuffer ## Don't convert files from DOS/Mac format. @@ -96,10 +100,12 @@ ## Set operating directory. nano will not read or write files outside ## this directory and its subdirectories. Also, the current directory ## is changed to here, so any files are inserted from this dir. A blank -## string means the operating directory feature is turned off. -## +## string means the operating-directory feature is turned off. # set operatingdir "" +## Remember the cursor position in each file for the next editing session. +# set poslog + ## Preserve the XON and XOFF keys (^Q and ^S). # set preserve @@ -107,19 +113,18 @@ ## paragraphs. They cannot contain blank characters. Only closing ## punctuation, optionally followed by closing brackets, can end ## sentences. -## # set punct "!.?" ## Do quick statusbar blanking. Statusbar messages will disappear after ## 1 keystroke instead of 26. Note that "const" overrides this. -## # set quickblank ## The email-quote string, used to justify email-quoted paragraphs. ## This is an extended regular expression if your system supports them, -## otherwise a literal string. Default: +## otherwise a literal string. +## If you have extended regular expression support, the default is: # set quotestr "^([ ]*[#:>\|}])+" -## if you have extended regular expression support, otherwise: +## Otherwise: # set quotestr "> " ## Fix Backspace/Delete confusion problem. @@ -141,12 +146,11 @@ ## Use smooth scrolling as the default. # set smooth -## Enable soft line wrapping (AKA full line display). +## Enable soft line wrapping (AKA full-line display). # set softwrap ## Use this spelling checker instead of the internal one. This option ## does not properly have a default value. -## # set speller "aspell -x -c" ## Allow nano to be suspended. @@ -158,27 +162,34 @@ ## Convert typed tabs to spaces. # set tabstospaces -## Save automatically on exit, don't prompt. +## Save automatically on exit; don't prompt. # set tempfile -## Enable the new (EXPERIMENTAL) generic undo code, not just for line -## cuts. -# set undo - ## Disallow file modification. Why would you want this in an rcfile? ;) # set view ## The two single-column characters used to display the first characters ## of tabs and spaces. 187 in ISO 8859-1 (0000BB in Unicode) and 183 in ## ISO-8859-1 (0000B7 in Unicode) seem to be good values for these. -# set whitespace " " +## The default when in a UTF-8 locale: +# set whitespace "»·" +## The default otherwise: +# set whitespace ">." ## Detect word boundaries more accurately by treating punctuation ## characters as parts of words. # set wordbounds -## Color setup +## Paint the interface elements of nano. +## This is an example; by default there are no colors. +# set titlecolor brightwhite,blue +# set statuscolor brightwhite,green +# set keycolor green +# set functioncolor yellow + + +## Setup of syntax coloring. ## ## Format: ## @@ -193,8 +204,8 @@ ## or ## icolor foreground,background "regex" ["regex"...] ## -## "color" will do case sensitive matches, while "icolor" will do case -## insensitive matches. +## "color" will do case-sensitive matches, while "icolor" will do +## case-insensitive matches. ## ## Valid colors: white, black, red, blue, green, yellow, magenta, cyan. ## For foreground colors, you may use the prefix "bright" to get a @@ -207,9 +218,10 @@ ## color will use a transparent color. If you don't want this, be sure ## to set the background color to black or white. ## -## If you wish, you may put your syntaxes in separate files. You can -## make use of such files (which can only include "syntax", "color", and -## "icolor" commands) as follows: +## All regexes should be extended regular expressions. +## +## If you wish, you may put your syntax definitions in separate files. +## You can make use of such files as follows: ## ## include "/path/to/syntax_file.nanorc" ## @@ -218,95 +230,18 @@ ## name inside that file. These names are kept fairly short to make ## them easier to remember and faster to type using nano's -Y option. ## -## All regexes should be extended regular expressions. +## To include all existing syntax definitions, you can do: +# include "@PKGDATADIR@/*.nanorc" -## Key bindings -## Please see nanorc(5) for more details on this + +## Key bindings. +## See nanorc(5) for more details on this. ## -## Here are some samples to get you going +## Here are a few samples to get you going. ## # bind M-W nowrap main # bind M-A casesens search # bind ^S research main -## Set this if your backspace key sends delete most of the time (2.1.3+) -# bind kdel backspace all - - -## Nanorc files -# include "@PKGDATADIR@/nanorc.nanorc" - -## C/C++ -# include "@PKGDATADIR@/c.nanorc" - -## Makefiles -# include "@PKGDATADIR@/makefile.nanorc" - -## Cascading Style Sheets -# include "@PKGDATADIR@/css.nanorc" - -## Debian files -# include "@PKGDATADIR@/debian.nanorc" - -## Gentoo files -# include "@PKGDATADIR@/gentoo.nanorc" - -## HTML -# include "@PKGDATADIR@/html.nanorc" - -## PHP -# include "@PKGDATADIR@/php.nanorc" - -## TCL -# include "@PKGDATADIR@/tcl.nanorc" - -## TeX -# include "@PKGDATADIR@/tex.nanorc" - -## Quoted emails (under e.g. mutt) -# include "@PKGDATADIR@/mutt.nanorc" - -## Patch files -# include "@PKGDATADIR@/patch.nanorc" - -## Manpages -# include "@PKGDATADIR@/man.nanorc" - -## Groff -# include "@PKGDATADIR@/groff.nanorc" - -## Perl -# include "@PKGDATADIR@/perl.nanorc" - -## Python -# include "@PKGDATADIR@/python.nanorc" - -## Ruby -# include "@PKGDATADIR@/ruby.nanorc" - -## Java -# include "@PKGDATADIR@/java.nanorc" - -## Fortran -# include "@PKGDATADIR@/fortran.nanorc" - -## Objective-C -# include "@PKGDATADIR@/objc.nanorc" - -## OCaml -# include "@PKGDATADIR@/ocaml.nanorc" - -## AWK -# include "@PKGDATADIR@/awk.nanorc" - -## Assembler -# include "@PKGDATADIR@/asm.nanorc" - -## Bourne shell scripts -# include "@PKGDATADIR@/sh.nanorc" - -## POV-Ray -# include "@PKGDATADIR@/pov.nanorc" - -## XML-type files -# include "@PKGDATADIR@/xml.nanorc" +## Set this if your backspace key sends Del most of the time. +# bind Del backspace all diff --git a/doc/syntax/Makefile.am b/doc/syntax/Makefile.am index 372ddb2..03bc8e3 100644 --- a/doc/syntax/Makefile.am +++ b/doc/syntax/Makefile.am @@ -1,30 +1,39 @@ pkgdata_DATA = asm.nanorc \ - c.nanorc \ + awk.nanorc \ + changelog.nanorc \ cmake.nanorc \ + c.nanorc \ + css.nanorc \ + debian.nanorc \ + default.nanorc \ + fortran.nanorc \ + gentoo.nanorc \ + go.nanorc \ groff.nanorc \ html.nanorc \ java.nanorc \ + javascript.nanorc \ + json.nanorc \ + lua.nanorc \ + makefile.nanorc \ man.nanorc \ + mgp.nanorc \ mutt.nanorc \ nanorc.nanorc \ + objc.nanorc \ + ocaml.nanorc \ patch.nanorc \ perl.nanorc \ + php.nanorc \ + po.nanorc \ pov.nanorc \ python.nanorc \ ruby.nanorc \ sh.nanorc \ - tex.nanorc \ + spec.nanorc \ tcl.nanorc \ - php.nanorc \ - gentoo.nanorc \ - debian.nanorc \ - awk.nanorc \ - css.nanorc \ - xml.nanorc \ - ocaml.nanorc \ - objc.nanorc \ - fortran.nanorc \ - makefile.nanorc \ - mgp.nanorc + tex.nanorc \ + texinfo.nanorc \ + xml.nanorc EXTRA_DIST = $(pkgdata_DATA) diff --git a/doc/syntax/Makefile.in b/doc/syntax/Makefile.in index 90fe9eb..f86e504 100644 --- a/doc/syntax/Makefile.in +++ b/doc/syntax/Makefile.in @@ -1,9 +1,8 @@ -# Makefile.in generated by automake 1.11.1 from Makefile.am. +# Makefile.in generated by automake 1.14.1 from Makefile.am. # @configure_input@ -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. +# Copyright (C) 1994-2013 Free Software Foundation, Inc. + # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -16,6 +15,51 @@ @SET_MAKE@ VPATH = @srcdir@ +am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)' +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -34,11 +78,12 @@ PRE_UNINSTALL = : POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ -target_triplet = @target@ subdir = doc/syntax -DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \ + $(top_srcdir)/mkinstalldirs ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.m4 \ + $(top_srcdir)/m4/ax_check_compile_flag.m4 \ $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/glib-2.0.m4 \ $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/isc-posix.m4 \ $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ @@ -50,8 +95,25 @@ mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = SOURCES = DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; am__vpath_adj = case $$p in \ $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ @@ -73,11 +135,19 @@ am__nobase_list = $(am__nobase_strip_setup); \ am__base_list = \ sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } am__installdirs = "$(DESTDIR)$(pkgdatadir)" DATA = $(pkgdata_DATA) +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ @@ -123,6 +193,11 @@ MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGMERGE = @MSGMERGE@ +NCURSESW_CFLAGS = @NCURSESW_CFLAGS@ +NCURSESW_CONFIG = @NCURSESW_CONFIG@ +NCURSESW_LIBS = @NCURSESW_LIBS@ +NCURSES_CFLAGS = @NCURSES_CFLAGS@ +NCURSES_LIBS = @NCURSES_LIBS@ OBJEXT = @OBJEXT@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ @@ -134,6 +209,8 @@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKGDATADIR = @PKGDATADIR@ PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ POSUB = @POSUB@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ @@ -163,6 +240,7 @@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ +haveit = @haveit@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ @@ -187,42 +265,47 @@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ -target = @target@ target_alias = @target_alias@ -target_cpu = @target_cpu@ -target_os = @target_os@ -target_vendor = @target_vendor@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ pkgdata_DATA = asm.nanorc \ - c.nanorc \ + awk.nanorc \ + changelog.nanorc \ cmake.nanorc \ + c.nanorc \ + css.nanorc \ + debian.nanorc \ + default.nanorc \ + fortran.nanorc \ + gentoo.nanorc \ + go.nanorc \ groff.nanorc \ html.nanorc \ java.nanorc \ + javascript.nanorc \ + json.nanorc \ + lua.nanorc \ + makefile.nanorc \ man.nanorc \ + mgp.nanorc \ mutt.nanorc \ nanorc.nanorc \ + objc.nanorc \ + ocaml.nanorc \ patch.nanorc \ perl.nanorc \ + php.nanorc \ + po.nanorc \ pov.nanorc \ python.nanorc \ ruby.nanorc \ sh.nanorc \ - tex.nanorc \ + spec.nanorc \ tcl.nanorc \ - php.nanorc \ - gentoo.nanorc \ - debian.nanorc \ - awk.nanorc \ - css.nanorc \ - xml.nanorc \ - ocaml.nanorc \ - objc.nanorc \ - fortran.nanorc \ - makefile.nanorc \ - mgp.nanorc + tex.nanorc \ + texinfo.nanorc \ + xml.nanorc EXTRA_DIST = $(pkgdata_DATA) all: all-am @@ -260,8 +343,11 @@ $(ACLOCAL_M4): $(am__aclocal_m4_deps) $(am__aclocal_m4_deps): install-pkgdataDATA: $(pkgdata_DATA) @$(NORMAL_INSTALL) - test -z "$(pkgdatadir)" || $(MKDIR_P) "$(DESTDIR)$(pkgdatadir)" @list='$(pkgdata_DATA)'; test -n "$(pkgdatadir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(pkgdatadir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(pkgdatadir)" || exit 1; \ + fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ @@ -275,14 +361,12 @@ uninstall-pkgdataDATA: @$(NORMAL_UNINSTALL) @list='$(pkgdata_DATA)'; test -n "$(pkgdatadir)" || list=; \ files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ - test -n "$$files" || exit 0; \ - echo " ( cd '$(DESTDIR)$(pkgdatadir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(pkgdatadir)" && rm -f $$files -tags: TAGS -TAGS: + dir='$(DESTDIR)$(pkgdatadir)'; $(am__uninstall_files_from_dir) +tags TAGS: + +ctags CTAGS: -ctags: CTAGS -CTAGS: +cscope cscopelist: distdir: $(DISTFILES) @@ -332,10 +416,15 @@ install-am: all-am installcheck: installcheck-am install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi mostlyclean-generic: clean-generic: @@ -415,16 +504,17 @@ uninstall-am: uninstall-pkgdataDATA .MAKE: install-am install-strip -.PHONY: all all-am check check-am clean clean-generic distclean \ - distclean-generic distdir dvi dvi-am html html-am info info-am \ - install install-am install-data install-data-am install-dvi \ - install-dvi-am install-exec install-exec-am install-html \ - install-html-am install-info install-info-am install-man \ - install-pdf install-pdf-am install-pkgdataDATA install-ps \ - install-ps-am install-strip installcheck installcheck-am \ - installdirs maintainer-clean maintainer-clean-generic \ - mostlyclean mostlyclean-generic pdf pdf-am ps ps-am uninstall \ - uninstall-am uninstall-pkgdataDATA +.PHONY: all all-am check check-am clean clean-generic cscopelist-am \ + ctags-am distclean distclean-generic distdir dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-pdf install-pdf-am \ + install-pkgdataDATA install-ps install-ps-am install-strip \ + installcheck installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ + pdf-am ps ps-am tags-am uninstall uninstall-am \ + uninstall-pkgdataDATA # Tell versions [3.59,3.63) of GNU make to not export all variables. diff --git a/doc/syntax/asm.nanorc b/doc/syntax/asm.nanorc index e94ee90..4e21591 100644 --- a/doc/syntax/asm.nanorc +++ b/doc/syntax/asm.nanorc @@ -1,17 +1,23 @@ ## Here is an example for assembler. -## + syntax "asm" "\.(S|s|asm)$" +magic "[Aa]ssembl(y|er)" + color red "\<[A-Z_]{2,}\>" color brightgreen "\.(data|subsection|text)" color green "\.(align|file|globl|global|hidden|section|size|type|weak)" color brightyellow "\.(ascii|asciz|byte|double|float|hword|int|long|short|single|struct|word)" icolor brightred "^[[:space:]]*[.0-9A-Z_]*:" color brightcyan "^[[:space:]]*#[[:space:]]*(define|undef|include|ifn?def|endif|elif|else|if|warning|error)" -## Highlight strings (note: VERY resource intensive) + +# Strings. color brightyellow "<[^= ]*>" ""(\\.|[^"])*"" +# Multiline strings (note: VERY resource intensive). color brightyellow start=""(\\.|[^"])*\\[[:space:]]*$" end="^(\\.|[^"])*"" -## Highlight comments + +# Comments. color brightblue "//.*" color brightblue start="/\*" end="\*/" -## Highlight trailing whitespace + +# Trailing whitespace. color ,green "[[:space:]]+$" diff --git a/doc/syntax/awk.nanorc b/doc/syntax/awk.nanorc index 696ab6a..bfc6387 100644 --- a/doc/syntax/awk.nanorc +++ b/doc/syntax/awk.nanorc @@ -1,23 +1,25 @@ ## Here is an example for awk. -## + syntax "awk" "\.awk$" -## records +magic "awk.*script text" + +# Records. icolor brightred "\$[0-9A-Z_!@#$*?-]+" -## awk-set variables +# Awk-set variables. color red "\<(ARGC|ARGIND|ARGV|BINMODE|CONVFMT|ENVIRON|ERRNO|FIELDWIDTHS)\>" color red "\<(FILENAME|FNR|FS|IGNORECASE|LINT|NF|NR|OFMT|OFS|ORS)\>" color red "\<(PROCINFO|RS|RT|RSTART|RLENGTH|SUBSEP|TEXTDOMAIN)\>" -## function declarations and special patterns +# Function declarations and special patterns. color brightgreen "\<(function|extension|BEGIN|END)\>" -## operators +# Operators. color green "(\{|\}|\(|\)|\;|\]|\[|\\|<|>|!|=|&|\+|-|\*|%|/|\?:|\^|\|)" -## flow control +# Flow control. color brightyellow "\<(for|if|while|do|else|in|delete|exit)\>" color brightyellow "\<(break|continue|return)\>" -## I/O statements +# I/O statements. color brightgreen "\<(close|getline|next|nextfile|print|printf)\>" color brightgreen "\<(system|fflush)\>" -## standard functions +# Standard functions. color magenta "\<(atan2|cos|exp|int|log|rand|sin|sqrt|srand)\>" color magenta "\<(asort|asorti|gensub|gsub|index|length|match)\>" color magenta "\<(split|sprintf|strtonum|sub|substr|tolower|toupper)\>" @@ -25,14 +27,10 @@ color magenta "\<(mktime|strftime|systime)\>" color magenta "\<(and|compl|lshift|or|rshift|xor)\>" color magenta "\<(bindtextdomain|dcgettext|dcngettext)\>" -## -## String highlighting. You will in general want your comments and -## strings to come last, because syntax highlighting rules will be -## applied in the order they are read in. +# Strings. color brightyellow "<[^= ]*>" ""(\\.|[^"])*"" - -## Comment highlighting +# Comments. color brightblue "(^|[[:space:]])#.*$" -## Trailing whitespace +# Trailing whitespace. color ,green "[[:space:]]+$" diff --git a/doc/syntax/c.nanorc b/doc/syntax/c.nanorc index b89c9d2..8fe7088 100644 --- a/doc/syntax/c.nanorc +++ b/doc/syntax/c.nanorc @@ -1,8 +1,10 @@ ## Here is an example for C/C++. -## -syntax "c" "\.(c(c|pp|xx)?|C)$" "\.(h(h|pp|xx)?|H)$" "\.ii?$" -color brightred "\<[A-Z_][0-9A-Z_]+\>" -color green "\<(float|double|bool|char|int|short|long|sizeof|enum|void|static|const|struct|union|typedef|extern|(un)?signed|inline)\>" + +syntax "c" "\.(c(c|pp|xx|\+\+)?|C)$" "\.(h(h|pp|xx)?|H)$" "\.ii?$" +magic "(ASCII|UTF-8 Unicode) C(\+\+)? program text" + +color brightred "\<[A-Z_][0-9A-Z_]+\>" +color green "\<(float|double|bool|char|int|short|long|sizeof|enum|void|auto|static|const|struct|union|typedef|extern|(un)?signed|inline)\>" color green "\<((s?size)|((u_?)?int(8|16|32|64|ptr)))_t\>" color green "\<(class|namespace|template|public|protected|private|typename|this|friend|virtual|using|mutable|volatile|register|explicit)\>" color brightyellow "\<(for|if|while|do|else|case|default|switch)\>" @@ -10,21 +12,22 @@ color brightyellow "\<(try|throw|catch|operator|new|delete)\>" color magenta "\<(goto|continue|break|return)\>" color brightcyan "^[[:space:]]*#[[:space:]]*(define|include(_next)?|(un|ifn?)def|endif|el(if|se)|if|warning|error|pragma)" color brightmagenta "'([^'\]|(\\["'abfnrtv\\]))'" "'\\(([0-3]?[0-7]{1,2}))'" "'\\x[0-9A-Fa-f]{1,2}'" -## -## GCC builtins + +# GCC builtins. color cyan "__attribute__[[:space:]]*\(\([^)]*\)\)" "__(aligned|asm|builtin|hidden|inline|packed|restrict|section|typeof|weak)__" -## -## String highlighting. You will in general want your comments and -## strings to come last, because syntax highlighting rules will be -## applied in the order they are read in. + +# Strings. In general you will want your strings and comments to come last, +# because highlighting rules are applied in the order they are read in. color brightyellow "<[^= ]*>" ""(\\.|[^"])*"" -## -## This string is VERY resource intensive! +# Multiline strings. This regex is VERY resource intensive! color brightyellow start=""(\\.|[^"])*\\[[:space:]]*$" end="^(\\.|[^"])*"" -## Comment highlighting +# Comments. color brightblue "//.*" color brightblue start="/\*" end="\*/" -## Trailing whitespace +# Reminders. +color ,yellow "(FIXME|TODO|XXX)" + +# Trailing whitespace. color ,green "[[:space:]]+$" diff --git a/doc/syntax/changelog.nanorc b/doc/syntax/changelog.nanorc new file mode 100644 index 0000000..60666bd --- /dev/null +++ b/doc/syntax/changelog.nanorc @@ -0,0 +1,25 @@ +## Colouring for Changelogs. + +syntax "changelog" "Change[Ll]og.*" + +# Author lines. +color green "^(19|20).*$" +# Dates. +color red "^(19|20)[0-9-]{8}" +# Email addresses. +color yellow "<[^>]*@[^>]*>" + +# Changed files. +color magenta "[[:space:]]\*[[:space:]].*:" + +# Command-line options. +color cyan "[[:space:]]-[a-zA-Z\$]" "--[8a-z-]+" +# Bug numbers. +color cyan "bug #[0-9]{5}" +# Probable variables, for variety. +color brightred "\<[A-Z_][0-9A-Z_]+\>" +# Key sequences. +color brightblue "\^[A-Z]" "\<M-." "\<F1?[0-9]" "(\^|M-)Space" + +# Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/cmake.nanorc b/doc/syntax/cmake.nanorc index 3c52f7d..dc43702 100644 --- a/doc/syntax/cmake.nanorc +++ b/doc/syntax/cmake.nanorc @@ -1,5 +1,5 @@ -## CMake syntax highlighter for GNU Nano -## +## Syntax highlighting for CMake files. + syntax "cmake" "(CMakeLists\.txt|\.cmake)$" icolor green "^[[:space:]]*[A-Z0-9_]+" diff --git a/doc/syntax/css.nanorc b/doc/syntax/css.nanorc index 98eea18..a806d7c 100644 --- a/doc/syntax/css.nanorc +++ b/doc/syntax/css.nanorc @@ -1,6 +1,7 @@ -## Here is an example for css files. -## +## Here is an example for CSS files. + syntax "css" "\.css$" + color brightred "." color brightyellow start="\{" end="\}" color brightwhite start=":" end="([;^\{]|$)" diff --git a/doc/syntax/debian.nanorc b/doc/syntax/debian.nanorc index a945dee..630b4d0 100644 --- a/doc/syntax/debian.nanorc +++ b/doc/syntax/debian.nanorc @@ -1,20 +1,19 @@ -## Here is an exmaple for apt's sources.list -## Adapted from http://milianw.de/blog/Syntax-Highlighting-in-Nano -## (mail@milianw.de). -## -syntax "apt/sources.list" "sources\.list(\.old|~)?$" -# component -color brightmagenta "^deb(-src)? ((http|file|ftp):/[^ ]+|cdrom:\[[^\]]+\]/|cdrom:\[[-a-zA-Z0-9\._\(\) ]+\]/) [^ ]+ .+$" -# distribution -color brightred "^deb(-src)? ((http|file|ftp):/[^ ]+|cdrom:\[[^\]]+\]/|cdrom:\[[-a-zA-Z0-9\._\(\) ]+\]/) [^ ]+" -# URI -color brightgreen "(http|file|ftp):/[^ ]+" -# cdroms -# [^\]] does not work... +## Here is an example for apt's sources.list. + +syntax "apt/sources.list" "sources\.list(\.old|~)?$" "apt/sources\.list\.d/.*\.list$" + +# Coloring the deb lines, working from tail to head. First the +# components -- well, everything, and thus also the components. +color brightmagenta "^deb.*" +# Distribution -- well, everything, except the components. +color brightred "^deb(-src)? ((http(s)?|ftp|rsh|ssh|file|copy|tor|spacewalk):/[^ ]+|cdrom:\[[-a-zA-Z0-9\._\(\) ]+\]/) [^ ]+" +# URIs. +color brightgreen "(http(s)?|ftp|rsh|ssh|file|copy|tor|spacewalk):/[^ ]+" +# CDroms. color brightgreen "cdrom:\[[-a-zA-Z0-9\._\(\) ]+\]/" -# deb / deb-src -color yellow "^deb" -color yellow "^deb-src" -# comments +# And finally the initial deb tag. +color yellow "^deb(-src)?" + +# Comments. color brightblue "#.*" diff --git a/doc/syntax/default.nanorc b/doc/syntax/default.nanorc new file mode 100644 index 0000000..34ff29b --- /dev/null +++ b/doc/syntax/default.nanorc @@ -0,0 +1,10 @@ +## A default syntax, which is used +## for files that do not match any other syntax. + +syntax "default" + +# Spaces in front of tabs. +color ,red " + +" + +# Nano's name, including version. +color brightred "(GNU )?nano [1-9]\.[0-9]\.[^[:space:][:punct:]]+" diff --git a/doc/syntax/fortran.nanorc b/doc/syntax/fortran.nanorc index cc0c726..45873ac 100644 --- a/doc/syntax/fortran.nanorc +++ b/doc/syntax/fortran.nanorc @@ -1,9 +1,8 @@ -## Here is an example for Fortran 90/95 +## Here is an example for Fortran 90/95. -syntax "fortran" "\.(f|f90|f95)$" +syntax "fortran" "\.(f|f90|f95)$" -#color red "\<[A-Z_]a[0-9A-Z_]+\>" -color red "\<[0-9]+\>" +color red "\<[0-9]+\>" icolor green "\<(action|advance|all|allocatable|allocated|any|apostrophe)\>" icolor green "\<(append|asis|assign|assignment|associated|character|common)\>" @@ -15,16 +14,16 @@ icolor green "\<(operator|optional|pack|parameter|pointer|position|private)\>" icolor green "\<(program|public|real|recl|recursive|selected_int_kind)\>" icolor green "\<(selected_real_kind|subroutine|status)\>" -icolor cyan "\<(abs|achar|adjustl|adjustr|allocate|bit_size|call|char)\>" -icolor cyan "\<(close|contains|count|cpu_time|cshift|date_and_time)\>" -icolor cyan "\<(deallocate|digits|dot_product|eor|eoshift|function|iachar)\>" -icolor cyan "\<(iand|ibclr|ibits|ibset|ichar|ieor|iolength|ior|ishft|ishftc)\>" -icolor cyan "\<(lbound|len|len_trim|matmul|maxexponent|maxloc|maxval|merge)\>" -icolor cyan "\<(minexponent|minloc|minval|mvbits|namelist|nearest|nullify)\>" -icolor cyan "\<(open|pad|present|print|product|pure|quote|radix)\>" -icolor cyan "\<(random_number|random_seed|range|read|readwrite|replace)\>" -icolor cyan "\<(reshape|rewind|save|scan|sequence|shape|sign|size|spacing)\>" -icolor cyan "\<(spread|sum|system_clock|target|transfer|transpose|trim)\>" +icolor cyan "\<(abs|achar|adjustl|adjustr|allocate|bit_size|call|char)\>" +icolor cyan "\<(close|contains|count|cpu_time|cshift|date_and_time)\>" +icolor cyan "\<(deallocate|digits|dot_product|eor|eoshift|function|iachar)\>" +icolor cyan "\<(iand|ibclr|ibits|ibset|ichar|ieor|iolength|ior|ishft|ishftc)\>" +icolor cyan "\<(lbound|len|len_trim|matmul|maxexponent|maxloc|maxval|merge)\>" +icolor cyan "\<(minexponent|minloc|minval|mvbits|namelist|nearest|nullify)\>" +icolor cyan "\<(open|pad|present|print|product|pure|quote|radix)\>" +icolor cyan "\<(random_number|random_seed|range|read|readwrite|replace)\>" +icolor cyan "\<(reshape|rewind|save|scan|sequence|shape|sign|size|spacing)\>" +icolor cyan "\<(spread|sum|system_clock|target|transfer|transpose|trim)\>" icolor cyan "\<(ubound|unpack|verify|write|tiny|type|use|yes)\>" icolor yellow "\<(.and.|case|do|else|else?if|else?where|end|end?do|end?if)\>" @@ -33,9 +32,8 @@ icolor yellow "\<(.or.|repeat|select case|then|where|while)\>" icolor magenta "\<(continue|cycle|exit|go?to|result|return)\>" -## String highlighting. +# Strings. icolor yellow "<[^= ]*>" ""(\\.|[^"])*"" -## Comment highlighting +# Comments. icolor blue "!.*" - diff --git a/doc/syntax/gentoo.nanorc b/doc/syntax/gentoo.nanorc index 2ad1597..249e224 100644 --- a/doc/syntax/gentoo.nanorc +++ b/doc/syntax/gentoo.nanorc @@ -1,31 +1,41 @@ -## Here is an example for Gentoo ebuilds/eclasses -## +## Here is an example for Gentoo ebuilds/eclasses. + syntax "ebuild" "\.e(build|class)$" + ## All the standard portage functions -color brightgreen "^src_(unpack|prepare|configure|compile|install|test)" "^pkg_(config|nofetch|setup|(pre|post)(inst|rm))" +color brightgreen "(^|\<default_)src_(unpack|prepare|configure|compile|install|test)\>" +color brightgreen "^pkg_(config|nofetch|info|pretend|setup|(pre|post)(inst|rm))\>" +color brightgreen "\<default(_pkg_nofetch|_src_(unpack|prepare|configure|compile|test))?\>" ## Highlight bash related syntax -color green "\<(case|do|done|elif|else|esac|exit|fi|for|function|if|in|local|read|return|select|shift|then|time|until|while|continue|break)\>" -color green "\<(declare|eval|exec|let)\>" -color green "(\{|\}|\(|\)|\;|\]|\[|`|\\|\$|<|>|!|=|&|\|)" -color green "-[edfgruwxL]\>" -color green "-(eq|ne|gt|lt|ge|le|s|n|z)\>" +color green "\<(break|case|continue|do|done|elif|else|esac|exit|fi|for|function|if|in|read|return|select|shift|then|time|until|while)\>" +color green "\<(declare|eval|exec|export|let|local)\>" +color green "[{}():;|`$<>!=&\\]" "(\]|\[)" +color green "-[defhnrsuwxzL]\>" +color green "-(eq|ne|gt|lt|ge|le)\>" ## Highlight variables ... official portage ones in red, all others in bright red -color brightred "\$\{?[a-zA-Z_0-9]+\}?" -color red "\<(EAPI|ARCH|HOMEPAGE|DESCRIPTION|IUSE|SRC_URI|LICENSE|SLOT|KEYWORDS|(P|R)?DEPEND|PROVIDE|PROPERTIES|RESTRICT|USERLAND)\>" -color red "\<(S|D|T|PV|PF|P|PN|PR|PVR|A|CATEGORY|DISTDIR|FILESDIR|ROOT|WORKDIR)\>" "\<(AS|C(PP|XX)?|LD)FLAGS\>" "\<C(HOST|TARGET|BUILD)\>" -color red "\<QA_((TEXTRELS|EXECSTACK|WX_LOAD)(_[a-zA-Z_0-9]+)?|DT_HASH|PRESTRIPPED)\>" "\<WANT_AUTO(CONF|MAKE)\>" "\<AT_M4DIR\>" +color brightred "\$[-0-9@*#?$!]" "\$[[:alpha:]_][[:alnum:]_]*" +color brightred "\$\{[#!]?([-@*#?$!]|[0-9]+|[[:alpha:]_][[:alnum:]_]*)(\[([[:digit:]]|@)+\])?(([#%/]|:?[-=?+])[^}]*\}|\[|\})" +color red "\<(EAPI|ARCH|HOMEPAGE|DESCRIPTION|IUSE|SRC_URI|LICENSE|SLOT|KEYWORDS|[HPR]?DEPEND|PROVIDE|PROPERTIES|REQUIRED_USE|RESTRICT|USERLAND)\>" +color red "\<(S|E?D|T|PV|PF|P|PN|PR|PVR|A|CATEGORY|DISTDIR|FILESDIR|EPREFIX|E?ROOT|WORKDIR)\>" +color red "\<(AS|C(PP|XX)?|LD)FLAGS\>" "\<C(HOST|TARGET|BUILD)\>" "\<(MERGE_TYPE|REPLACING_VERSIONS|REPLACED_BY_VERSION)\>" +color red "\<EBUILD_PHASE(_FUNC)?\>" +color red "\<QA_((TEXTRELS|EXECSTACK|WX_LOAD)(_[a-zA-Z_0-9]+)?|DT_HASH|PRESTRIPPED)\>" +color red "\<(PATCHES|(HTML_)?DOCS)\>" "\<WANT_(AUTO(CONF|MAKE)|LIBTOOL)\>" "\<AT_M4DIR\>" ## Highlight portage commands -color magenta "\<use(_(with|enable))?\> [!a-zA-Z0-9_+ -]*" "inherit.*" -color brightblue "\<e(begin|end|conf|install|make|qmake[34]|ant|(qa)?warn|infon?|error|log|patch|new(group|user))\>" -color brightblue "\<e(pause|beep|mktemp|(cvs|svn)_clean|punt_cxx)\>" "\<e(aclocal|auto(reconf|header|conf|make))\>" -color brightblue "\<built_with_use\>" "\<make_desktop_entry\>" "\<unpack(_(makeself|pdv))?\>" -color brightblue "\<die\>" "\<use(_(with|enable))?\>" "\<inherit\>" "\<has\>" "\<(has|best)_version\>" +color magenta "\<(use(_(with|enable|if_iuse)|x)?|in_iuse)\> [!a-zA-Z0-9_+ -]*" "inherit.*" +color brightblue "\<e(begin|end|conf|install|make|qmake4|ant|(qa)?warn|infon?|error|log|patch(_user)?|new(group|user))\>" +color brightblue "\<e(pause|beep|mktemp|(cvs|svn)_clean|punt_cxx)\>" "\<e(aclocal|auto(reconf|header|conf|make)|libtoolize)\>" +color brightblue "\<e(stack|shopts|umask)_(push|pop)\>" "\<version_is_at_least\>" +color brightblue "\<make_desktop_entry\>" "\<unpack(_(makeself|pdv))?\>" +color brightblue "\<(die|hasv?|inherit|nonfatal)\>" "\<(use(_(with|enable|if_iuse)|x)?|in_iuse)\>" "\<(has|best)_version\>" color brightblue "\<(do|new)(ins|(games)?s?bin|doc|lib(\.so|\.a)?|man|info|exe|initd|confd|envd|pam|menu|icon)\>" -color brightblue "\<do(python|sed|dir|hard|sym|html|jar|mo)\>" "\<keepdir\>" -color brightblue "prepall(docs|info|man|strip)?" "prep(info|lib|lib\.(so|a)|man|strip|gamesdirs)" +color brightblue "\<do(compress|header|python|sed|dir|hard|sym|html|jar|mo)\>" "\<keepdir\>" +color brightblue "\<prepall(docs|info|man|strip)?\>" "\<prep(info|lib|lib\.(so|a)|man|strip|gamesdirs)\>" color brightblue "\<(doc|ins|exe)?into\>" "\<(f|games)(owners|perms)\>" "\<(exe|ins|dir)opts\>" +color brightblue "\<tc-get(BUILD_)?(AR|AS|CC|CPP|CXX|LD|NM|OBJCOPY|PKG_CONFIG|RANLIB)\>" +color brightblue "\<tc-(arch(-kernel)?|export|has-(tls|openmp))\>" ## Highlight common commands used in ebuilds -color blue "\<make\>" "\<(awk|cat|cd|chmod|chown|cp|echo|env|export|find|e?grep|ln|mkdir|mv|rm|sed|set|tar|touch|unset|xargs)\>" +color blue "\<(awk|cat|cd|chmod|chown|cp|echo|env|find|e?grep|ln|make|mkdir|mv|popd|printf|pushd|rm|rmdir|sed|set|tar|touch|unset|xargs)\>" ## Highlight comments (doesnt work that well) color yellow "(^|[[:space:]])#.*$" ## Highlight strings (doesnt work that well) @@ -33,9 +43,9 @@ color brightyellow ""(\\.|[^\"])*"" "'(\\.|[^'])*'" ## Trailing space is bad! color ,green "[[:space:]]+$" -## Here is an example for Portage control files +## Here is an example for Portage control files. ## -syntax "/etc/portage" "\.(keywords|mask|unmask|use)(/.+)?$" +syntax "/etc/portage" "\.(accept_keywords|env|keywords|mask|unmask|use)(/.+)?$" ## Base text: color green "^.+$" ## Use flags: @@ -53,3 +63,5 @@ color cyan "^[[:space:]]*.*/" color brightmagenta "^[[:space:]]*(=|~|<|<=|=<|>|>=|=>)" ## Comments: color yellow "#.*$" +## Trailing space is bad! +color ,green "[[:space:]]+$" diff --git a/doc/syntax/go.nanorc b/doc/syntax/go.nanorc new file mode 100644 index 0000000..0b62334 --- /dev/null +++ b/doc/syntax/go.nanorc @@ -0,0 +1,45 @@ +## Here is an example for Go. + +syntax "go" "\.go$" + +# Types. +color green "\<(bool|u?int(8|16|32|64)?|float(32|64)|complex(64|128)|byte|rune|uintptr|string|error)\>" +color green "\<((<-[[:space:]]*)chan|chan[[:space:]]*<-|const|func|interface|map|struct|type|var)\>" + +# Predefined functions. +color blue "\<(append|cap|close|complex|copy|delete|imag|len|make|new|panic|print|println|real|recover)\>" + +# Control structures. +color brightyellow "\<(case|default|defer|else|for|go|if|range|select|switch)\>" + +# Control flow. +color magenta "\<(break|continue|fallthrough|goto|return)\>" + +# Declarations. +color brightcyan "\<(package|import)\>" +color brightcyan "//[[:space:]]*\+build[[:space:]]+(([a-zA-Z_0-9]+[[:space:]]*)+,[[:space:]]*)*[a-zA-Z_0-9]+" + +# Literals. +color red "\<[0-9]+\.[0-9]*([Ee][+-][0-9]+)?i?\>" +color red "\<[0-9]+[Ee][+-][0-9]+i?\>" +color red "\<\.[0-9]+([Ee][+-][0-9]+)?i?\>" +color red "\<[0-9]+i\>" +color red "\<[1-9][0-9]*\>" +color red "\<0[0-7]*\>" +icolor red "\<0x[0-9a-f]+\>" + +# Strings and characters; slightly fuzzy. +color red "\<(true|false|nil|iota|_)\>" +color red "'(\\.|[^'])+'" +color red ""(\\.|[^"])*"" +color red start=""(\\.|[^"])*\\[[:space:]]*$" end="^(\\.|[^"])*"" + +# Comments. +color brightblue "//.*" +color brightblue start="/\*" end="\*/" + +# Trailing whitespace. +color ,green "[[:space:]]+$" + +# Set up the formatter since spelling is probably useless... +formatter gofmt -w diff --git a/doc/syntax/groff.nanorc b/doc/syntax/groff.nanorc index 02b82b8..70f641d 100644 --- a/doc/syntax/groff.nanorc +++ b/doc/syntax/groff.nanorc @@ -1,24 +1,25 @@ ## Here is an example for groff. -## + syntax "groff" "\.m[ems]$" "\.rof" "\.tmac$" "^tmac." -## The argument of .ds or .nr + +# The argument of .ds or .nr color cyan "^\.(ds|nr) [^[[:space:]]]*" -## Single character escapes +# Single-character escapes color brightmagenta "\\." -## Highlight the argument of \f or \s in the same color +# The argument of \f or \s in the same color color brightmagenta "\\f." "\\f\(.." "\\s(\+|\-)?[0-9]" -## Newlines +# Newlines color cyan "(\\|\\\\)n(.|\(..)" color cyan start="(\\|\\\\)n\[" end="]" -## Requests +# Requests color brightgreen "^\.[[:space:]]*[^[[:space:]]]*" -## Comments +# Comments color yellow "^\.\\".*$" -## Strings +# Strings color green "(\\|\\\\)\*(.|\(..)" color green start="(\\|\\\\)\*\[" end="]" -## Characters +# Characters color brightred "\\\(.." color brightred start="\\\[" end="]" -## Macro arguments +# Macro arguments color brightcyan "\\\\\$[1-9]" diff --git a/doc/syntax/html.nanorc b/doc/syntax/html.nanorc index d31467d..8782dc3 100644 --- a/doc/syntax/html.nanorc +++ b/doc/syntax/html.nanorc @@ -1,5 +1,8 @@ ## Here is a short example for HTML. -## -syntax "html" "\.html$" -color blue start="<" end=">" -color red "&[^;[[:space:]]]*;" + +syntax "html" "\.html?$" +magic "HTML document text" + +color cyan start="<" end=">" +color red "&[^;[:space:]]*;" +color green ""(\\.|[^"])*"" diff --git a/doc/syntax/java.nanorc b/doc/syntax/java.nanorc index a432f81..829c8af 100644 --- a/doc/syntax/java.nanorc +++ b/doc/syntax/java.nanorc @@ -1,9 +1,12 @@ ## Here is an example for Java. -## + syntax "java" "\.java$" +magic "Java " + color green "\<(boolean|byte|char|double|float|int|long|new|short|this|transient|void)\>" color red "\<(break|case|catch|continue|default|do|else|finally|for|if|return|switch|throw|try|while)\>" -color cyan "\<(abstract|class|extends|final|implements|import|instanceof|interface|native|package|private|protected|public|static|strictfp|super|synchronized|throws|volatile)\>" +color cyan "\<(abstract|class|extends|final|implements|import|instanceof|interface|native)\>" +color cyan "\<(package|private|protected|public|static|strictfp|super|synchronized|throws|volatile)\>" color red ""[^"]*"" color yellow "\<(true|false|null)\>" color blue "//.*" diff --git a/doc/syntax/javascript.nanorc b/doc/syntax/javascript.nanorc new file mode 100644 index 0000000..991f54b --- /dev/null +++ b/doc/syntax/javascript.nanorc @@ -0,0 +1,19 @@ +## Here is an example for Javascript. + +syntax "javascript" "\.js$" + +color brightred "\<[A-Z_][0-9A-Z_]+\>" +color green "\<(const|function|let|this|typeof|var|void)\>" +color brightyellow "\<(for|if|while|with|do|else|case|default|switch)\>" +color brightyellow "\<(export|try|throw|catch|new|delete)\>" +color magenta "\<(continue|break|return|yield)\>" +color brightmagenta "'([^'\]|(\\["'abfnrtv\\]))'" "'\\(([0-3]?[0-7]{1,2}))'" "'\\x[0-9A-Fa-f]{1,2}'" + +# Strings. +color brightyellow "<[^= ]*>" ""(\\.|[^"])*"" "'(\\.|[^'])*'" +# Comments. +color brightblue "//.*" +color brightblue start="/\*" end="\*/" + +# Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/json.nanorc b/doc/syntax/json.nanorc new file mode 100644 index 0000000..0f799f1 --- /dev/null +++ b/doc/syntax/json.nanorc @@ -0,0 +1,32 @@ +## Syntax highlighting for JSON files. + +# See: http://www.json.org/ +# Original author: Aapo Rantalainen +# License: GPLv3 or newer + +syntax "json" "\.json$" + +# Numbers (used as value). +color green ":[[:space:]]*\-?(0|[1-9][0-9]*)(\.[0-9]+)?([Ee]?[-+]?[0-9]+)?" +# Values (well, any string). +color brightmagenta "\".+\"" +# Hex numbers (used as value). +color green ":[[:space:]]*\"#[0-9abcdefABCDEF]+\"" +# Escapes. +color green "\\\\" "\\\"" "\\[bfnrt]" "\\u[0-9abcdefABCDEF]{4})" +# Special words. +color green "(true|false|null)" + +# Names (very unlikely to contain a quote). +color brightblue "\"[^"]+\"[[:space:]]*:" + +# Brackets, braces, and separators. +color brightblue "\[" "\]" +color brightred "\{" "\}" +color brightred "," ":" + +# Comments. +color cyan "(^|[[:space:]]+)(//|#).*$" + +# Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/lua.nanorc b/doc/syntax/lua.nanorc new file mode 100644 index 0000000..3dbbea8 --- /dev/null +++ b/doc/syntax/lua.nanorc @@ -0,0 +1,62 @@ +## Syntax highlighting for Lua. +# +## Author: Matthew Wild <mwild1 (at) gmail.com> +## License: GPL 3 or later +## Version: 2011-05-05 + +syntax "lua" "\.lua$" + +color brightwhite "\[\[.*\]\]" + +# Operators +color brightyellow ":|\*|/|%|\+|-|\^|>|>=|<|<=|~=|=|\.\.|\<(not|and|or)\>" + +# Statements +color brightblue "\<(do|end|while|repeat|until|if|elseif|then|else|for|in|function|local|return|break)\>" + +# Keywords +color brightyellow "\<(io|math|os|string|table|coroutine|debug)\>\." +color brightyellow "\<(_G|_VERSION|assert|collectgarbage|dofile|error|getfenv|getmetatable|ipairs|load|loadfile|module|next|pairs|pcall|print|rawequal|rawget|rawset|require|select|setfenv|setmetatable|tonumber|tostring|type|unpack|xpcall)\s*\(" + +# Standard library +color brightyellow "io\.\<(close|flush|input|lines|open|output|popen|read|tmpfile|type|write|stdin|stdout|stderr)\>" +color brightyellow "math\.\<(abs|acos|asin|atan2|atan|ceil|cosh|cos|deg|exp|floor|fmod|frexp|huge|ldexp|log10|log)\>" +color brightyellow "math\.\<(max|min|mod|modf|pi|pow|rad|random|randomseed|sinh|tan)\>" +color brightyellow "os\.\<(clock|date|difftime|execute|exit|getenv|remove|rename|setlocale|time|tmpname)\>" +color brightyellow "package\.\<(cpath|loaded|loadlib|path|preload|seeall)\>" +color brightyellow "string\.\<(byte|char|dump|find|format|gmatch|gsub|len|lower|match|rep|reverse|sub|upper)\>" +color brightyellow "table\.\<(concat|insert|maxn|remove|sort)\>" +color brightyellow "coroutine\.\<(create|resume|running|status|wrap|yield)\>" +color brightyellow "debug\.\<(debug|getfenv|gethook|getinfo|getlocal|getmetatable|getregistry|getupvalue)\>" +color brightyellow "debug\.\<(setfenv|sethook|setlocal|setmetatable|setupvalue|traceback)\>" + +# File handle methods +color brightyellow "\:\<(close|flush|lines|read|seek|setvbuf|write)\>" + +# false, nil, true +color brightmagenta "\<(false|nil|true)\>" + +# External files +color brightgreen "\<(dofile|require)\>" + +# Numbers +color red "\<([0-9]+)\>" + +# Symbols +color brightmagenta "(\(|\)|\[|\]|\{|\})" + +# Shebang +color brightcyan "^#!.*" + +# Simple comments +color green "\-\-.*$" + +# Multiline comments +color green start="\-\-\[\[" end="\]\]" + +# Strings +color red "\"(\\.|[^\\\"])*\"|'(\\.|[^\\'])*'" +##color red start="\[\[" end="\]\]" + +# Hex literals +color red "0x[0-9a-fA-F]*" diff --git a/doc/syntax/makefile.nanorc b/doc/syntax/makefile.nanorc index 93a1e76..0416390 100644 --- a/doc/syntax/makefile.nanorc +++ b/doc/syntax/makefile.nanorc @@ -1,8 +1,12 @@ -# unattributed syntax highlighting example from wiki.linuxhelp.net/ +## Here is an example for Makefiles. syntax "makefile" "Makefile[^/]*$" + color red "[:=]" color magenta "\<(if|ifeq|else|endif)\>" color blue "\$+[{(][a-zA-Z0-9_-]+[})]" color brightblue "^[^ ]+:" color green "#.*$" + +## Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/man.nanorc b/doc/syntax/man.nanorc index 85efd26..6c296bb 100644 --- a/doc/syntax/man.nanorc +++ b/doc/syntax/man.nanorc @@ -1,9 +1,17 @@ ## Here is an example for manpages. -## + syntax "man" "\.[1-9]x?$" -color green "\.(S|T)H.*$" -color brightgreen "\.(S|T)H" "\.TP" -color brightred "\.(BR?|I[PR]?).*$" -color brightblue "\.(BR?|I[PR]?|PP)" -color brightwhite "\\f[BIPR]" -color yellow "\.(br|DS|RS|RE|PD)" +magic "troff or preprocessor input text" + +color green "\.(SH|SS|TH) .*$" +color brightgreen "\.(SH|SS|TH) " "\.([HIT]P)" +color brightred "\.(B[IR]?|I[BR]?|R[BI]|S[BM]) .*$" +color brightblue "\.(B[IR]?|I[BR]?|R[BI]|S[BM]) " "\.([LP]?P)$" +color magenta "\\f[BIPR]" +color yellow "\.(br|DT|RS|RE|PD)" + +# Comments. +color cyan "\.?\\\".*$" + +# Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/mgp.nanorc b/doc/syntax/mgp.nanorc index daba282..c0a5d20 100644 --- a/doc/syntax/mgp.nanorc +++ b/doc/syntax/mgp.nanorc @@ -1,7 +1,8 @@ -## Here is an example for Magicpoint presentations -## +## Here is an example for Magicpoint presentations. + syntax "mgp" "\.mgp$" header "^%include.*" + icolor green "^%[a-z].*$" color cyan "(^|[[:space:]])#.*$" color cyan "(^|[[:space:]])%%.*$" diff --git a/doc/syntax/mutt.nanorc b/doc/syntax/mutt.nanorc index 2e68399..80fbcf4 100644 --- a/doc/syntax/mutt.nanorc +++ b/doc/syntax/mutt.nanorc @@ -1,4 +1,9 @@ ## Here is an example for quoted emails (under e.g. mutt). -## + syntax "mutt" + +# Quoted lines. color green "^>.*" + +# Signatures, even quoted ones. +color yellow start="^>* ?-- $" end="^>* ?$" diff --git a/doc/syntax/nanorc.nanorc b/doc/syntax/nanorc.nanorc index 19ab533..1858f2b 100644 --- a/doc/syntax/nanorc.nanorc +++ b/doc/syntax/nanorc.nanorc @@ -1,16 +1,28 @@ ## Here is an example for nanorc files. -## + syntax "nanorc" "\.?nanorc$" -## Possible errors and parameters -icolor brightwhite "^[[:space:]]*((un)?set|include|syntax|i?color).*$" -## Keywords -icolor brightgreen "^[[:space:]]*(set|unset)[[:space:]]+(allow_insecure_backup|autoindent|backup|backupdir|backwards|boldtext|brackets|casesensitive|const|cut|fill|historylog|matchbrackets|morespace|mouse|multibuffer|noconvert|nofollow|nohelp|nonewlines|nowrap|operatingdir|preserve|punct)\>" "^[[:space:]]*(set|unset)[[:space:]]+(quickblank|quotestr|rebinddelete|rebindkeypad|regexp|smarthome|smooth|softwrap|speller|suspend|suspendenable|tabsize|tabstospaces|tempfile|undo|view|whitespace|wordbounds)\>" -icolor green "^[[:space:]]*(set|unset|include|syntax|header)\>" -## Colors + +# Possible errors and parameters +icolor brightred "^[[:space:]]*((un)?(bind|set)|include|syntax|header|magic|linter|i?color|extendsyntax).*$" + +# Keywords +icolor brightgreen "^[[:space:]]*(set|unset)[[:space:]]+(allow_insecure_backup|autoindent|backup|backwards|boldtext|casesensitive|const|cut|fill|historylog|locking|morespace|mouse|multibuffer|noconvert|nofollow|nohelp|nonewlines|nowrap|poslog|preserve|quickblank|quiet|rebinddelete|rebindkeypad|regexp|smarthome|smooth|softwrap|suspend|tabsize|tabstospaces|tempfile|view|wordbounds)\>" +icolor yellow "^[[:space:]]*set[[:space:]]+(functioncolor|keycolor|statuscolor|titlecolor)[[:space:]]+(bright)?(white|black|red|blue|green|yellow|magenta|cyan)?(,(white|black|red|blue|green|yellow|magenta|cyan))?\>" +icolor brightgreen "^[[:space:]]*set[[:space:]]+(backupdir|brackets|functioncolor|keycolor|matchbrackets|operatingdir|punct|quotestr|speller|statuscolor|titlecolor|whitespace)[[:space:]]+" +icolor brightgreen "^[[:space:]]*bind[[:space:]]+((\^|M-)([[:alpha:]]|space|[]]|[0-9_=+{}|;:'\",./<>\?-])|F([1-9]|1[0-6])|Ins|Del)[[:space:]]+[[:alpha:]]+[[:space:]]+[[:alpha:]]+[[:space:]]*$" +icolor brightgreen "^[[:space:]]*unbind[[:space:]]+((\^|M-)([[:alpha:]]|space|[]]|[0-9_=+{}|;:'\",./<>\?-])|F([1-9]|1[0-6])|Ins|Del)[[:space:]]+[[:alpha:]]+[[:space:]]*$" +icolor brightgreen "^[[:space:]]*extendsyntax[[:space:]]+[[:alpha:]]+[[:space:]]+(i?color|header|magic|linter|formatter)[[:space:]]+.*$" +icolor green "^[[:space:]]*((un)?(bind|set)|include|syntax|header|magic|linter|extendsyntax)\>" + +# Colors icolor yellow "^[[:space:]]*i?color[[:space:]]*(bright)?(white|black|red|blue|green|yellow|magenta|cyan)?(,(white|black|red|blue|green|yellow|magenta|cyan))?\>" icolor magenta "^[[:space:]]*i?color\>" "\<(start|end)=" -## Strings -icolor white ""(\\.|[^"])*"" -## Comments + +# Strings +icolor brightmagenta ""(\\.|[^"])*"" +# Comments icolor brightblue "^[[:space:]]*#.*$" icolor cyan "^[[:space:]]*##.*$" + +# Trailing whitespace +color ,green "[[:space:]]+$" diff --git a/doc/syntax/objc.nanorc b/doc/syntax/objc.nanorc index cdf6e48..bfbae12 100644 --- a/doc/syntax/objc.nanorc +++ b/doc/syntax/objc.nanorc @@ -1,10 +1,9 @@ ## Here is an example for C/C++/Obj-C. -## -syntax "m" "\.m$" +syntax "m" "\.m$" -## Stuffs -color brightwhite "\<[A-Z_][0-9A-Z_]+\>" +# Stuffs, +color brightwhite "\<[A-Z_][0-9A-Z_]+\>" color green "\<(float|double|BOOL|bool|char|int|short|long|id|sizeof|enum|void|static|const|struct|union|typedef|extern|(un)?signed|inline)\>" color green "\<[[:alpha:]_][[:alnum:]_]*_t\>" color green "\<(class|namespace|template|public|protected|private|typename|this|friend|virtual|using|mutable|volatile|register|explicit)\>" @@ -12,30 +11,29 @@ color brightgreen "\<(for|if|while|do|else|case|default|switch)\>" color brightgreen "\<(try|throw|catch|operator|new|delete)\>" color brightgreen "\<(goto|continue|break|return)\>" color brightgreen "@\<(en(code|d)|i(mplementation|nterface)|selector)\>" -## -## GCC builtins + +# GCC builtins. color cyan "__attribute__[[:space:]]*\(\([^)]*\)\)" "__(aligned|asm|builtin|hidden|inline|packed|restrict|section|typeof|weak)__" -## Selector/method +# Selector/method. color brightmagenta "(^|[[:space:]])\[.*[[:space:]].*\]" color white ":[[:alnum:]]*" color magenta "[[:alnum:]]*:" color white "\[[^][:space:]]*\]" -## -## String highlighting. You will in general want your comments and -## strings to come last, because syntax highlighting rules will be -## applied in the order they are read in. +# Strings. color brightblack "'([^'\]|(\\["'abfnrtv\\]))'" "'\\(([0-3]?[0-7]{1,2}))'" "'\\x[0-9A-Fa-f]{1,2}'" color brightblack "<[^= ]*>" ""(\\.|[^"])*"" color brightblue "@"(\\.|[^"])*"" -## -## This string is VERY resource intensive! +# Multiline strings. This regex is VERY resource intensive! ## color brightyellow start=""(\\.|[^"])*\\[[:space:]]*$" end="^(\\.|[^"])*"" +# Preprocessor commands. color brightblue "^[[:space:]]*#[[:space:]]*(define|include|import|(un|ifn?)def|endif|el(if|se)|if|warning|error)" -## Comment highlighting +# Comments. color yellow "//.*" color yellow start="/\*" end="\*/" +# Trailing whitespace.  +color ,green "[[:space:]]+$" diff --git a/doc/syntax/ocaml.nanorc b/doc/syntax/ocaml.nanorc index fc71ae2..8decb72 100644 --- a/doc/syntax/ocaml.nanorc +++ b/doc/syntax/ocaml.nanorc @@ -1,6 +1,7 @@ -# OCaml sample nanorc -# +## Syntax highlighting for OCaml. + syntax "ocaml" "\.mli?$" + #uid color red "\<[A-Z][0-9a-z_]{2,}\>" #declarations @@ -10,7 +11,7 @@ color red "\<(type|open|class|module|exception|external)\>" #patterns color blue "\<(fun|function|functor|match|try|with)\>" #patterns-modifiers -color yellow "\<(as|when|of)\>" +color yellow "\<(as|when|of)\>" #conditions color cyan "\<(if|then|else)\>" #blocs diff --git a/doc/syntax/patch.nanorc b/doc/syntax/patch.nanorc index a788b35..f5c1dd5 100644 --- a/doc/syntax/patch.nanorc +++ b/doc/syntax/patch.nanorc @@ -1,10 +1,21 @@ ## Here is an example for patch files. -## + syntax "patch" "\.(patch|diff)$" +magic "diff output text" + +# Added lines. color brightgreen "^\+.*" -color green "^\+\+\+.*" +# Show trailing whitespace only on added lines. +color ,green "[[:space:]]+$" +# Context lines. color brightblue "^ .*" +# Deleted lines. color brightred "^-.*" + +# File names and dates. color red "^---.*" +color green "^\+\+\+.*" +# Line numbers. color brightyellow "^@@.*" +# Header lines. color magenta "^diff.*" diff --git a/doc/syntax/perl.nanorc b/doc/syntax/perl.nanorc index b5a5606..6a70d3d 100644 --- a/doc/syntax/perl.nanorc +++ b/doc/syntax/perl.nanorc @@ -1,7 +1,9 @@ ## Here is an example for Perl. -## + syntax "perl" "\.p[lm]$" -header "^#!.*/perl[-0-9._]*" +header "^#!.*perl[-0-9._]*" +magic "Perl script text" + color red "\<(accept|alarm|atan2|bin(d|mode)|c(aller|h(dir|mod|op|own|root)|lose(dir)?|onnect|os|rypt)|d(bm(close|open)|efined|elete|ie|o|ump)|e(ach|of|val|x(ec|ists|it|p))|f(cntl|ileno|lock|ork))\>" "\<(get(c|login|peername|pgrp|ppid|priority|pwnam|(host|net|proto|serv)byname|pwuid|grgid|(host|net)byaddr|protobynumber|servbyport)|([gs]et|end)(pw|gr|host|net|proto|serv)ent|getsock(name|opt)|gmtime|goto|grep|hex|index|int|ioctl|join)\>" "\<(keys|kill|last|length|link|listen|local(time)?|log|lstat|m|mkdir|msg(ctl|get|snd|rcv)|next|oct|open(dir)?|ord|pack|pipe|pop|printf?|push|q|qq|qx|rand|re(ad(dir|link)?|cv|do|name|quire|set|turn|verse|winddir)|rindex|rmdir|s|scalar|seek(dir)?)\>" "\<(se(lect|mctl|mget|mop|nd|tpgrp|tpriority|tsockopt)|shift|shm(ctl|get|read|write)|shutdown|sin|sleep|socket(pair)?|sort|spli(ce|t)|sprintf|sqrt|srand|stat|study|substr|symlink|sys(call|read|tem|write)|tell(dir)?|time|tr(y)?|truncate|umask)\>" "\<(un(def|link|pack|shift)|utime|values|vec|wait(pid)?|wantarray|warn|write)\>" color magenta "\<(continue|else|elsif|do|for|foreach|if|unless|until|while|eq|ne|lt|gt|le|ge|cmp|x|my|sub|use|package|can|isa)\>" icolor cyan start="[$@%]" end="( |[^0-9A-Z_]|-)" diff --git a/doc/syntax/php.nanorc b/doc/syntax/php.nanorc index 8ef495f..e3c4f1f 100644 --- a/doc/syntax/php.nanorc +++ b/doc/syntax/php.nanorc @@ -1,30 +1,31 @@ -## Here is an example for PHP -## +## Here is an example for PHP. + syntax "php" "\.php[2345s~]?$" +magic "PHP script text" -## php markings +# PHP markings. color brightgreen "(<\?(php)?|\?>)" -## functions +# Functions. color white "\<[a-z_]*\(" -## types +# Types. color green "\<(var|float|global|double|bool|char|int|enum|const)\>" -## structure +# Structure. color brightyellow "\<(class|new|private|public|function|for|foreach|if|while|do|else|elseif|case|default|switch)\>" -## control flow +# Control flow. color magenta "\<(goto|continue|break|return)\>" -## strings +# Strings. color brightyellow "<[^= ]*>" ""(\.|[^"])*"" -## comments +# Comments. color brightblue "//.*" color brightblue start="/\*" end="\*/" -#color blue start="<" end=">" -#color red "&[^;[[:space:]]]*;" +##color blue start="<" end=">" +##color red "&[^;[[:space:]]]*;" -## Trailing whitespace +# Trailing whitespace. color ,green "[[:space:]]+$" diff --git a/doc/syntax/po.nanorc b/doc/syntax/po.nanorc new file mode 100644 index 0000000..567ef7a --- /dev/null +++ b/doc/syntax/po.nanorc @@ -0,0 +1,27 @@ +## Colouring for PO files. + +syntax "po" "\.pot?$" + +# Comments. +color green "^#.*$" +color yellow "Copyright|\(C\)" +# Header fields. +color brightmagenta "\<(Project\-Id\-Version|Report\-Msgid\-Bugs\-To|Last\-Translator|Language\-Team|Language|X\-Generator|Plural\-Forms)\>" +color cyan "\<(POT\-Creation\-Date|PO\-Revision\-Date|MIME\-Version|Content\-Type|Content\-Transfer\-Encoding)\>" +# Encodings and numbers. +color yellow "\<(UTF|ISO|Windows|Mac|IBM)\>\-[0-9]" +color yellow "[0-9]|pre[0-9]|[0-9]bit" +# Msgids. +color brightblue "\<(msgid|msgid_plural|msgstr)\>" +# Tags. +color red "\<fuzzy\>" +color yellow "\<c-format\>" +# Format specifiers. +color brightmagenta "%([1-9]\$)?[a-z]*" +# Quotes and newlines. +color yellow "\"" +color cyan "\\n" +# Reminders. +color ,yellow "(FIXME|TODO|XXX)" +# Obsolete strings. +color red "#~.*$" diff --git a/doc/syntax/pov.nanorc b/doc/syntax/pov.nanorc index 298b201..b7033b1 100644 --- a/doc/syntax/pov.nanorc +++ b/doc/syntax/pov.nanorc @@ -1,6 +1,7 @@ ## Here is an example for POV-Ray. -## + syntax "pov" "\.(pov|POV|povray|POVRAY)$" + color brightcyan "^[[:space:]]*#[[:space:]]*(declare)" color brightyellow "\<(sphere|cylinder|translate|matrix|rotate|scale)\>" color brightyellow "\<(orthographic|location|up|right|direction|clipped_by)\>" @@ -10,6 +11,7 @@ color brightred "\<(light_source|background)\>" color brightred "\<(fog|object|camera)\>" color green "(\{|\}|\(|\)|\;|\]|\[|`|\\|\$|<|>|!|=|&|\|)" color brightmagenta "\<(union|group|subgroup)\>" -## Comment highlighting + +# Comments. color brightblue "//.*" color brightblue start="/\*" end="\*/" diff --git a/doc/syntax/python.nanorc b/doc/syntax/python.nanorc index 4280274..de876bd 100644 --- a/doc/syntax/python.nanorc +++ b/doc/syntax/python.nanorc @@ -1,10 +1,25 @@ ## Here is an example for Python. -## + syntax "python" "\.py$" -header "^#!.*/python[-0-9._]*" +header "^#!.*python[-0-9._]*" + +# Function definitions. icolor brightblue "def [0-9A-Z_]+" -color brightcyan "\<(and|as|assert|break|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|not|or|pass|print|raise|return|try|while|with|yield)\>" +# Keywords. +color brightcyan "\<(and|as|assert|break|class|continue|def|del|elif|else|except|exec|finally|for|from)\>" +color brightcyan "\<(global|if|import|in|is|lambda|not|or|pass|print|raise|return|try|while|with|yield)\>" + +# Strings. color brightgreen "['][^']*[^\\][']" "[']{3}.*[^\\][']{3}" color brightgreen "["][^"]*[^\\]["]" "["]{3}.*[^\\]["]{3}" -color brightgreen start=""""[^"]" end=""""" start="'''[^']" end="'''" -color brightred "#.*$" +# Multiline strings. +color brightgreen start="\"\"\"([^"),]|$)" end="(^|[^(])\"\"\"" +color brightgreen start="'''([^'),]|$)" end="(^|[^(])'''" + +# Comments. +color brightred "(^|[[:blank:]])#.*$" +# Reminders. +color ,yellow "(FIXME|TODO|XXX)" + +# Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/ruby.nanorc b/doc/syntax/ruby.nanorc index b30b229..298425f 100644 --- a/doc/syntax/ruby.nanorc +++ b/doc/syntax/ruby.nanorc @@ -1,31 +1,33 @@ ## Here is an example for Ruby. -## + syntax "ruby" "\.rb$" -header "^#!.*/ruby[-0-9._]*" -## Asciibetical list of reserved words -color yellow "\<(BEGIN|END|alias|and|begin|break|case|class|def|defined\?|do|else|elsif|end|ensure|false|for|if|in|module|next|nil|not|or|redo|rescue|retry|return|self|super|then|true|undef|unless|until|when|while|yield)\>" -## Constants +header "^#!.*ruby[-0-9._]*" + +# Reserved words. +color yellow "\<(BEGIN|END|alias|and|begin|break|case|class|def|defined\?|do|else|elsif|end|ensure|false|for|if|in|module)\>" +color yellow "\<(next|nil|not|or|redo|rescue|retry|return|self|super|then|true|undef|unless|until|when|while|yield)\>" +# Constants. color brightblue "(\$|@|@@)?\<[A-Z]+[0-9A-Z_a-z]*" -## Ruby "symbols" +# Ruby "symbols". icolor magenta "([ ]|^):[0-9A-Z_]+\>" -## Some unique things we want to stand out +# Some unique things we want to stand out. color brightyellow "\<(__FILE__|__LINE__)\>" -## Regular expressions +# Regular expressions. color brightmagenta "/([^/]|(\\/))*/[iomx]*" "%r\{([^}]|(\\}))*\}[iomx]*" -## Shell command expansion is in `backticks` or like %x{this}. These are -## "double-quotish" (to use a perlism). +# Shell command expansion is in `backticks` or like %x{this}. These are +# "double-quotish" (to use a perlism). color brightblue "`[^`]*`" "%x\{[^}]*\}" -## Strings, double-quoted +# Strings, double-quoted. color green ""([^"]|(\\"))*"" "%[QW]?\{[^}]*\}" "%[QW]?\([^)]*\)" "%[QW]?<[^>]*>" "%[QW]?\[[^]]*\]" "%[QW]?\$[^$]*\$" "%[QW]?\^[^^]*\^" "%[QW]?![^!]*!" -## Expression substitution. These go inside double-quoted strings, -## "like #{this}". +# Expression substitution. These go inside double-quoted strings, +# "like #{this}". color brightgreen "#\{[^}]*\}" -## Strings, single-quoted +# Strings, single-quoted. color green "'([^']|(\\'))*'" "%[qw]\{[^}]*\}" "%[qw]\([^)]*\)" "%[qw]<[^>]*>" "%[qw]\[[^]]*\]" "%[qw]\$[^$]*\$" "%[qw]\^[^^]*\^" "%[qw]![^!]*!" -## Comments +# Comments. color cyan "#[^{].*$" "#$" color brightcyan "##[^{].*$" "##$" -## "Here" docs +# "Here" docs. color green start="<<-?'?EOT'?" end="^EOT" -## Some common markers +# Some common markers. color brightcyan "(XXX|TODO|FIXME|\?\?\?)" diff --git a/doc/syntax/sh.nanorc b/doc/syntax/sh.nanorc index ecce22e..074e03a 100644 --- a/doc/syntax/sh.nanorc +++ b/doc/syntax/sh.nanorc @@ -1,14 +1,27 @@ ## Here is an example for Bourne shell scripts. -## + syntax "sh" "\.sh$" -header "^#!.*/(ba|k|pdk)?sh[-0-9_]*" +header "^#!.*((ba|da|k|pdk)?sh[-0-9_]*|openrc-run|runscript)" +magic "(POSIX|Bourne.*) shell script text" + icolor brightgreen "^[0-9A-Z_]+\(\)" -color green "\<(case|do|done|elif|else|esac|exit|fi|for|function|if|in|local|read|return|select|shift|then|time|until|while)\>" -color green "(\{|\}|\(|\)|\;|\]|\[|`|\\|\$|<|>|!|=|&|\|)" +color green "\<(break|case|continue|do|done|elif|else|esac|exit|fi|for|function|if|in|read|return|select|shift|then|time|until|while)\>" +color green "\<(declare|eval|exec|export|let|local)\>" +color green "[{}():;|`$<>!=&\\]" "(\]|\[)" color green "-[Ldefgruwx]\>" color green "-(eq|ne|gt|lt|ge|le|s|n|z)\>" -color brightblue "\<(cat|cd|chmod|chown|cp|echo|env|export|grep|install|let|ln|make|mkdir|mv|rm|sed|set|tar|touch|umask|unset)\>" -icolor brightred "\$\{?[0-9A-Z_!@#$*?-]+\}?" +color brightblue "\<(awk|cat|cd|ch(grp|mod|own)|cp|echo|env|grep|install|ln|make|mkdir|mv|popd|printf|pushd|rm|rmdir|sed|set|tar|touch|umask|unset)\>" + +# Basic variable names (no braces). +color brightred "\$[-0-9@*#?$!]" "\$[[:alpha:]_][[:alnum:]_]*" +# More complicated variable names; handles braces and replacements and arrays. +color brightred "\$\{[#!]?([-@*#?$!]|[0-9]+|[[:alpha:]_][[:alnum:]_]*)(\[([[:space:]]*[[:alnum:]_]+[[:space:]]*|@)\])?(([#%/]|:?[-=?+])[^}]*\}|\[|\})" + +# Comments. color cyan "(^|[[:space:]])#.*$" + +# Strings. color brightyellow ""(\\.|[^"])*"" "'(\\.|[^'])*'" + +# Trailing whitespace. color ,green "[[:space:]]+$" diff --git a/doc/syntax/spec.nanorc b/doc/syntax/spec.nanorc new file mode 100644 index 0000000..47de211 --- /dev/null +++ b/doc/syntax/spec.nanorc @@ -0,0 +1,39 @@ +## Syntax highlighting for RPM spec files. + +syntax "spec" "\.(spec$|spec\.*)" + +# Main tags. +color brightblue "((Icon|ExclusiveOs|ExcludeOs)[[:space:]]*:)" +color brightblue "((BuildArch|BuildArchitectures|ExclusiveArch|ExcludeArch)[[:space:]]*:)" +color brightblue "((Conflicts|Obsoletes|Provides|Requires|Requires\(.*\)|Enhances|Suggests|BuildConflicts|BuildRequires|Recommends|PreReq|Supplements)[[:space:]]*:)" +color brightblue "((Epoch|Serial|Nosource|Nopatch)[[:space:]]*:)" +color brightblue "((AutoReq|AutoProv|AutoReqProv)[[:space:]]*:)" +color brightblue "((Copyright|License|Summary|Summary\(.*\)|Distribution|Vendor|Packager|Group|Source\d*|Patch\d*|BuildRoot|Prefix)[[:space:]]*:)" +color brightblue "((Name|Version|Release|Url|URL)[[:space:]]*:)" +color brightblue start="^Source" end=":" start="^Patch" end=":" +# Architectures. +color brightred "(i386|i486|i586|i686|athlon|ia64|alpha|alphaev5|alphaev56|alphapca56|alphaev6|alphaev67|sparc|sparcv9|sparc64armv3l|armv4b|armv4lm|ips|mipsel|ppc|ppc|iseries|ppcpseries|ppc64|m68k|m68kmint|Sgi|rs6000|i370|s390x|s390|noarch)" +# Architecture conditionals. +color brightred "(ifarch|ifnarch)" +# OS conditionals. +color brightred "(ifos|ifnos)" +# %* strings. +color green "%([A-Z_a-z_0-9_]*)" +color magenta "%_([A-Z_a-z_0-9_]*)" +color yellow start="%__" end="\ " +color magenta start="%\{" end="\}" +color yellow start="%\{__" end="\}" +# Sections. +color red "^%(build$|changelog|check$|clean$|description|files|install$|package|pre|prep$|pretrans|preun)" +color red "^%(post|posttrans|postun|trigger|triggerin|triggerpostun|triggerun|verifyscript)" +# Conditionals and defines. +color brightred "%(if|else|endif|define|global|undefine)" + +# Comments. +color cyan "#.*$" +# Special case: "# norootforbuild" is handled as main tag. +color brightblue "^# norootforbuild" +# %changelog date entries. +color brightyellow "^\* .*\)$" +# Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/tcl.nanorc b/doc/syntax/tcl.nanorc index ad3401f..8bcec24 100644 --- a/doc/syntax/tcl.nanorc +++ b/doc/syntax/tcl.nanorc @@ -1,13 +1,15 @@ +## Syntax highlighting for Tcl files. + syntax "tcl" "\.tcl$" -## Standard Tcl [info commands] +# Standard Tcl [info commands]: color green "\<(after|append|array|auto_execok|auto_import|auto_load|auto_load_index|auto_qualify|binary|break|case|catch|cd|clock|close|concat|continue|encoding|eof|error|eval|exec|exit|expr|fblocked|fconfigure|fcopy|file|fileevent|flush|for|foreach|format|gets|glob|global|history|if|incr|info|interp|join|lappend|lindex|linsert|list|llength|load|lrange|lreplace|lsearch|lset|lsort|namespace|open|package|pid|puts|pwd|read|regexp|regsub|rename|return|scan|seek|set|socket|source|split|string|subst|switch|tclLog|tell|time|trace|unknown|unset|update|uplevel|upvar|variable|vwait|while)\>" -## Basic Tcl sub commands. +# Basic Tcl subcommands: color green "\<(array anymore|array donesearch|array exists|array get|array names|array nextelement|array set|array size|array startsearch|array statistics|array unset)\>" color green "\<(string bytelength|string compare|string equal|string first|string index|string is|string last|string length|string map|string match|string range|string repeat|string replace|string to|string tolower|string totitle|string toupper|string trim|string trimleft|string trimright|string will|string wordend|string wordstart)\>" -## Extended TclX [info commands] +# Extended TclX [info commands]: color green "\<(alarm|auto_load_pkg|bsearch|catclose|catgets|catopen|ccollate|cconcat|cequal|chgrp|chmod|chown|chroot|cindex|clength|cmdtrace|commandloop|crange|csubstr|ctoken|ctype|dup|echo|execl|fcntl|flock|fork|fstat|ftruncate|funlock|host_info|id|infox|keyldel|keylget|keylkeys|keylset|kill|lassign|lcontain|lempty|lgets|link|lmatch|loadlibindex|loop|lvarcat|lvarpop|lvarpush|max|min|nice|pipe|profile|random|readdir|replicate|scancontext|scanfile|scanmatch|select|server_accept|server_create|signal|sleep|sync|system|tclx_findinit|tclx_fork|tclx_load_tndxs|tclx_sleep|tclx_system|tclx_wait|times|translit|try_eval|umask|wait)\>" -## Syntax. +# Syntax: color brightblue "proc[[:space:]]" "(\{|\})" color green "(\(|\)|\;|`|\\|\$|<|>|!|=|&|\|)" color brightyellow ""(\\.|[^"])*"" "'(\\.|[^'])*'" diff --git a/doc/syntax/tex.nanorc b/doc/syntax/tex.nanorc index 23ca3a4..7fa417c 100644 --- a/doc/syntax/tex.nanorc +++ b/doc/syntax/tex.nanorc @@ -1,6 +1,7 @@ ## Here is a short example for TeX files. -## + syntax "tex" "\.tex$" + icolor green "\\.|\\[A-Z]*" color magenta "[{}]" color blue "(^|[^\])%.*" diff --git a/doc/syntax/texinfo.nanorc b/doc/syntax/texinfo.nanorc new file mode 100644 index 0000000..63354ba --- /dev/null +++ b/doc/syntax/texinfo.nanorc @@ -0,0 +1,20 @@ +## Here is an example for Texinfo files. + +syntax "texinfo" "\.texi$" +header "^\\input texinfo" +magic "Texinfo source text" + +# Command arguments, trailing and enclosed. +color cyan "^@[a-z]+[[:space:]]+.*$" +color brightmagenta "@[a-z]+\{[^}]*\}" +# Commands themselves. +color yellow "@[a-z]+\{?" "\}" + +# Menu items. +color brightred "^\*[[:space:]]+.*::.*$" + +# Comments. +color green "@c[[:space:]]+.*$" + +# Trailing whitespace. +color ,green "[[:space:]]+$" diff --git a/doc/syntax/xml.nanorc b/doc/syntax/xml.nanorc index 1f68c05..69982ea 100644 --- a/doc/syntax/xml.nanorc +++ b/doc/syntax/xml.nanorc @@ -1,6 +1,8 @@ -## Here is an example for xml files. -## +## Here is an example for XML files. + syntax "xml" "\.([jrs]html?|sgml?|xml|xslt?)$" +magic "(XML|SGML) (sub)?document text" + color green start="<" end=">" color cyan "<[^> ]+" color cyan ">" diff --git a/doc/texinfo/Makefile.in b/doc/texinfo/Makefile.in index 386be23..c46889e 100644 --- a/doc/texinfo/Makefile.in +++ b/doc/texinfo/Makefile.in @@ -1,9 +1,8 @@ -# Makefile.in generated by automake 1.11.1 from Makefile.am. +# Makefile.in generated by automake 1.14.1 from Makefile.am. # @configure_input@ -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. +# Copyright (C) 1994-2013 Free Software Foundation, Inc. + # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -15,6 +14,51 @@ @SET_MAKE@ VPATH = @srcdir@ +am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)' +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -33,11 +77,12 @@ PRE_UNINSTALL = : POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ -target_triplet = @target@ subdir = doc/texinfo -DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in texinfo.tex +DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \ + $(top_srcdir)/mkinstalldirs texinfo.tex ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.m4 \ + $(top_srcdir)/m4/ax_check_compile_flag.m4 \ $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/glib-2.0.m4 \ $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/isc-posix.m4 \ $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ @@ -49,8 +94,48 @@ mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = SOURCES = DIST_SOURCES = +AM_V_DVIPS = $(am__v_DVIPS_@AM_V@) +am__v_DVIPS_ = $(am__v_DVIPS_@AM_DEFAULT_V@) +am__v_DVIPS_0 = @echo " DVIPS " $@; +am__v_DVIPS_1 = +AM_V_MAKEINFO = $(am__v_MAKEINFO_@AM_V@) +am__v_MAKEINFO_ = $(am__v_MAKEINFO_@AM_DEFAULT_V@) +am__v_MAKEINFO_0 = @echo " MAKEINFO" $@; +am__v_MAKEINFO_1 = +AM_V_INFOHTML = $(am__v_INFOHTML_@AM_V@) +am__v_INFOHTML_ = $(am__v_INFOHTML_@AM_DEFAULT_V@) +am__v_INFOHTML_0 = @echo " INFOHTML" $@; +am__v_INFOHTML_1 = +AM_V_TEXI2DVI = $(am__v_TEXI2DVI_@AM_V@) +am__v_TEXI2DVI_ = $(am__v_TEXI2DVI_@AM_DEFAULT_V@) +am__v_TEXI2DVI_0 = @echo " TEXI2DVI" $@; +am__v_TEXI2DVI_1 = +AM_V_TEXI2PDF = $(am__v_TEXI2PDF_@AM_V@) +am__v_TEXI2PDF_ = $(am__v_TEXI2PDF_@AM_DEFAULT_V@) +am__v_TEXI2PDF_0 = @echo " TEXI2PDF" $@; +am__v_TEXI2PDF_1 = +AM_V_texinfo = $(am__v_texinfo_@AM_V@) +am__v_texinfo_ = $(am__v_texinfo_@AM_DEFAULT_V@) +am__v_texinfo_0 = -q +am__v_texinfo_1 = +AM_V_texidevnull = $(am__v_texidevnull_@AM_V@) +am__v_texidevnull_ = $(am__v_texidevnull_@AM_DEFAULT_V@) +am__v_texidevnull_0 = > /dev/null +am__v_texidevnull_1 = INFO_DEPS = $(srcdir)/nano.info am__TEXINFO_TEX_DIR = $(srcdir) DVIS = nano.dvi @@ -63,6 +148,11 @@ TEXI2PDF = $(TEXI2DVI) --pdf --batch MAKEINFOHTML = $(MAKEINFO) --html AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) DVIPS = dvips +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac am__installdirs = "$(DESTDIR)$(infodir)" am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; am__vpath_adj = case $$p in \ @@ -85,9 +175,17 @@ am__nobase_list = $(am__nobase_strip_setup); \ am__base_list = \ sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ @@ -133,6 +231,11 @@ MKDIR_P = @MKDIR_P@ MKINSTALLDIRS = @MKINSTALLDIRS@ MSGFMT = @MSGFMT@ MSGMERGE = @MSGMERGE@ +NCURSESW_CFLAGS = @NCURSESW_CFLAGS@ +NCURSESW_CONFIG = @NCURSESW_CONFIG@ +NCURSESW_LIBS = @NCURSESW_LIBS@ +NCURSES_CFLAGS = @NCURSES_CFLAGS@ +NCURSES_LIBS = @NCURSES_LIBS@ OBJEXT = @OBJEXT@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ @@ -144,6 +247,8 @@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKGDATADIR = @PKGDATADIR@ PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ POSUB = @POSUB@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ @@ -173,6 +278,7 @@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ +haveit = @haveit@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ @@ -197,11 +303,7 @@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ -target = @target@ target_alias = @target_alias@ -target_cpu = @target_cpu@ -target_os = @target_os@ -target_vendor = @target_vendor@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ @@ -245,7 +347,7 @@ $(ACLOCAL_M4): $(am__aclocal_m4_deps) $(am__aclocal_m4_deps): .texi.info: - restore=: && backupdir="$(am__leading_dot)am$$$$" && \ + $(AM_V_MAKEINFO)restore=: && backupdir="$(am__leading_dot)am$$$$" && \ am__cwd=`pwd` && $(am__cd) $(srcdir) && \ rm -rf $$backupdir && mkdir $$backupdir && \ if ($(MAKEINFO) --version) >/dev/null 2>&1; then \ @@ -267,34 +369,32 @@ $(am__aclocal_m4_deps): rm -rf $$backupdir; exit $$rc .texi.dvi: - TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ + $(AM_V_TEXI2DVI)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ - $(TEXI2DVI) $< + $(TEXI2DVI) $(AM_V_texinfo) --build-dir=$(@:.dvi=.t2d) -o $@ $(AM_V_texidevnull) \ + $< .texi.pdf: - TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ + $(AM_V_TEXI2PDF)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ - $(TEXI2PDF) $< + $(TEXI2PDF) $(AM_V_texinfo) --build-dir=$(@:.pdf=.t2p) -o $@ $(AM_V_texidevnull) \ + $< .texi.html: - rm -rf $(@:.html=.htp) - if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + $(AM_V_MAKEINFO)rm -rf $(@:.html=.htp) + $(AM_V_at)if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ -o $(@:.html=.htp) $<; \ then \ - rm -rf $@; \ - if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \ - mv $(@:.html=) $@; else mv $(@:.html=.htp) $@; fi; \ + rm -rf $@ && mv $(@:.html=.htp) $@; \ else \ - if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \ - rm -rf $(@:.html=); else rm -Rf $(@:.html=.htp) $@; fi; \ - exit 1; \ + rm -rf $(@:.html=.htp); exit 1; \ fi $(srcdir)/nano.info: nano.texi nano.dvi: nano.texi nano.pdf: nano.texi .dvi.ps: - TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ - $(DVIPS) -o $@ $< + $(AM_V_DVIPS)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ + $(DVIPS) $(AM_V_texinfo) -o $@ $< uninstall-dvi-am: @$(NORMAL_UNINSTALL) @@ -316,9 +416,7 @@ uninstall-html-am: uninstall-info-am: @$(PRE_UNINSTALL) - @if test -d '$(DESTDIR)$(infodir)' && \ - (install-info --version && \ - install-info --version 2>&1 | sed 1q | grep -i -v debian) >/dev/null 2>&1; then \ + @if test -d '$(DESTDIR)$(infodir)' && $(am__can_run_installinfo); then \ list='$(INFO_DEPS)'; \ for file in $$list; do \ relfile=`echo "$$file" | sed 's|^.*/||'`; \ @@ -375,9 +473,7 @@ dist-info: $(INFO_DEPS) done mostlyclean-aminfo: - -rm -rf nano.aux nano.cp nano.cps nano.fn nano.fns nano.ky nano.kys \ - nano.log nano.pg nano.pgs nano.tmp nano.toc nano.tp nano.tps \ - nano.vr nano.vrs + -rm -rf nano.t2d nano.t2p clean-aminfo: -test -z "nano.dvi nano.pdf nano.ps nano.html" \ @@ -389,11 +485,11 @@ maintainer-clean-aminfo: echo " rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]"; \ rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]; \ done -tags: TAGS -TAGS: +tags TAGS: + +ctags CTAGS: -ctags: CTAGS -CTAGS: +cscope cscopelist: distdir: $(DISTFILES) @@ -448,10 +544,15 @@ install-am: all-am installcheck: installcheck-am install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi mostlyclean-generic: clean-generic: @@ -490,8 +591,11 @@ install-dvi: install-dvi-am install-dvi-am: $(DVIS) @$(NORMAL_INSTALL) - test -z "$(dvidir)" || $(MKDIR_P) "$(DESTDIR)$(dvidir)" @list='$(DVIS)'; test -n "$(dvidir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(dvidir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(dvidir)" || exit 1; \ + fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ @@ -506,18 +610,22 @@ install-html: install-html-am install-html-am: $(HTMLS) @$(NORMAL_INSTALL) - test -z "$(htmldir)" || $(MKDIR_P) "$(DESTDIR)$(htmldir)" @list='$(HTMLS)'; list2=; test -n "$(htmldir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(htmldir)" || exit 1; \ + fi; \ for p in $$list; do \ if test -f "$$p" || test -d "$$p"; then d=; else d="$(srcdir)/"; fi; \ $(am__strip_dir) \ - if test -d "$$d$$p"; then \ + d2=$$d$$p; \ + if test -d "$$d2"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)/$$f'"; \ $(MKDIR_P) "$(DESTDIR)$(htmldir)/$$f" || exit 1; \ - echo " $(INSTALL_DATA) '$$d$$p'/* '$(DESTDIR)$(htmldir)/$$f'"; \ - $(INSTALL_DATA) "$$d$$p"/* "$(DESTDIR)$(htmldir)/$$f" || exit $$?; \ + echo " $(INSTALL_DATA) '$$d2'/* '$(DESTDIR)$(htmldir)/$$f'"; \ + $(INSTALL_DATA) "$$d2"/* "$(DESTDIR)$(htmldir)/$$f" || exit $$?; \ else \ - list2="$$list2 $$d$$p"; \ + list2="$$list2 $$d2"; \ fi; \ done; \ test -z "$$list2" || { echo "$$list2" | $(am__base_list) | \ @@ -529,9 +637,12 @@ install-info: install-info-am install-info-am: $(INFO_DEPS) @$(NORMAL_INSTALL) - test -z "$(infodir)" || $(MKDIR_P) "$(DESTDIR)$(infodir)" @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ list='$(INFO_DEPS)'; test -n "$(infodir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(infodir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(infodir)" || exit 1; \ + fi; \ for file in $$list; do \ case $$file in \ $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ @@ -549,8 +660,7 @@ install-info-am: $(INFO_DEPS) echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(infodir)'"; \ $(INSTALL_DATA) $$files "$(DESTDIR)$(infodir)" || exit $$?; done @$(POST_INSTALL) - @if (install-info --version && \ - install-info --version 2>&1 | sed 1q | grep -i -v debian) >/dev/null 2>&1; then \ + @if $(am__can_run_installinfo); then \ list='$(INFO_DEPS)'; test -n "$(infodir)" || list=; \ for file in $$list; do \ relfile=`echo "$$file" | sed 's|^.*/||'`; \ @@ -564,8 +674,11 @@ install-pdf: install-pdf-am install-pdf-am: $(PDFS) @$(NORMAL_INSTALL) - test -z "$(pdfdir)" || $(MKDIR_P) "$(DESTDIR)$(pdfdir)" @list='$(PDFS)'; test -n "$(pdfdir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(pdfdir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(pdfdir)" || exit 1; \ + fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ @@ -577,8 +690,11 @@ install-ps: install-ps-am install-ps-am: $(PSS) @$(NORMAL_INSTALL) - test -z "$(psdir)" || $(MKDIR_P) "$(DESTDIR)$(psdir)" @list='$(PSS)'; test -n "$(psdir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(psdir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(psdir)" || exit 1; \ + fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ @@ -611,16 +727,17 @@ uninstall-am: uninstall-dvi-am uninstall-html-am uninstall-info-am \ .MAKE: all check install install-am install-strip .PHONY: all all-am check check-am clean clean-aminfo clean-generic \ - dist-info distclean distclean-generic distdir dvi dvi-am html \ - html-am info info-am install install-am install-data \ - install-data-am install-dvi install-dvi-am install-exec \ - install-exec-am install-html install-html-am install-info \ - install-info-am install-man install-pdf install-pdf-am \ - install-ps install-ps-am install-strip installcheck \ - installcheck-am installdirs maintainer-clean \ - maintainer-clean-aminfo maintainer-clean-generic mostlyclean \ - mostlyclean-aminfo mostlyclean-generic pdf pdf-am ps ps-am \ - uninstall uninstall-am uninstall-dvi-am uninstall-html-am \ + cscopelist-am ctags-am dist-info distclean distclean-generic \ + distdir dvi dvi-am html html-am info info-am install \ + install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-aminfo \ + maintainer-clean-generic mostlyclean mostlyclean-aminfo \ + mostlyclean-generic pdf pdf-am ps ps-am tags-am uninstall \ + uninstall-am uninstall-dvi-am uninstall-html-am \ uninstall-info-am uninstall-pdf-am uninstall-ps-am diff --git a/doc/texinfo/nano.html b/doc/texinfo/nano.html index b673557..0568413 100644 --- a/doc/texinfo/nano.html +++ b/doc/texinfo/nano.html @@ -1,363 +1,583 @@ -<html lang="en"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ --> <head> <title>nano Command Manual</title> -<meta http-equiv="Content-Type" content="text/html"> + <meta name="description" content="nano Command Manual"> -<meta name="generator" content="makeinfo 4.13"> -<link title="Top" rel="top" href="#Top"> -<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> -<meta http-equiv="Content-Style-Type" content="text/css"> -<style type="text/css"><!-- - pre.display { font-family:inherit } - pre.format { font-family:inherit } - pre.smalldisplay { font-family:inherit; font-size:smaller } - pre.smallformat { font-family:inherit; font-size:smaller } - pre.smallexample { font-size:smaller } - pre.smalllisp { font-size:smaller } - span.sc { font-variant:small-caps } - span.roman { font-family:serif; font-weight:normal; } - span.sansserif { font-family:sans-serif; font-weight:normal; } ---></style> +<meta name="keywords" content="nano Command Manual"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<link href="#Top" rel="start" title="Top"> +<link href="#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="dir.html#Top" rel="up" title="(dir)"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.indentedblock {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smallindentedblock {margin-left: 3.2em; font-size: smaller} +div.smalllisp {margin-left: 3.2em} +kbd {font-style:oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: inherit; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: inherit; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.nocodebreak {white-space:nowrap} +span.nolinebreak {white-space:nowrap} +span.roman {font-family:serif; font-weight:normal} +span.sansserif {font-family:sans-serif; font-weight:normal} +ul.no-bullet {list-style: none} +--> +</style> + + </head> -<body> -<h1 class="settitle">nano Command Manual</h1> -<div class="node"> -<a name="Top"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Introduction">Introduction</a>, -Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, -Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> -</div> +<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> +<h1 class="settitle" align="center">nano Command Manual</h1> - <p>This manual documents GNU <code>nano</code>, a small and friendly text -editor. -<ul class="menu"> -<li><a accesskey="1" href="#Introduction">Introduction</a> -<li><a accesskey="2" href="#Editor-Basics">Editor Basics</a> -<li><a accesskey="3" href="#Online-Help">Online Help</a> -<li><a accesskey="4" href="#Feature-Toggles">Feature Toggles</a> -<li><a accesskey="5" href="#Nanorc-Files">Nanorc Files</a> -<li><a accesskey="6" href="#The-File-Browser">The File Browser</a> -<li><a accesskey="7" href="#Pico-Compatibility">Pico Compatibility</a> -<li><a accesskey="8" href="#Building-and-Configure-Options">Building and Configure Options</a> -</ul> -<div class="node"> -<a name="Introduction"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Editor-Basics">Editor Basics</a>, -Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> + + +<a name="Top"></a> +<div class="header"> +<p> +Next: <a href="#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> +<a name="SEC_Top"></a> +<p>This manual documents GNU <code>nano</code>, a small and friendly text +editor. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#Introduction" accesskey="1">Introduction</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Editor-Basics" accesskey="2">Editor Basics</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Online-Help" accesskey="3">Online Help</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Feature-Toggles" accesskey="4">Feature Toggles</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Nanorc-Files" accesskey="5">Nanorc Files</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<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"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Pico-Compatibility" accesskey="7">Pico Compatibility</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<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"> +</td></tr> +</table> + + +<hr> +<a name="Introduction"></a> +<div class="header"> +<p> +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> +</div> +<a name="Introduction-1"></a> <h2 class="chapter">1 Introduction</h2> <p>GNU <code>nano</code> is a small and friendly text editor. Besides basic text -editing, <code>nano</code> offers many extra features like an interactive -search and replace, go to line and column number, auto-indentation, +editing, <code>nano</code> offers many extra features, like an interactive +search-and-replace, go-to-line-and-column-number, auto-indentation, feature toggles, internationalization support, and filename tab completion. - -<ul class="menu"> -<li><a accesskey="1" href="#Overview">Overview</a> -<li><a accesskey="2" href="#Command-Line-Options">Command Line Options</a> -</ul> - -<div class="node"> +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#Overview" accesskey="1">Overview</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<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"> +</td></tr> +</table> + +<hr> <a name="Overview"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Command-Line-Options">Command Line Options</a>, -Previous: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>, -Up: <a rel="up" accesskey="u" href="#Introduction">Introduction</a> - +<div class="header"> +<p> +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> </div> - +<a name="Overview-1"></a> <h3 class="section">1.1 Overview</h3> <p>The original goal for <code>nano</code> was a complete bug-for-bug compatible -emulation of Pico, but <code>nano</code>'s current goal is to be as compatible -as possible while offering a superset of Pico's functionality. See +emulation of Pico, but <code>nano</code>’s current goal is to be as compatible +as possible while offering a superset of Pico’s functionality. See See <a href="#Pico-Compatibility">Pico Compatibility</a>, for more info. - - <p>The usual way to invoke <code>nano</code> is: - - <blockquote> -<code>nano [OPTION]... [FILE]</code> -</blockquote> - - <p>But it is also possible to edit several files in a row. Additionally, +</p> +<p>The usual way to invoke <code>nano</code> is: +</p> +<blockquote> +<p><code>nano [OPTION]… [FILE]</code> +</p></blockquote> + +<p>But it is also possible to edit several files in a row. Additionally, the cursor can be put on a desired line number by adding this number with a plus sign before any filename, and even in a desired column by adding it with a comma. So the complete synopsis is: - - <blockquote> -<code>nano [OPTION]... [[+LINE] FILE]...</code> - - <p><code>nano [OPTION]... [[+,COLUMN] FILE]...</code> - - <p><code>nano [OPTION]... [[+LINE,COLUMN] FILE]...</code> -</blockquote> - - <p>Email bug reports to <a href="mailto:nano@nano-editor.org">nano@nano-editor.org</a>. - -<div class="node"> +</p> +<blockquote> +<p><code>nano [OPTION]… [[+LINE] FILE]…</code> +</p> +<p><code>nano [OPTION]… [[+,COLUMN] FILE]…</code> +</p> +<p><code>nano [OPTION]… [[+LINE,COLUMN] FILE]…</code> +</p></blockquote> + +<p>Email bug reports to <a href="mailto:nano@nano-editor.org">nano@nano-editor.org</a>. +</p> +<hr> <a name="Command-Line-Options"></a> -<p><hr> -Previous: <a rel="previous" accesskey="p" href="#Overview">Overview</a>, -Up: <a rel="up" accesskey="u" href="#Introduction">Introduction</a> - +<div class="header"> +<p> +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> </div> - +<a name="Command-Line-Options-1"></a> <h3 class="section">1.2 Command Line Options</h3> <p><code>nano</code> takes the following options from the command line: - - <dl> -<dt><code>+LINE,COLUMN</code><dd>Start at line number LINE and column number COLUMN (at least one of +</p> +<dl compact="compact"> +<dt><samp>+<var>line</var>,<var>column</var></samp></dt> +<dd><p>Start at line number <var>line</var> and column number <var>column</var> (at least one of which must be specified) instead of the default of line 1, column 1. - - <br><dt><code>-?</code><dd>Same as <code>-h, --help</code>. - - <br><dt><code>-A, --smarthome</code><dd>Make the Home key smarter. When Home is pressed anywhere but at the +</p> +</dd> +<dt><samp>-A</samp></dt> +<dt><samp>--smarthome</samp></dt> +<dd><p>Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line. - - <br><dt><code>-B, --backup</code><dd>When saving a file, back up the previous version of it to the current -filename suffixed with a ~. - - <br><dt><code>-C <dir>, --backupdir=<dir></code><dd>Set the directory where <code>nano</code> puts unique backup files if file +</p> +</dd> +<dt><samp>-B</samp></dt> +<dt><samp>--backup</samp></dt> +<dd><p>When saving a file, back up the previous version of it to the current +filename suffixed with a ‘<samp>~</samp>’. +</p> +</dd> +<dt><samp>-C <var>directory</var></samp></dt> +<dt><samp>--backupdir=<var>directory</var></samp></dt> +<dd><p>Set the directory where <code>nano</code> puts unique backup files if file backups are enabled. - - <br><dt><code>-D, --boldtext</code><dd>Use bold text instead of reverse video text. - - <br><dt><code>-E, --tabstospaces</code><dd>Convert typed tabs to spaces. - - <br><dt><code>-F, --multibuffer</code><dd>Enable multiple file buffers, if available. - - <br><dt><code>-H, --historylog</code><dd>Log search and replace strings to ~/.nano_history, so they can be -retrieved in later sessions, if nanorc support is available. - - <br><dt><code>-I, --ignorercfiles</code><dd>Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is -available. - - <br><dt><code>-K, --rebindkeypad</code><dd>Interpret the numeric keypad keys so that they all work properly. You -should only need to use this option if they don't, as mouse support -won't work properly with this option enabled. - - <br><dt><code>-L, --nonewlines</code><dd>Don't add newlines to the ends of files. - - <br><dt><code>-N, --noconvert</code><dd>Don't convert files from DOS/Mac format. - - <br><dt><code>-O, --morespace</code><dd>Use the blank line below the titlebar as extra editing space. - - <br><dt><code>-Q <str>, --quotestr=<str></code><dd>Set the quoting string for justifying. The default value is - - <blockquote> -<code>^([ \t]*[|>:}#])+</code> -</blockquote> - - <p>if extended regular expression support is available, or "> " otherwise. +</p> +</dd> +<dt><samp>-D</samp></dt> +<dt><samp>--boldtext</samp></dt> +<dd><p>Use bold text instead of reverse video text. +</p> +</dd> +<dt><samp>-E</samp></dt> +<dt><samp>--tabstospaces</samp></dt> +<dd><p>Convert typed tabs to spaces. +</p> +</dd> +<dt><samp>-F</samp></dt> +<dt><samp>--multibuffer</samp></dt> +<dd><p>Enable multiple file buffers (if support for them has been compiled in). +</p> +</dd> +<dt><samp>-G</samp></dt> +<dt><samp>--locking</samp></dt> +<dd><p>Enable vim-style file locking when editing files. +</p> +</dd> +<dt><samp>-H</samp></dt> +<dt><samp>--historylog</samp></dt> +<dd><p>Log search and replace strings to <samp>~/.nano/search_history</samp>, +so they can be retrieved in later sessions. +</p> +</dd> +<dt><samp>-I</samp></dt> +<dt><samp>--ignorercfiles</samp></dt> +<dd><p>Don’t look at the system’s nanorc file nor at the user’s <samp>~/.nanorc</samp>. +</p> +</dd> +<dt><samp>-K</samp></dt> +<dt><samp>--rebindkeypad</samp></dt> +<dd><p>Interpret the numeric keypad keys so that they all work properly. You +should only need to use this option if they don’t, as mouse support +won’t work properly with this option enabled. +</p> +</dd> +<dt><samp>-L</samp></dt> +<dt><samp>--nonewlines</samp></dt> +<dd><p>Don’t add newlines to the ends of files. +</p> +</dd> +<dt><samp>-N</samp></dt> +<dt><samp>--noconvert</samp></dt> +<dd><p>Disable automatic conversion of files from DOS/Mac format. +</p> +</dd> +<dt><samp>-O</samp></dt> +<dt><samp>--morespace</samp></dt> +<dd><p>Use the blank line below the titlebar as extra editing space. +</p> +</dd> +<dt><samp>-P</samp></dt> +<dt><samp>--poslog</samp></dt> +<dd><p>Log for each file the last location of the cursor, and read it +back upon reopening the file and place it there again. +</p> +</dd> +<dt><samp>-Q "<var>characters</var>"</samp></dt> +<dt><samp>--quotestr="<var>characters</var>"</samp></dt> +<dd><p>Set the quoting string for justifying. The default value is +</p> +<blockquote> +<p>"^([ \t]*[|>:}#])+" +</p></blockquote> + +<p>if extended regular expression support is available, or <code>> </code> otherwise. Note that <code>\t</code> above stands for a literal Tab character. - - <br><dt><code>-R, --restricted</code><dd>Restricted mode: don't read or write to any file not specified on the -command line; read any nanorc files; allow suspending; allow a file to -be appended to, prepended to, or saved under a different name if it -already has one; or use backup files or spell checking. Also accessible -by invoking <code>nano</code> with any name beginning with 'r' (e.g. "rnano"). - - <br><dt><code>-S, --smooth</code><dd>Enable smooth scrolling. Text will scroll line-by-line, instead of the +</p> +</dd> +<dt><samp>-R</samp></dt> +<dt><samp>--restricted</samp></dt> +<dd><p>Restricted mode: don’t read or write to any file not specified on the +command line; don’t read any nanorc files nor history files; don’t allow +suspending nor spell checking; don’t +allow a file to be appended to, prepended to, or saved under a different +name if it already has one; and don’t use backup files. +This restricted mode is also accessible by invoking <code>nano</code> with +any name beginning with ‘<samp>r</samp>’ (e.g. <code>rnano</code>). +</p> +</dd> +<dt><samp>-S</samp></dt> +<dt><samp>--smooth</samp></dt> +<dd><p>Enable smooth scrolling. Text will scroll line-by-line, instead of the usual chunk-by-chunk behavior. - - <br><dt><code>-T <#cols>, --tabsize=<#cols></code><dd>Set the displayed tab length to #cols columns. The value of #cols must -be greater than 0. The default value is 8. - - <br><dt><code>-U, --quickblank</code><dd>Do quick statusbar blanking. Statusbar messages will disappear after 1 -keystroke instead of 25. Note that -c overrides this. - - <br><dt><code>-V, --version</code><dd>Show the current version number and exit. - - <br><dt><code>-W, --wordbounds</code><dd>Detect word boundaries more accurately by treating punctuation +</p> +</dd> +<dt><samp>-T <var>number</var></samp></dt> +<dt><samp>--tabsize=<var>number</var></samp></dt> +<dd><p>Set the displayed tab length to <var>number</var> columns. The value of +<var>number</var> must be greater than 0. The default value is ‘<samp>8</samp>’. +</p> +</dd> +<dt><samp>-U</samp></dt> +<dt><samp>--quickblank</samp></dt> +<dd><p>Do quick statusbar blanking. Statusbar messages will disappear after 1 +keystroke instead of 25. Note that <samp>-c</samp> overrides this. +</p> +</dd> +<dt><samp>-V</samp></dt> +<dt><samp>--version</samp></dt> +<dd><p>Show the current version number and exit. +</p> +</dd> +<dt><samp>-W</samp></dt> +<dt><samp>--wordbounds</samp></dt> +<dd><p>Detect word boundaries more accurately by treating punctuation characters as parts of words. - - <br><dt><code>-Y <str>, --syntax=<str></code><dd>Specify a specific syntax highlighting from the nanorc to use, if -available. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. - - <br><dt><code>-c, --const</code><dd>Constantly display the cursor position and line number on the statusbar. -Note that this overrides -U. - - <br><dt><code>-d, --rebinddelete</code><dd>Interpret the Delete key differently so that both Backspace and Delete +</p> +</dd> +<dt><samp>-Y <var>name</var></samp></dt> +<dt><samp>--syntax=<var>name</var></samp></dt> +<dd><p>Specify a specific syntax from the nanorc files to use for highlighting. +See See <a href="#Syntax-Highlighting">Syntax Highlighting</a>, for more info. +</p> +</dd> +<dt><samp>-c</samp></dt> +<dt><samp>--const</samp></dt> +<dd><p>Constantly display the cursor position and line number on the statusbar. +Note that this overrides <samp>-U</samp>. +</p> +</dd> +<dt><samp>-d</samp></dt> +<dt><samp>--rebinddelete</samp></dt> +<dd><p>Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. - - <br><dt><code>-h, --help</code><dd>Show a summary of command line options and exit. - - <br><dt><code>-i, --autoindent</code><dd>Automatically indent new lines to the same number of spaces and tabs as +</p> +</dd> +<dt><samp>-h</samp></dt> +<dt><samp>--help</samp></dt> +<dd><p>Show a summary of command-line options and exit. +</p> +</dd> +<dt><samp>-i</samp></dt> +<dt><samp>--autoindent</samp></dt> +<dd><p>Automatically indent new lines to the same number of spaces and tabs as the previous line. - - <br><dt><code>-k, --cut</code><dd>Cut from the current cursor position to the end of the current line. - - <br><dt><code>-l, --nofollow</code><dd>When writing files, if the given file is a symbolic link, it is removed +</p> +</dd> +<dt><samp>-k</samp></dt> +<dt><samp>--cut</samp></dt> +<dd><p>Make the ’Cut Text’ command (normally ^K) cut from the current cursor +position to the end of the line, instead of cutting the entire line. +</p> +</dd> +<dt><samp>-l</samp></dt> +<dt><samp>--nofollow</samp></dt> +<dd><p>When writing files, if the given file is a symbolic link, it is removed and a new file is created. - - <br><dt><code>-m, --mouse</code><dd>Enable mouse support, if available for your system. When enabled, mouse +</p> +</dd> +<dt><samp>-m</samp></dt> +<dt><samp>--mouse</samp></dt> +<dd><p>Enable mouse support, if available for your system. When enabled, mouse clicks can be used to place the cursor, set the mark (with a double click), and execute shortcuts. The mouse will work in the X Window -System, and on the console when gpm is running. - - <br><dt><code>-o <dir>, --operatingdir=<dir></code><dd>Set operating directory. Makes <code>nano</code> set up something similar to -a chroot. - - <br><dt><code>-p, --preserve</code><dd>Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the -editor can be can be stopped and started. - - <br><dt><code>-q, --quiet</code><dd>Do not report errors in the nanorc file and ask them to be acknowledged +System, and on the console when gpm is running. Text can still be +selected through dragging by holding down the Shift key. +</p> +</dd> +<dt><samp>-n</samp></dt> +<dt><samp>--noread</samp></dt> +<dd><p>Treat any name given on the command line as a new file. This allows +<code>nano</code> to write to named pipes: it will start with a blank buffer, +and will write to the pipe when the user saves the "file". This way +<code>nano</code> can be used as an editor in combination with for instance +<code>gpg</code> without having to write sensitive data to disk first. +</p> +</dd> +<dt><samp>-o <var>directory</var></samp></dt> +<dt><samp>--operatingdir=<var>directory</var></samp></dt> +<dd><p>Set the operating directory. This makes <code>nano</code> set up something +similar to a chroot. +</p> +</dd> +<dt><samp>-p</samp></dt> +<dt><samp>--preserve</samp></dt> +<dd><p>Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the +editor can be stopped and started. +</p> +</dd> +<dt><samp>-q</samp></dt> +<dt><samp>--quiet</samp></dt> +<dd><p>Do not report errors in the nanorc file nor ask them to be acknowledged by pressing Enter at startup. - - <br><dt><code>-r <#cols>, --fill=<#cols></code><dd>Wrap lines at column #cols. If this value is 0 or less, wrapping will -occur at the width of the screen less #cols, allowing it to vary along -with the width of the screen if the screen is resized. The default -value is -8. - - <br><dt><code>-s <prog>, --speller=<prog></code><dd>Invoke the given program as the spell checker. By default, <code>nano</code> -uses the command specified in the SPELL environment variable, or, if -SPELL is not set, its own interactive spell checker that requires the -<code>spell</code> program to be installed on your system. - - <br><dt><code>-t, --tempfile</code><dd>Don't ask whether or not to save the current contents of the file when +</p> +</dd> +<dt><samp>-r <var>number</var></samp></dt> +<dt><samp>--fill=<var>number</var></samp></dt> +<dd><p>Hard-wrap lines at column <var>number</var> (by inserting a newline character). +If the given value is 0 or less, wrapping will occur at the width of +the screen minus the given amount, allowing the wrapping width to +vary along with the width of the screen if and when it is resized. +The default value is ‘<samp>-8</samp>’. This option conflicts with <samp>-w</samp> +– the last one given takes effect. +</p> +</dd> +<dt><samp>-s <var>program</var></samp></dt> +<dt><samp>--speller=<var>program</var></samp></dt> +<dd><p>Invoke the given program as the spell checker. By default, <code>nano</code> +uses the command specified in the <code>SPELL</code> environment variable, or, +if <code>SPELL</code> is not set, its own interactive spell checker that requires +the <code>spell</code> program to be installed on your system. +</p> +</dd> +<dt><samp>-t</samp></dt> +<dt><samp>--tempfile</samp></dt> +<dd><p>Don’t ask whether or not to save the current contents of the file when exiting, assume yes. This is most useful when using <code>nano</code> as the composer of a mailer program. - - <br><dt><code>-u, --undo</code><dd>Enable experimental generic-purpose undo code. By default, the undo and -redo shortcuts are Meta-U and Meta-E, respectively. - - <br><dt><code>-v, --view</code><dd>Don't allow the contents of the file to be altered. Note that this +</p> +</dd> +<dt><samp>-v</samp></dt> +<dt><samp>--view</samp></dt> +<dd><p>Don’t allow the contents of the file to be altered. Note that this option should NOT be used in place of correct file permissions to implement a read-only file. - - <br><dt><code>-w, --nowrap</code><dd>Don't wrap long lines at any length. This option overrides any value -for -r. - - <p><a name="Expert-Mode"></a><br><dt><code>-x, --nohelp</code><dd>Expert Mode: don't show the Shortcut Lists at the bottom of the screen. +</p> +</dd> +<dt><samp>-w</samp></dt> +<dt><samp>--nowrap</samp></dt> +<dd><p>Don’t hard-wrap long lines at any length. This option conflicts with +<samp>-r</samp> – the last one given takes effect. +</p> +<a name="Expert-Mode"></a></dd> +<dt><samp>-x</samp></dt> +<dt><samp>--nohelp</samp></dt> +<dd><p>Expert Mode: don’t show the Shortcut Lists at the bottom of the screen. This affects the location of the statusbar as well, as in Expert Mode it is located at the very bottom of the editor. - - <p>Note: When accessing the help system, Expert Mode is temporarily -disabled to display the help system navigation keys. - - <br><dt><code>-z, --suspend</code><dd>Enable <code>nano</code>'s suspend ability using the system's suspend +</p> +<p>Note: When accessing the help system, Expert Mode is temporarily +disabled to display the help-system navigation keys. +</p> +</dd> +<dt><samp>-z</samp></dt> +<dt><samp>--suspend</samp></dt> +<dd><p>Enable the ability to suspend <code>nano</code> using the system’s suspend keystroke (usually ^Z). - - <br><dt><code>-$, --softwrap</code><dd>Enable 'soft wrapping'. <code>nano</code> will attempt to display the entire -contents of a line, even if it is longer than the screen width. Since -'$' normally refers to a variable in the Unix shell, you should specify -this option last when using other options (e.g. 'nano -wS$') or pass it -separately (e.g. 'nano -wS -$'). - - <br><dt><code>-a, -b, -e, -f, -g, -j</code><dd>Ignored, for compatibility with Pico. +</p> +</dd> +<dt><samp>-$</samp></dt> +<dt><samp>--softwrap</samp></dt> +<dd><p>Enable ’soft wrapping’. This will make <code>nano</code> attempt to display the +entire contents of any line, even if it is longer than the screen width, by +continuing it over multiple screen lines. Since +‘<samp>$</samp>’ normally refers to a variable in the Unix shell, you should specify +this option last when using other options (e.g. <code>nano -wS$</code>) or pass it +separately (e.g. <code>nano -wS -$</code>). +</p> +</dd> +<dt><samp>-a</samp></dt> +<dt><samp>-b</samp></dt> +<dt><samp>-e</samp></dt> +<dt><samp>-f</samp></dt> +<dt><samp>-g</samp></dt> +<dt><samp>-j</samp></dt> +<dd><p>Ignored, for compatibility with Pico. +</p></dd> </dl> -<div class="node"> -<a name="Editor-Basics"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Online-Help">Online Help</a>, -Previous: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> +<hr> +<a name="Editor-Basics"></a> +<div class="header"> +<p> +Next: <a href="#Online-Help" accesskey="n" rel="next">Online 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> </div> - +<a name="Editor-Basics-1"></a> <h2 class="chapter">2 Editor Basics</h2> -<ul class="menu"> -<li><a accesskey="1" href="#Entering-Text">Entering Text</a> -<li><a accesskey="2" href="#Special-Functions">Special Functions</a> -<li><a accesskey="3" href="#The-Titlebar">The Titlebar</a> -<li><a accesskey="4" href="#The-Statusbar">The Statusbar</a> -<li><a accesskey="5" href="#Shortcut-Lists">Shortcut Lists</a> -<li><a accesskey="6" href="#Using-the-Mouse">Using the Mouse</a> -</ul> - -<div class="node"> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#Entering-Text" accesskey="1">Entering Text</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Special-Functions" accesskey="2">Special Functions</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#The-Cutbuffer" accesskey="3">The Cutbuffer</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#The-Mark" accesskey="4">The Mark</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#The-Titlebar" accesskey="5">The Titlebar</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#The-Statusbar" accesskey="6">The Statusbar</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Shortcut-Lists" accesskey="7">Shortcut Lists</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Using-the-Mouse" accesskey="8">Using the Mouse</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr> <a name="Entering-Text"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Special-Functions">Special Functions</a>, -Previous: <a rel="previous" accesskey="p" href="#Editor-Basics">Editor Basics</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +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> </div> - +<a name="Entering-Text-1"></a> <h3 class="section">2.1 Entering Text</h3> -<p>All key sequences in <code>nano</code> are entered using the keyboard. -<code>nano</code> is a "modeless" editor. All keys, with the exception of -Control and Meta key sequences, will enter text into the file being -edited. - -<div class="node"> +<p><code>nano</code> is a "modeless" editor. All keystrokes, with the exception +of Control and Meta key sequences, enter text into the file being edited. +All key sequences in <code>nano</code> are entered using the keyboard. +</p> +<hr> <a name="Special-Functions"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#The-Titlebar">The Titlebar</a>, -Previous: <a rel="previous" accesskey="p" href="#Entering-Text">Entering Text</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +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> </div> - +<a name="Special-Functions-1"></a> <h3 class="section">2.2 Special Functions</h3> -<p>Special functions use the Control (Ctrl) key, displayed in the help and -shortcut lists as ^; the Meta key, displayed as M; or the Escape (Esc) -key. - - <ul> -<li>Control key sequences are entered by holding down the Ctrl key and -pressing the desired key, or by pressing the Esc key twice and pressing -the desired key. -<li>Pressing Esc twice and then typing a three-digit number from 000 to 255 -will enter the character with the corresponding value. -<li>Meta key sequences are entered by holding down the Meta key (normally +<p>Special functions use the Control key (Ctrl), displayed in the help and +shortcut lists as ^; the Meta key (Alt or Cmd), displayed as M-; or the +Escape key (Esc). +</p> +<ul> +<li> Control key sequences are entered by holding down the Ctrl key and +pressing the desired key, or by pressing the Esc key twice and then +pressing the desired key. +</li><li> Pressing the Esc key twice and then typing a three-digit number from +000 to 255 will enter the character with the corresponding value. +</li><li> Meta key sequences are entered by holding down the Meta key (normally the Alt key) and pressing the desired key, or by pressing the Esc key -once and pressing the desired key. Certain operating systems "swallow" +once and then pressing the desired key. Certain operating systems "swallow" the Alt key so that it never reaches the application; if your operating system does this, you should use the Esc key to generate Meta key -sequences. -</ul> +sequences. +</li></ul> -<div class="node"> +<hr> +<a name="The-Cutbuffer"></a> +<div class="header"> +<p> +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> +</div> +<a name="The-Cutbuffer-1"></a> +<h3 class="section">2.3 The Cutbuffer</h3> + +<p>Text can be cut from a file, a whole line at a time, by using the ’Cut Text’ +command (default key binding: ^K). The cut line is stored in the cutbuffer. +Consecutive strokes of ^K will add each cut line to this buffer, but a ^K +after any other keystroke will overwrite the entire cutbuffer. +</p> +<p>The contents of the cutbuffer can be pasted back into the file with the +’Uncut Text’ command (default key binding: ^U). +</p> +<p>A line of text can be copied into the cutbuffer (without cutting it) with +the ’Copy Text’ command (default key binding: M-6). +</p> +<hr> +<a name="The-Mark"></a> +<div class="header"> +<p> +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> +</div> +<a name="The-Mark-1"></a> +<h3 class="section">2.4 The Mark</h3> + +<p>Text can be selected by first ’setting the Mark’ (default key bindings: +^6 and M-A) and then moving the cursor to the other end of the portion +to be selected. The selected portion of text will be highlighted in +reverse video (or in bold if you set the boldtext option). +This selection can now be cut or copied in its entirety with a single +^K or M-6. Or the selection can be used to limit the scope of a +search-and-replace (^\) or spell-checking session (^T). +</p> +<p>Cutting or copying selected text will toggle the mark off automatically. +If necessary, it can be toggled off manually with another ^6 or M-A. +</p> +<hr> <a name="The-Titlebar"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#The-Statusbar">The Statusbar</a>, -Previous: <a rel="previous" accesskey="p" href="#Special-Functions">Special Functions</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +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> </div> - -<h3 class="section">2.3 The Titlebar</h3> +<a name="The-Titlebar-1"></a> +<h3 class="section">2.5 The Titlebar</h3> <p>The titlebar is the line displayed at the top of the editor. There are three sections: left, center and right. The section on the left displays the version of <code>nano</code> being used. The center section -displays the current filename, or "New Buffer" if the file has not yet -been named. The section on the right will display "Modified" if the +displays the current filename, or "New Buffer" if the file has not yet +been named. The section on the right will display "Modified" if the file has been modified since it was last saved or opened. - - <p>Special modes: When <code>nano</code> is in "File browser" mode, the center +</p> +<p>Special modes: When <code>nano</code> is in "File browser" mode, the center section will display the current directory instead of the filename. See See <a href="#The-File-Browser">The File Browser</a>, for more info. - -<div class="node"> +</p> +<hr> <a name="The-Statusbar"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Shortcut-Lists">Shortcut Lists</a>, -Previous: <a rel="previous" accesskey="p" href="#The-Titlebar">The Titlebar</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +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> </div> - -<h3 class="section">2.4 The Statusbar</h3> +<a name="The-Statusbar-1"></a> +<h3 class="section">2.6 The Statusbar</h3> <p>The statusbar is the third line from the bottom of the screen, or the bottom line in Expert Mode. See See <a href="#Expert-Mode">Expert Mode</a>, for more info. It @@ -365,358 +585,1052 @@ shows important and informational messages. Any error messages that occur from using the editor will appear on the statusbar. Any questions that are asked of the user will be asked on the statusbar, and any user input (search strings, filenames, etc.) will be input on the statusbar. - -<div class="node"> +</p> +<hr> <a name="Shortcut-Lists"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Using-the-Mouse">Using the Mouse</a>, -Previous: <a rel="previous" accesskey="p" href="#The-Statusbar">The Statusbar</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +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> </div> - -<h3 class="section">2.5 Shortcut Lists</h3> +<a name="Shortcut-Lists-1"></a> +<h3 class="section">2.7 Shortcut Lists</h3> <p>The Shortcut Lists are the two lines at the bottom of the screen which show some of the more commonly used functions in the editor. - -<div class="node"> +</p> +<hr> <a name="Using-the-Mouse"></a> -<p><hr> -Previous: <a rel="previous" accesskey="p" href="#Shortcut-Lists">Shortcut Lists</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +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> </div> - -<h3 class="section">2.6 Using the Mouse</h3> +<a name="Using-the-Mouse-1"></a> +<h3 class="section">2.8 Using the Mouse</h3> <p>When mouse support has been configured and enabled, a single mouse click places the cursor at the indicated position. Clicking a second time in the same position toggles the mark. Clicking in the shortcut list -executes the selected shortcut. - - <p>The mouse will work in the X Window System, and on the console when gpm +executes the selected shortcut. To be able to select text with the +left button, or paste text with the middle button, hold down the +Shift key during those actions. +</p> +<p>The mouse will work in the X Window System, and on the console when gpm is running. +</p> -<div class="node"> +<hr> <a name="Online-Help"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Feature-Toggles">Feature Toggles</a>, -Previous: <a rel="previous" accesskey="p" href="#Editor-Basics">Editor Basics</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +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> </div> - +<a name="Online-Help-1"></a> <h2 class="chapter">3 Online Help</h2> -<p>The online help system in <code>nano</code> is available by pressing ^G. -It is fairly self explanatory, documenting the various parts of the +<p>The online help system in <code>nano</code> is available by pressing ^G. +It is fairly self-explanatory, documenting the various parts of the editor and available keystrokes. Navigation is via the ^Y (Page Up) and ^V (Page Down) keys. ^X exits the help system. +</p> -<div class="node"> +<hr> <a name="Feature-Toggles"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Nanorc-Files">Nanorc Files</a>, -Previous: <a rel="previous" accesskey="p" href="#Online-Help">Online Help</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +Next: <a href="#Nanorc-Files" accesskey="n" rel="next">Nanorc Files</a>, Previous: <a href="#Online-Help" accesskey="p" rel="prev">Online 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> </div> - +<a name="Feature-Toggles-1"></a> <h2 class="chapter">4 Feature Toggles</h2> <p>Toggles allow you to change certain aspects of the editor that would -normally be done via command line options. They are invoked via Meta +normally be done via command-line options. They are invoked via Meta key sequences. See See <a href="#Special-Functions">Special Functions</a>, for more info. The following global toggles are available: +</p> +<dl compact="compact"> +<dt><code>Backup Files Toggle (Meta-B)</code></dt> +<dd><p>toggles the -B (<code>--backup</code>) command line option. +</p> +</dd> +<dt><code>Constant Cursor Position Display Toggle (Meta-C)</code></dt> +<dd><p>toggles the -c (<code>--const</code>) command line option. +</p> +</dd> +<dt><code>Multiple File Buffers Toggle (Meta-F)</code></dt> +<dd><p>toggles the -F (<code>--multibuffer</code>) command line option. +</p> +</dd> +<dt><code>Smart Home Key Toggle (Meta-H)</code></dt> +<dd><p>toggles the -A (<code>--smarthome</code>) command line option. +</p> +</dd> +<dt><code>Auto Indent Toggle (Meta-I)</code></dt> +<dd><p>toggles the -i (<code>--autoindent</code>) command line option. +</p> +</dd> +<dt><code>Cut To End Toggle (Meta-K)</code></dt> +<dd><p>toggles the -k (<code>--cut</code>) command line option. +</p> +</dd> +<dt><code>Long Line Wrapping Toggle (Meta-L)</code></dt> +<dd><p>toggles the -w (<code>--nowrap</code>) command line option. +</p> +</dd> +<dt><code>Mouse Support Toggle (Meta-M)</code></dt> +<dd><p>toggles the -m (<code>--mouse</code>) command line option. +</p> +</dd> +<dt><code>No Conversion From DOS/Mac Format Toggle (Meta-N)</code></dt> +<dd><p>toggles the -N (<code>--noconvert</code>) command line option. +</p> +</dd> +<dt><code>More Space For Editing Toggle (Meta-O)</code></dt> +<dd><p>toggles the -O (<code>--morespace</code>) command line option. +</p> +</dd> +<dt><code>Whitespace Display Toggle (Meta-P)</code></dt> +<dd><p>toggles whitespace-display mode. +See See <a href="#Whitespace">Whitespace</a>, for more info. +</p> +</dd> +<dt><code>Tabs to Spaces Toggle (Meta-Q)</code></dt> +<dd><p>toggles the -E (<code>--tabstospaces</code>) command line option. +</p> +</dd> +<dt><code>Smooth Scrolling Toggle (Meta-S)</code></dt> +<dd><p>toggles the -S (<code>--smooth</code>) command line option. +</p> +</dd> +<dt><code>Expert/No Help Toggle (Meta-X)</code></dt> +<dd><p>toggles the -x (<code>--nohelp</code>) command line option. +</p> +</dd> +<dt><code>Color Syntax Highlighting Toggle (Meta-Y)</code></dt> +<dd><p>toggles color syntax highlighting if you have color syntaxes in your +nanorc. See See <a href="#Syntax-Highlighting">Syntax Highlighting</a>, for more info. +</p> +</dd> +<dt><code>Suspend Toggle (Meta-Z)</code></dt> +<dd><p>toggles the -z (<code>--suspend</code>) command line option. +</p> +</dd> +<dt><code>Soft Wrapping Toggle (Meta-$)</code></dt> +<dd><p>toggles the -$ (<code>--softwrap</code>) command line option. +</p> +</dd> +</dl> - <dl> -<dt><code>Backup Files Toggle (Meta-B)</code><dd>toggles the -B (<code>--backup</code>) command line option. - - <br><dt><code>Constant Cursor Position Display Toggle (Meta-C)</code><dd>toggles the -c (<code>--const</code>) command line option. - - <br><dt><code>Multiple File Buffers Toggle (Meta-F)</code><dd>toggles the -F (<code>--multibuffer</code>) command line option. - - <br><dt><code>Smart Home Key Toggle (Meta-H)</code><dd>toggles the -A (<code>--smarthome</code>) command line option. - - <br><dt><code>Auto Indent Toggle (Meta-I)</code><dd>toggles the -i (<code>--autoindent</code>) command line option. - - <br><dt><code>Cut To End Toggle (Meta-K)</code><dd>toggles the -k (<code>--cut</code>) command line option. - - <br><dt><code>Long Line Wrapping Toggle (Meta-L)</code><dd>toggles the -w (<code>--nowrap</code>) command line option. - - <br><dt><code>Mouse Support Toggle (Meta-M)</code><dd>toggles the -m (<code>--mouse</code>) command line option. - - <br><dt><code>No Conversion From DOS/Mac Format Toggle (Meta-N)</code><dd>toggles the -N (<code>--noconvert</code>) command line option. - - <br><dt><code>More Space For Editing Toggle (Meta-O)</code><dd>toggles the -O (<code>--morespace</code>) command line option. - - <br><dt><code>Whitespace Display Toggle (Meta-P)</code><dd>toggles whitespace display mode if you have a "whitespace" option in -your nanorc. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. - - <br><dt><code>Tabs to Spaces Toggle (Meta-Q)</code><dd>toggles the -E (<code>--tabstospaces</code>) command line option. - - <br><dt><code>Smooth Scrolling Toggle (Meta-S)</code><dd>toggles the -S (<code>--smooth</code>) command line option. - - <br><dt><code>Expert/No Help Toggle (Meta-X)</code><dd>toggles the -x (<code>--nohelp</code>) command line option. - - <br><dt><code>Color Syntax Highlighting Toggle (Meta-Y)</code><dd>toggles color syntax highlighting if you have color syntaxes in your -nanorc. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. - - <br><dt><code>Suspend Toggle (Meta-Z)</code><dd>toggles the -z (<code>--suspend</code>) command line option. - - <br><dt><code>Soft Wrapping Toggle (Meta-$)</code><dd>toggles the -$ (<code>--softwrap</code>) command line option. - - </dl> -<div class="node"> +<hr> <a name="Nanorc-Files"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#The-File-Browser">The File Browser</a>, -Previous: <a rel="previous" accesskey="p" href="#Feature-Toggles">Feature Toggles</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +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> </div> - +<a name="Nanorc-Files-1"></a> <h2 class="chapter">5 Nanorc Files</h2> <p>The nanorc files contain the default settings for <code>nano</code>. They -should not be in DOS or Mac format. During startup, <code>nano</code> will -first read its system-wide settings from SYSCONFDIR/nanorc, and then -user-specific settings from ~/.nanorc. - - <p>A nanorc file accepts a series of "set" and "unset" commands, which can -be used to configure <code>nano</code> on startup without using the command -line options. Additionally, the "syntax", "color", and "icolor" -keywords are used to define syntax highlighting rules for different text -patterns. <code>nano</code> will read one command per line. - - <p>Options in nanorc files take precedence over <code>nano</code>'s defaults, and -command line options override nanorc settings. Options are also unset -by default, except for those that take arguments. - - <p>Quotes inside string parameters don't have to be escaped with +should be in Unix format, not in DOS or Mac format. During startup, +<code>nano</code> will first read the system-wide settings, from /etc/nanorc +(the exact path might be different), and then the user-specific settings, +from ~/.nanorc. +</p> +<p>A nanorc file accepts a series of "set" and "unset" commands, which can +be used to configure <code>nano</code> on startup without using command-line +options. Additionally, there are some commands to define syntax highlighting +and to rebind keys – See <a href="#Syntax-Highlighting">Syntax Highlighting</a>, and See <a href="#Rebinding-Keys">Rebinding Keys</a>. +<code>nano</code> will read one command per line. +</p> +<p>Options in nanorc files take precedence over <code>nano</code>’s defaults, and +command-line options override nanorc settings. Also, options that do not +take an argument are unset by default. So using the <code>unset</code> command +is only needed when wanting to override a setting of the system’s nanorc +file in your own <samp>~/.nanorc</samp>. Options that take an argument cannot +be unset. +</p> +<p>Quotes inside string parameters don’t have to be escaped with backslashes. The last double quote in the string will be treated as its -end. For example, for the "brackets" option, - - <blockquote> -<code>""')>]}"</code> -</blockquote> - - <p>will match <code>"</code>, <code>'</code>, <code>)</code>, <code>></code>, <code>]</code>, and -<code>}</code>. - - <p>The supported commands and arguments are: - - <dl> -<dt><code>set/unset autoindent</code><dd>Use auto-indentation. - - <br><dt><code>set/unset backup</code><dd>Create backup files in "filename~". - - <br><dt><code>set backupdir "directory"</code><dd>Set the directory where <code>nano</code> puts unique backup files if file +end. For example, for the "brackets" option, <code>""')>]}"</code> will match +<code>"</code>, <code>'</code>, <code>)</code>, <code>></code>, <code>]</code>, and <code>}</code>. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#Settings" accesskey="1">Settings</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Syntax-Highlighting" accesskey="2">Syntax Highlighting</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Rebinding-Keys" accesskey="3">Rebinding Keys</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr> +<a name="Settings"></a> +<div class="header"> +<p> +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> +</div> +<a name="Settings-1"></a> +<h3 class="section">5.1 Settings</h3> + +<p>The supported settings in a nanorc file are: +</p> +<dl compact="compact"> +<dt><code>set allow_insecure_backup</code></dt> +<dd><p>When backing up files, allow the backup to succeed even if its +permissions can’t be (re)set due to special OS considerations. +You should NOT enable this option unless you are sure you need it. +</p> +</dd> +<dt><code>set autoindent</code></dt> +<dd><p>Use auto-indentation. +</p> +</dd> +<dt><code>set backup</code></dt> +<dd><p>When saving a file, back up the previous version of it to the current +filename suffixed with a tilde (<code>~</code>). +</p> +</dd> +<dt><code>set backupdir "directory"</code></dt> +<dd><p>Set the directory where <code>nano</code> puts unique backup files, if file backups are enabled. - - <br><dt><code>set/unset backwards</code><dd>Do backwards searches by default. - - <br><dt><code>set/unset boldtext</code><dd>Use bold text instead of reverse video text. - - <br><dt><code>set brackets "string"</code><dd>Set the characters treated as closing brackets when justifying -paragraphs. They cannot contain blank characters. Only closing -punctuation, optionally followed by closing brackets, can end sentences. +</p> +</dd> +<dt><code>set backwards</code></dt> +<dd><p>Do backwards searches by default. +</p> +</dd> +<dt><code>set boldtext</code></dt> +<dd><p>Use bold instead of reverse video for the titlebar, statusbar, key combos, +and selected text. This can be overridden for the first three by setting +the options "titlecolor", "statuscolor", and "keycolor". +</p> +</dd> +<dt><code>set brackets "<var>string</var>"</code></dt> +<dd><p>Set the characters treated as closing brackets when justifying +paragraphs. This may not include blank characters. Only closing +punctuation (see "punct"), optionally followed by the specified +closing brackets, can end sentences. The default value is +</p> +<blockquote> +<p>""’)>]}" +</p></blockquote> + +</dd> +<dt><code>set casesensitive</code></dt> +<dd><p>Do case-sensitive searches by default. +</p> +</dd> +<dt><code>set const</code></dt> +<dd><p>Constantly display the cursor position in the status bar. +</p> +</dd> +<dt><code>set cut</code></dt> +<dd><p>Use cut-to-end-of-line by default, instead of cutting the whole line. +</p> +</dd> +<dt><code>set fill <var>number</var></code></dt> +<dd><p>Hard-wrap lines at column number <var>number</var>. If <var>number</var> is 0 or less, +the maximum line length will be the screen width less <var>number</var> columns. +The default value is -8. +</p> +</dd> +<dt><code>set functioncolor <var>fgcolor</var>,<var>bgcolor</var></code></dt> +<dd><p>Specify the color combination to use for the function descriptions +in the two help lines at the bottom of the screen. +See <code>set titlecolor</code> for more details. +</p> +</dd> +<dt><code>set historylog</code></dt> +<dd><p>Enable the use of <samp>~/.nano/search_history</samp> for saving and reading +search/replace strings. +</p> +</dd> +<dt><code>set keycolor <var>fgcolor</var>,<var>bgcolor</var></code></dt> +<dd><p>Specify the color combination to use for the shortcut key combos +in the two help lines at the bottom of the screen. +See <code>set titlecolor</code> for more details. +</p> +</dd> +<dt><code>set locking</code></dt> +<dd><p>Enable vim-style lock-files for when editing files. +</p> +</dd> +<dt><code>set matchbrackets "<var>string</var>"</code></dt> +<dd><p>Set the opening and closing brackets that can be found by bracket +searches. This may not include blank characters. The opening set must +come before the closing set, and the two sets must be in the same order. The default value is - - <blockquote> -<code>""')>]}"</code> -</blockquote> - - <br><dt><code>set/unset casesensitive</code><dd>Do case sensitive searches by default. - - <br><dt><code>set/unset const</code><dd>Constantly display the cursor position in the status bar. - - <br><dt><code>set/unset cut</code><dd>Use cut to end of line by default, instead of cutting the whole line. - - <br><dt><code>set fill "n"</code><dd>Wrap lines at column number "n". If "n" is 0 or less, the maximum line -length will be the screen width less "n" columns. The default value is --8. - - <br><dt><code>set/unset historylog</code><dd>Enable ~/.nano_history for saving and reading search/replace strings. - - <br><dt><code>set matchbrackets "string"</code><dd>Set the opening and closing brackets that can be found by bracket -searches. They cannot contain blank characters. The former set must -come before the latter set, and both must be in the same order. The -default value is - - <blockquote> -<code>"(<[{)>]}"</code> -</blockquote> - - <br><dt><code>set/unset morespace</code><dd>Use the blank line below the titlebar as extra editing space. - - <br><dt><code>set/unset mouse</code><dd>Enable mouse support, so that mouse clicks can be used to place the +</p> +<blockquote> +<p>"(<[{)>]}" +</p></blockquote> + +</dd> +<dt><code>set morespace</code></dt> +<dd><p>Use the blank line below the titlebar as extra editing space. +</p> +</dd> +<dt><code>set mouse</code></dt> +<dd><p>Enable mouse support, so that mouse clicks can be used to place the cursor, set the mark (with a double click), or execute shortcuts. - - <br><dt><code>set/unset multibuffer</code><dd>Allow inserting files into their own buffers. - - <br><dt><code>set/unset noconvert</code><dd>Don't convert files from DOS/Mac format. - - <br><dt><code>set/unset nofollow</code><dd>Don't follow symlinks when writing files. - - <br><dt><code>set/unset nohelp</code><dd>Don't display the help lists at the bottom of the screen. - - <br><dt><code>set/unset nonewlines</code><dd>Don't add newlines to the ends of files. - - <br><dt><code>set/unset nowrap</code><dd>Don't wrap text at all. - - <br><dt><code>set operatingdir "directory"</code><dd><code>nano</code> will only read and write files inside "directory" and its +</p> +</dd> +<dt><code>set multibuffer</code></dt> +<dd><p>Allow inserting files into their own buffers. +</p> +</dd> +<dt><code>set noconvert</code></dt> +<dd><p>Don’t convert files from DOS/Mac format. +</p> +</dd> +<dt><code>set nofollow</code></dt> +<dd><p>Don’t follow symlinks when writing files. +</p> +</dd> +<dt><code>set nohelp</code></dt> +<dd><p>Don’t display the help lists at the bottom of the screen. +</p> +</dd> +<dt><code>set nonewlines</code></dt> +<dd><p>Don’t add newlines to the ends of files. +</p> +</dd> +<dt><code>set nowrap</code></dt> +<dd><p>Don’t hard-wrap text at all. +</p> +</dd> +<dt><code>set operatingdir "directory"</code></dt> +<dd><p><code>nano</code> will only read and write files inside "directory" and its subdirectories. Also, the current directory is changed to here, so files are inserted from this directory. By default, the operating directory feature is turned off. - - <br><dt><code>set/unset preserve</code><dd>Preserve the XON and XOFF keys (^Q and ^S). - - <br><dt><code>set punct "string"</code><dd>Set the characters treated as closing punctuation when justifying -paragraphs. They cannot contain blank characters. Only closing -punctuation, optionally followed by closing brackets, can end sentences. -The default value is <code>"!.?"</code>. - - <br><dt><code>set/unset quickblank</code><dd>Do quick statusbar blanking. Statusbar messages will disappear after 1 +</p> +</dd> +<dt><code>set poslog</code></dt> +<dd><p>Save the cursor position of files between editing sessions. +</p> +</dd> +<dt><code>set preserve</code></dt> +<dd><p>Preserve the XON and XOFF keys (^Q and ^S). +</p> +</dd> +<dt><code>set punct "<var>string</var>"</code></dt> +<dd><p>Set the characters treated as closing punctuation when justifying +paragraphs. This may not include blank characters. Only the +specified closing punctuation, optionally followed by closing brackets +(see "brackets"), can end sentences. The default value is "!.?". +</p> +</dd> +<dt><code>set quickblank</code></dt> +<dd><p>Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25. - - <br><dt><code>set quotestr "string"</code><dd>The email-quote string, used to justify email-quoted paragraphs. This +</p> +</dd> +<dt><code>set quiet</code></dt> +<dd><p>When set, <code>nano</code> will not report errors in the nanorc file nor ask them +to be acknowledged by pressing Enter at startup. If this option is used, it +should be placed at the top of the file to be fully effective. +</p> +</dd> +<dt><code>set quotestr "<var>string</var>"</code></dt> +<dd><p>The email-quote string, used to justify email-quoted paragraphs. This is an extended regular expression if your system supports them, otherwise a literal string. The default value is - - <blockquote> -<code>"^([ \\t]*[#:>\\|}])+"</code> -</blockquote> - - <p>if you have extended regular expression support, or "> " otherwise. -Note that '\\t' stands for a literal Tab character. - - <br><dt><code>set/unset rebinddelete</code><dd>Interpret the Delete key differently so that both Backspace and Delete +</p> +<blockquote> +<p>"^([ \\t]*[#:>\\|}])+" +</p></blockquote> + +<p>if you have extended regular expression support, and "> " otherwise. +Note that ’\\t’ stands for a literal Tab character. +</p> +</dd> +<dt><code>set rebinddelete</code></dt> +<dd><p>Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. - - <br><dt><code>set/unset rebindkeypad</code><dd>Interpret the numeric keypad keys so that they all work properly. You -should only need to use this option if they don't, as mouse support -won't work properly with this option enabled. - - <br><dt><code>set/unset regexp</code><dd>Do extended regular expression searches by default. - - <br><dt><code>set/unset smarthome</code><dd>Make the Home key smarter. When Home is pressed anywhere but at the +</p> +</dd> +<dt><code>set rebindkeypad</code></dt> +<dd><p>Interpret the numeric keypad keys so that they all work properly. You +should only need to use this option if they don’t, as mouse support +won’t work properly with this option enabled. +</p> +</dd> +<dt><code>set regexp</code></dt> +<dd><p>Do extended regular expression searches by default. +</p> +</dd> +<dt><code>set smarthome</code></dt> +<dd><p>Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line. - - <br><dt><code>set/unset smooth</code><dd>Use smooth scrolling by default. - - <br><dt><code>set/unset softwrap</code><dd>Use soft wrapping by default. - - <br><dt><code>set speller "spellprog"</code><dd>Use spelling checker "spellprog" instead of the built-in one, which -calls "spell". - - <br><dt><code>set/unset suspend</code><dd>Allow <code>nano</code> to be suspended. - - <br><dt><code>set/unset suspendenable</code><dd>If <code>nano</code> is allowed to be suspended, allow the suspend key -(usually ^Z) to actually suspend it. - - <br><dt><code>set tabsize "n"</code><dd>Use a tab size of "n" columns. The value of "n" must be greater than 0. -The default value is 8. - - <br><dt><code>set/unset tabstospaces</code><dd>Convert typed tabs to spaces. - - <br><dt><code>set/unset tempfile</code><dd>Save automatically on exit, don't prompt. - - <br><dt><code>set/unset undo</code><dd>Enable experimental generic-purpose undo code. - - <br><dt><code>set/unset view</code><dd>Disallow file modification. - - <br><dt><code>set whitespace "string"</code><dd>Set the two characters used to display the first characters of tabs and -spaces. They must be single-column characters. - - <br><dt><code>set/unset wordbounds</code><dd>Detect word boundaries more accurately by treating punctuation +</p> +</dd> +<dt><code>set smooth</code></dt> +<dd><p>Use smooth scrolling by default. +</p> +</dd> +<dt><code>set softwrap</code></dt> +<dd><p>Enable soft line wrapping for easier viewing of very long lines. +</p> +</dd> +<dt><code>set speller "spellprog"</code></dt> +<dd><p>Use spelling checker "spellprog" instead of the built-in one, which +calls "spell". +</p> +</dd> +<dt><code>set statuscolor <var>fgcolor</var>,<var>bgcolor</var></code></dt> +<dd><p>Specify the color combination to use for the statusbar. +See <code>set titlecolor</code> for more details. +</p> +</dd> +<dt><code>set suspend</code></dt> +<dd><p>Allow <code>nano</code> to be suspended. +</p> +</dd> +<dt><code>set tabsize <var>number</var></code></dt> +<dd><p>Use a tab size of <var>number</var> columns. The value of <var>number</var> must be +greater than 0. The default value is 8. +</p> +</dd> +<dt><code>set tabstospaces</code></dt> +<dd><p>Convert typed tabs to spaces. +</p> +</dd> +<dt><code>set tempfile</code></dt> +<dd><p>Save automatically on exit, don’t prompt. +</p> +</dd> +<dt><code>set titlecolor <var>fgcolor</var>,<var>bgcolor</var></code></dt> +<dd><p>Specify the color combination to use for the titlebar. +Valid color names for foreground and background are: +white, black, red, blue, green, yellow, magenta, and cyan. +And either <var>fgcolor</var> or <var>,bgcolor</var> may be left out. +</p> +</dd> +<dt><code>set view</code></dt> +<dd><p>Disallow file modification. +</p> +<a name="Whitespace"></a></dd> +<dt><code>set whitespace "<var>string</var>"</code></dt> +<dd><p>Set the two characters used to indicate the presence of tabs and +spaces. They must be single-column characters. The default pair +for a UTF-8 locale is "»·", and for other locales ">.". +</p> +</dd> +<dt><code>set wordbounds</code></dt> +<dd><p>Detect word boundaries more accurately by treating punctuation characters as part of a word. +</p> +</dd> +</dl> - <br><dt><code>syntax "str" ["fileregex" ... ]</code><dd>Defines a syntax named "str" which can be activated via the -Y/–syntax -command line option, or will be automatically activated if the current -filename matches the extended regular expression "fileregex". All -following "color" and "icolor" statements will apply to "syntax" until a -new syntax is defined. - - <p>The "none" syntax is reserved; specifying it on the command line is the -same as not having a syntax at all. The "default" syntax is special: it -takes no "fileregex", and applies to files that don't match any other -syntax's "fileregex". - - <br><dt><code>color fgcolor,bgcolor "regex" ...</code><dd>For the currently defined syntax, display all expressions matching the -extended regular expression "regex" with foreground color "fgcolor" and -background color "bgcolor", at least one of which must be specified. -Legal colors for foreground and background color are: white, black, red, -blue, green, yellow, magenta, and cyan. You may use the prefix "bright" -to force a stronger color highlight for the foreground. If your -terminal supports transparency, not specifying a "bgcolor" tells "nano" +<hr> +<a name="Syntax-Highlighting"></a> +<div class="header"> +<p> +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> +</div> +<a name="Syntax-Highlighting-1"></a> +<h3 class="section">5.2 Syntax Highlighting</h3> + +<p>Coloring the different syntactic elements of a file +is done via regular expressions (see the <code>color</code> command below). +This is inherently imperfect, because regular expressions are not +powerful enough to fully parse a file. Nevertheless, regular +expressions can do a lot and are easy to make, so they are a +good fit for a small editor like <code>nano</code>. +</p> +<p>A separate syntax can be defined for each kind of file +via the following commands in a nanorc file: +</p> +<dl compact="compact"> +<dt><code>syntax "str" ["fileregex" …]</code></dt> +<dd><p>Defines a syntax named "str" which can be activated via the -Y/–syntax +command-line option, or will be automatically activated if the current +filename matches the extended regular expression "fileregex". All +following "color" and "icolor" statements will apply to this "str" +syntax until a new syntax is defined. +</p> +<p>The "none" syntax is reserved; specifying it on the command line is the +same as not having a syntax at all. The "default" syntax is special: it +takes no "fileregex", and applies to files that don’t match any other +syntax’s "fileregex". +</p> +</dd> +<dt><code>linter program [arg …]</code></dt> +<dd><p>For the currently defined syntax, use the given program to invoke the +linter (this overrides the speller function when defined). +</p> +</dd> +<dt><code>formatter program [arg …]</code></dt> +<dd><p>For the currently defined syntax, use the given program to automatically +reformat text. Useful in certain programming languages (e.g. go). +</p> +</dd> +<dt><code>header "regex" …</code></dt> +<dd><p>For the currently defined syntax, add one or more regexes which will +be compared against the very first line of the file to be edited, +to determine whether this syntax should be used for that file. +</p> +</dd> +<dt><code>magic "regex" …</code></dt> +<dd><p>For the currently defined syntax, add one or more regexes which will be +compared against the result of querying the magic database about the file +to be edited, to determine whether this syntax should be used for that +file. This functionality only works when libmagic is installed on the +system and will be silently ignored otherwise. +</p> +</dd> +<dt><code>color fgcolor,bgcolor "regex" …</code></dt> +<dd><p>For the currently defined syntax, display all expressions matching the +extended regular expression "regex" with foreground color "fgcolor" and +background color "bgcolor", at least one of which must be specified. +Valid colors for foreground and background are: white, black, red, +blue, green, yellow, magenta, and cyan. You may use the prefix "bright" +to get a stronger color highlight for the foreground. If your +terminal supports transparency, not specifying a "bgcolor" tells <code>nano</code> to attempt to use a transparent background. +</p> +</dd> +<dt><code>icolor fgcolor,bgcolor "regex" …</code></dt> +<dd><p>Same as above, except that the expression matching is case insensitive. +</p> +</dd> +<dt><code>color fgcolor,bgcolor start="sr" end="er"</code></dt> +<dd><p>Display expressions which start with the extended regular expression +"sr" and end with the extended regular expression "er" with foreground +color "fgcolor" and background color "bgcolor", at least one of which +must be specified. This allows syntax highlighting to span multiple +lines. Note that all subsequent instances of "sr" after an initial "sr" +is found will be highlighted until the first instance of "er". +</p> +</dd> +<dt><code>icolor fgcolor,bgcolor start="sr" end="er"</code></dt> +<dd><p>Same as above, except that the expression matching is case insensitive. +</p> +</dd> +<dt><code>include "syntaxfile"</code></dt> +<dd><p>Read in self-contained color syntaxes from "syntaxfile". Note that +"syntaxfile" can only contain the above commands, from "syntax" to +"icolor". +</p> +</dd> +<dt><code>extendsyntax str directive [arg …]</code></dt> +<dd><p>Extend the syntax previously defined as str to include new information. +Allows you to add a new color, icolor, magic, header, or linter directive +to an already defined syntax. Useful when you want to add to definitions +from the system-installed syntax definitions (which are normally not writable). +</p> +</dd> +</dl> - <br><dt><code>icolor fgcolor,bgcolor "regex" ...</code><dd>Same as above, except that the expression matching is case insensitive. +<hr> +<a name="Rebinding-Keys"></a> +<div class="header"> +<p> +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> +</div> +<a name="Rebinding-Keys-1"></a> +<h3 class="section">5.3 Rebinding Keys</h3> + +<p>Key bindings may be reassigned via the following two commands in a +nanorc file: +</p> +<dl compact="compact"> +<dt><code>bind key function menu</code></dt> +<dd><p>Rebinds <code>key</code> to <code>function</code> in the context of <code>menu</code> +(or in all menus where the function exists by using <code>all</code>). +</p> +</dd> +<dt><code>unbind key menu</code></dt> +<dd><p>Unbinds <code>key</code> from <code>menu</code> +(or from all menus where it exists by using <code>all</code>). +</p> +</dd> +</dl> - <br><dt><code>color fgcolor,bgcolor start="sr" end="er"</code><dd>Display expressions which start with the extended regular expression -"sr" and end with the extended regular expression "er" with foreground -color "fgcolor" and background color "bgcolor", at least one of which -must be specified. This allows syntax highlighting to span multiple -lines. Note that all subsequent instances of "sr" after an initial "sr" -is found will be highlighted until the first instance of "er". +<p>The format of <code>key</code> should be one of: +</p> +<dl compact="compact"> +<dt><code>^</code></dt> +<dd><p>followed by an alpha character or the word "Space". +Example: <code>^C</code> +</p> +</dd> +<dt><code>M-</code></dt> +<dd><p>followed by a printable character or the word "Space". +Example: <code>M-C</code> +</p> +</dd> +<dt><code>F</code></dt> +<dd><p>followed by a numeric value from 1 to 16. +Example: <code>F10</code> +</p> +</dd> +</dl> - <br><dt><code>icolor fgcolor,bgcolor start="sr" end="er"</code><dd>Same as above, except that the expression matching is case insensitive. +<p>Valid names for the <code>function</code> to be bound are: +</p> +<dl compact="compact"> +<dt><code>help</code></dt> +<dd><p>Invokes the help viewer. +</p> +</dd> +<dt><code>cancel</code></dt> +<dd><p>Cancels the current command. +</p> +</dd> +<dt><code>exit</code></dt> +<dd><p>Exits from the program (or from the help viewer or the file browser). +</p> +</dd> +<dt><code>writeout</code></dt> +<dd><p>Writes the current buffer to disk. +</p> +</dd> +<dt><code>insert</code></dt> +<dd><p>Inserts a file into the current buffer (or into a new buffer when multibuffer +is enabled). +</p> +</dd> +<dt><code>whereis</code></dt> +<dd><p>Searches for text in the current buffer – or for filenames matching +a string in the current list in the file browser +</p> +</dd> +<dt><code>searchagain</code></dt> +<dd><p>Repeats the last search command. +</p> +</dd> +<dt><code>replace</code></dt> +<dd><p>Interactively replaces text within the current buffer. +</p> +</dd> +<dt><code>cut</code></dt> +<dd><p>Cuts and stores the current line (or the marked region). +</p> +</dd> +<dt><code>copytext</code></dt> +<dd><p>Copies the current line (or the marked region) without deleting it. +</p> +</dd> +<dt><code>uncut</code></dt> +<dd><p>Copies the currently stored text into the current buffer at the +current cursor position. +</p> +</dd> +<dt><code>mark</code></dt> +<dd><p>Sets the mark at the current position, to start selecting text. +</p> +</dd> +<dt><code>cutrestoffile</code></dt> +<dd><p>Cuts all text from the cursor position till the end of the buffer. +</p> +</dd> +<dt><code>curpos</code></dt> +<dd><p>Shows the current cursor position: the line, column, and character positions. +</p> +</dd> +<dt><code>wordcount</code></dt> +<dd><p>Counts the number of words, lines and characters in the current buffer. +</p> +</dd> +<dt><code>speller</code></dt> +<dd><p>Invokes a spell-checking program (or a linting program, if the current +syntax highlighting defines one). +</p> +</dd> +<dt><code>justify</code></dt> +<dd><p>Justifies the current paragraph. +</p> +</dd> +<dt><code>fulljustify</code></dt> +<dd><p>Justifies the entire current buffer. +</p> +</dd> +<dt><code>indent</code></dt> +<dd><p>Indents (shifts to the right) the currently marked text. +</p> +</dd> +<dt><code>unindent</code></dt> +<dd><p>Unindents (shifts to the left) the currently marked text. +</p> +</dd> +<dt><code>left</code></dt> +<dd><p>Goes left one position (in the editor or browser). +</p> +</dd> +<dt><code>right</code></dt> +<dd><p>Goes right one position (in the editor or browser). +</p> +</dd> +<dt><code>up</code></dt> +<dd><p>Goes one line up (in the editor or browser). +</p> +</dd> +<dt><code>down</code></dt> +<dd><p>Goes one line down (in the editor or browser). +</p> +</dd> +<dt><code>scrollup</code></dt> +<dd><p>Scrolls up one line of text from the current position. +</p> +</dd> +<dt><code>scrolldown</code></dt> +<dd><p>Scrolls down one line of text from the current position. +</p> +</dd> +<dt><code>nextword</code></dt> +<dd><p>Moves the cursor to the beginning of the next word. +</p> +</dd> +<dt><code>prevword</code></dt> +<dd><p>Moves the cursor to the beginning of the previous word. +</p> +</dd> +<dt><code>home</code></dt> +<dd><p>Moves the cursor to the beginning of the current line. +</p> +</dd> +<dt><code>end</code></dt> +<dd><p>Moves the cursor to the end of the current line. +</p> +</dd> +<dt><code>beginpara</code></dt> +<dd><p>Moves the cursor to the beginning of the current paragraph. +</p> +</dd> +<dt><code>endpara</code></dt> +<dd><p>Moves the cursor to the end of the current paragraph. +</p> +</dd> +<dt><code>prevpage</code></dt> +<dd><p>Goes up one screenful. +</p> +</dd> +<dt><code>nextpage</code></dt> +<dd><p>Goes down one screenful. +</p> +</dd> +<dt><code>firstline</code></dt> +<dd><p>Goes to the first line of the file. +</p> +</dd> +<dt><code>lastline</code></dt> +<dd><p>Goes to the last line of the file. +</p> +</dd> +<dt><code>gotoline</code></dt> +<dd><p>Goes to a specific line (and column if specified). +</p> +</dd> +<dt><code>gototext</code></dt> +<dd><p>Switches from targeting a line number to searching for text. +</p> +</dd> +<dt><code>findbracket</code></dt> +<dd><p>Moves the cursor to the bracket (brace, parenthesis, etc.) that matches +(pairs) with the one under the cursor. +</p> +</dd> +<dt><code>prevbuf</code></dt> +<dd><p>Switches to editing/viewing the previous buffer when using multibuffer mode. +</p> +</dd> +<dt><code>nextbuf</code></dt> +<dd><p>Switches to editing/viewing the next buffer when using multibuffer mode. +</p> +</dd> +<dt><code>verbatim</code></dt> +<dd><p>Inserts the next character verbatim into the file. +</p> +</dd> +<dt><code>tab</code></dt> +<dd><p>Inserts a tab at the current cursor location. +</p> +</dd> +<dt><code>enter</code></dt> +<dd><p>Inserts a new line below the current one. +</p> +</dd> +<dt><code>delete</code></dt> +<dd><p>Deletes the character under the cursor. +</p> +</dd> +<dt><code>backspace</code></dt> +<dd><p>Deletes the character before the cursor. +</p> +</dd> +<dt><code>undo</code></dt> +<dd><p>Undoes the last performed text action (add text, delete text, etc). +</p> +</dd> +<dt><code>redo</code></dt> +<dd><p>Redoes the last undone action (i.e., it undoes an undo). +</p> +</dd> +<dt><code>refresh</code></dt> +<dd><p>Refreshes the screen. +</p> +</dd> +<dt><code>suspend</code></dt> +<dd><p>Suspends the editor (if the suspending function is enabled, see the +"suspendenable" entry below). +</p> +</dd> +<dt><code>casesens</code></dt> +<dd><p>Toggles case sensitivity in searching (search/replace menus only). +</p> +</dd> +<dt><code>regexp</code></dt> +<dd><p>Toggles whether searching/replacing is based on literal strings or regular expressions. +</p> +</dd> +<dt><code>backwards</code></dt> +<dd><p>Toggles whether searching/replacing goes forward or backward. +</p> +</dd> +<dt><code>prevhistory</code></dt> +<dd><p>Shows the previous history entry in the prompt menus (e.g. search). +</p> +</dd> +<dt><code>nexthistory</code></dt> +<dd><p>Shows the next history entry in the prompt menus (e.g. search). +</p> +</dd> +<dt><code>flipreplace</code></dt> +<dd><p>Toggles between searching for something and replacing something. +</p> +</dd> +<dt><code>flipexecute</code></dt> +<dd><p>Toggles between inserting a file and executing a command. +</p> +</dd> +<dt><code>flipnewbuffer</code></dt> +<dd><p>Toggles between inserting into the current buffer and into a new +empty buffer. +</p> +</dd> +<dt><code>dosformat</code></dt> +<dd><p>When writing a file, switches to writing a DOS format (CR/LF). +</p> +</dd> +<dt><code>macformat</code></dt> +<dd><p>When writing a file, switches to writing a Mac format. +</p> +</dd> +<dt><code>append</code></dt> +<dd><p>When writing a file, appends to the end instead of overwriting. +</p> +</dd> +<dt><code>prepend</code></dt> +<dd><p>When writing a file, ’prepends’ (writes at the beginning) instead of overwriting. +</p> +</dd> +<dt><code>backup</code></dt> +<dd><p>When writing a file, creates a backup of the current file. +</p> +</dd> +<dt><code>tofiles</code></dt> +<dd><p>Starts the file browser, allowing to select a file from a list. +</p> +</dd> +<dt><code>gotodir</code></dt> +<dd><p>Goes to a directory to be specified, allowing to browse anywhere +in the filesystem. +</p> +</dd> +<dt><code>firstfile</code></dt> +<dd><p>Goes to the first file when using the file browser (reading or writing files). +</p> +</dd> +<dt><code>lastfile</code></dt> +<dd><p>Goes to the last file when using the file browser (reading or writing files). +</p> +</dd> +<dt><code>nohelp</code></dt> +<dd><p>Toggles the presence of the two-line list of key bindings at the bottom of the screen. +</p> +</dd> +<dt><code>constupdate</code></dt> +<dd><p>Toggles the constant display of the current line, column, and character positions. +</p> +</dd> +<dt><code>morespace</code></dt> +<dd><p>Toggles the presence of the blank line which ’separates’ the titlebar from the file text. +</p> +</dd> +<dt><code>smoothscroll</code></dt> +<dd><p>Toggles smooth scrolling (when moving around with the arrow keys). +</p> +</dd> +<dt><code>softwrap</code></dt> +<dd><p>Toggles the displaying of overlong lines on multiple screen lines. +</p> +</dd> +<dt><code>whitespacedisplay</code></dt> +<dd><p>Toggles the showing of whitespace. +</p> +</dd> +<dt><code>nosyntax</code></dt> +<dd><p>Toggles syntax highlighting. +</p> +</dd> +<dt><code>smarthome</code></dt> +<dd><p>Toggles the smartness of the Home key. +</p> +</dd> +<dt><code>autoindent</code></dt> +<dd><p>Toggles whether new lines will contain the same amount of whitespace as the preceding line. +</p> +</dd> +<dt><code>cuttoend</code></dt> +<dd><p>Toggles whether cutting text will cut the whole line or just from the current cursor +position to the end of the line. +</p> +</dd> +<dt><code>nowrap</code></dt> +<dd><p>Toggles whether long lines will be hard-wrapped to the next line. +</p> +</dd> +<dt><code>tabstospaces</code></dt> +<dd><p>Toggles whether typed tabs will be converted to spaces. +</p> +</dd> +<dt><code>backupfile</code></dt> +<dd><p>Toggles whether a backup will be made of the file to be edited. +</p> +</dd> +<dt><code>multibuffer</code></dt> +<dd><p>Toggles the use of multiple file buffers (if available). +</p> +</dd> +<dt><code>mouse</code></dt> +<dd><p>Toggles mouse support. +</p> +</dd> +<dt><code>noconvert</code></dt> +<dd><p>Toggles automatic conversion of files from DOS/Mac format. +</p> +</dd> +<dt><code>suspendenable</code></dt> +<dd><p>Toggles whether the suspend sequence (normally ^Z) will suspend the editor window. +</p> +</dd> +</dl> - <br><dt><code>include "syntaxfile"</code><dd>Read in self-contained color syntaxes from "syntaxfile". Note that -"syntaxfile" can only contain "syntax", "color", and "icolor" commands. +<p>Valid names for <code>menu</code> are: +</p> +<dl compact="compact"> +<dt><code>main</code></dt> +<dd><p>The main editor window where text is entered and edited. +</p> +</dd> +<dt><code>search</code></dt> +<dd><p>The search menu (AKA whereis). +</p> +</dd> +<dt><code>replace</code></dt> +<dd><p>The ’search to replace’ menu. +</p> +</dd> +<dt><code>replacewith</code></dt> +<dd><p>The ’replace with’ menu, which comes up after ’search to replace’. +</p> +</dd> +<dt><code>gotoline</code></dt> +<dd><p>The ’goto line (and column)’ menu. +</p> +</dd> +<dt><code>writeout</code></dt> +<dd><p>The ’write file’ menu. +</p> +</dd> +<dt><code>insert</code></dt> +<dd><p>The ’insert file’ menu. +</p> +</dd> +<dt><code>extcmd</code></dt> +<dd><p>The menu for inserting output from an external command, reached from the insert menu. +</p> +</dd> +<dt><code>help</code></dt> +<dd><p>The help-viewer menu. +</p> +</dd> +<dt><code>spell</code></dt> +<dd><p>The interactive spell checker Yes/no menu. +</p> +</dd> +<dt><code>linter</code></dt> +<dd><p>The linter menu. +</p> +</dd> +<dt><code>browser</code></dt> +<dd><p>The file browser for inserting or writing a file. +</p> +</dd> +<dt><code>whereisfile</code></dt> +<dd><p>The ’search for a file’ menu in the file browser. +</p> +</dd> +<dt><code>gotodir</code></dt> +<dd><p>The ’go to directory’ menu in the file browser. +</p> +</dd> +<dt><code>all</code></dt> +<dd><p>A special name that encompasses all menus. For <code>bind</code> it means +all menus where the specified <code>function</code> exists; for <code>unbind</code> +it means all menus where the specified <code>key</code> exists. +</p></dd> +</dl> - </dl> -<div class="node"> +<hr> <a name="The-File-Browser"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Pico-Compatibility">Pico Compatibility</a>, -Previous: <a rel="previous" accesskey="p" href="#Nanorc-Files">Nanorc Files</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +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> </div> - +<a name="The-File-Browser-1"></a> <h2 class="chapter">6 The File Browser</h2> -<p>When reading or writing files, pressing ^T will invoke the file browser. +<p>When reading or writing files, pressing ^T will invoke the file browser. Here, one can navigate directories in a graphical manner in order to find the desired file. - - <p>Basic movement in the file browser is accomplished with the arrow keys, +</p> +<p>Basic movement in the file browser is accomplished with the arrow keys, page up, and page down. More advanced movement is accomplished by -searching via ^W (or 'w') and changing directories via ^_ (or 'g'). The -behavior of the Enter (or 's') key varies by what is currently selected. +searching via ^W (or ’w’) and changing directories via ^_ (or ’g’). The +behavior of the Enter (or ’s’) key varies by what is currently selected. If the currently selected object is a directory, the file browser will enter and display the contents of the directory. If the object is a file, this filename and path are copied to the statusbar, and the file browser exits. +</p> -<div class="node"> +<hr> <a name="Pico-Compatibility"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Building-and-Configure-Options">Building and Configure Options</a>, -Previous: <a rel="previous" accesskey="p" href="#The-File-Browser">The File Browser</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +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> </div> - +<a name="Pico-Compatibility-1"></a> <h2 class="chapter">7 Pico Compatibility</h2> <p><code>nano</code> attempts to emulate Pico as closely as possible, but there are certain differences between the editors: - - <dl> -<dt><code>Search and Replace History</code><dd>As of version 1.1.99pre1 of <code>nano</code>, text entered as search or +</p> +<dl compact="compact"> +<dt><code>Search and Replace History</code></dt> +<dd><p>As of version 1.1.99pre1 of <code>nano</code>, text entered as search or replace strings will be stored and can be accessed with the up/down arrow keys. Previously, <code>nano</code> offered a more consistent, but -incompatible with Pico, method for entering search and replace strings. +incompatible with Pico, method for entering search and replace strings. In the old method, previous entries would be displayed by default as editable text in front of the cursor, as opposed to being bracketed and uneditable as it is in Pico. The old behavior could be made compatible @@ -725,143 +1639,225 @@ with Pico via the <code>-p</code> option, but recent versions of Pico use the editor. Since, with the new method, search and replace strings can still be edited by simply hitting the up arrow key once, the old method was removed completely. +</p> - <br><dt><code>Writing, Appending, or Prepending Selected Text to Files</code><dd>Text selected using the marking key (^^) can be written out, appended, +</dd> +<dt><code>Writing, Appending, or Prepending Selected Text to Files</code></dt> +<dd><p>Text selected using the marking key (^^) can be written out, appended, or prepended to a new or existing file using the WriteOut key (^O). - - <br><dt><code>Toggles</code><dd>Many options which alter the functionality of the program can be -"toggled" on or off using Meta key sequences, meaning the program does +</p> +</dd> +<dt><code>Toggles</code></dt> +<dd><p>Many options which alter the functionality of the program can be +"toggled" on or off using Meta key sequences, meaning the program does not have to be restarted to turn a particular feature of the editor on or off. Please see the internal help function (^G) for a list of what functions can be toggled for a particular version of <code>nano</code>. See See <a href="#Feature-Toggles">Feature Toggles</a>, for more info. - - <br><dt><code>Cursor Position Display</code><dd>The output of the "Display Cursor Position" in <code>nano</code> displays -the given column position, as well as the row and total character -position of the cursor. - - <br><dt><code>Interactive Replace and Spell Checker</code><dd>It is worth noting that <code>nano</code>'s replace function is interactive, -i.e. it does not stop after one search string is found and automatically -replace it. The <code>nano</code> implementation will pause at each search -string found and query whether to replace this instance or not. The +</p> +</dd> +<dt><code>Cursor Position Display</code></dt> +<dd><p>The output of the "Display Cursor Position" in <code>nano</code> displays +the current line position of the cursor, as well as the column and +total character position. +</p> +</dd> +<dt><code>Interactive Replace and Spell Checker</code></dt> +<dd><p>It is worth noting that <code>nano</code>’s replace function is interactive, +i.e. it does not stop after one search string was found and automatically +replaced. The <code>nano</code> implementation will pause at each found +search string and query whether to replace this instance or not. The internal spell checker operates similarly. Note that there is no way to force these functions to behave in the Pico fashion. As of version 1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in -the internal spell checker such that the words 'apple' and 'Apple' will -be prompted for correction separately. +the internal spell checker such that the words ’apple’ and ’Apple’ will +be prompted for correction separately. +</p></dd> </dl> -<div class="node"> -<a name="Building-and-Configure-Options"></a> -<p><hr> -Previous: <a rel="previous" accesskey="p" href="#Pico-Compatibility">Pico Compatibility</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> +<hr> +<a name="Building-and-Configure-Options"></a> +<div class="header"> +<p> +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> </div> - +<a name="Building-and-Configure-Options-1"></a> <h2 class="chapter">8 Building and Configure Options</h2> <p>Building <code>nano</code> from source is fairly straightforward if you are familiar with compiling programs with autoconf support: - - <ul> -<li>tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of +</p> +<ul> +<li> tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of <code>nano</code>) -<li>cd nano-x.y.z/ -<li>./configure -<li>make -<li>make install -</ul> - - <p>The possible options to <code>./configure</code> are: - - <dl> -<dt><code>--disable-browser</code><dd>Disable the mini file browser when reading or writing files. +</li><li> cd nano-x.y.z/ +</li><li> ./configure +</li><li> make +</li><li> make install +</li></ul> - <br><dt><code>--disable-help</code><dd>Disable the help function. Doing this makes the binary much smaller, +<p>The possible options to <code>./configure</code> are: +</p> +<dl compact="compact"> +<dt><code>--disable-browser</code></dt> +<dd><p>Disable the mini file browser when reading or writing files. +</p> +</dd> +<dt><code>--disable-color</code></dt> +<dd><p>Disable support for the syntax coloring of files. This also eliminates +the -Y command-line option, which chooses a specific syntax. +</p> +</dd> +<dt><code>--disable-extra</code></dt> +<dd><p>Disable extra features. At the moment, this is just easter-egg-type +stuff. +</p> +</dd> +<dt><code>--disable-help</code></dt> +<dd><p>Disable the help function. Doing this makes the binary much smaller, but makes it difficult for new users to learn more than very basic things about using the editor. - - <br><dt><code>--disable-justify</code><dd>Disable the justify and unjustify functions. - - <br><dt><code>--disable-mouse</code><dd>Disable all mouse functionality. This also disables the -m command line -option, which enables the mouse functionality. - - <br><dt><code>--disable-operatingdir</code><dd>Disable setting the operating directory. This also disables the -o -command line option, which sets the operating directory. - - <br><dt><code>--disable-speller</code><dd>Disable use of the spell checker. This also disables the -s command -line option, which allows specifying an alternate spell checker. - - <br><dt><code>--disable-tabcomp</code><dd>Disable the tab completion code when reading or writing files. - - <br><dt><code>--disable-wrapping</code><dd>Disable all long line wrapping. This also eliminates the -w command -line option, which enables long line wrapping. - - <br><dt><code>--enable-tiny</code><dd>This option disables all the above. It also disables some of the larger -internals of the editor, like the marking code and the cut to end of -line code. It also disables the function toggles. - - <br><dt><code>--enable-debug</code><dd>Enable support for runtime debug output. This can get pretty messy, so -chances are you only want this feature to work on the nano source. - - <br><dt><code>--enable-extra</code><dd>Enable extra features. At the moment, this is just easter egg-type -stuff. - - <br><dt><code>--enable-color</code><dd>Enable support for syntax coloring of files using the nanorc file. This -enables nanorc support as well. - - <br><dt><code>--enable-multibuffer</code><dd>Enable support for opening multiple files at a time and switching -between them on the fly. - - <br><dt><code>--enable-nanorc</code><dd>Enable support for reading the nanorc file at startup. You can store -custom settings in the nanorc file rather than having to pass command -line options to get desired behavior. See See <a href="#Nanorc-Files">Nanorc Files</a>, for -more info. - - <br><dt><code>--enable-all</code><dd>Shortcut for enabling the above four features (extra, color, -multibuffer, and nanorc). - - <br><dt><code>--disable-nls</code><dd>Disables Native Language support. This will disable use of the +</p> +</dd> +<dt><code>--disable-histories</code></dt> +<dd><p>Disable the code for the handling of the history files: the search and +replace strings that were used, and the cursor position at which each +file was closed. This also eliminates the -H and -P command-line +options, which switch on the logging of search/replace strings and +cursor positions. +</p> +</dd> +<dt><code>--disable-justify</code></dt> +<dd><p>Disable the justify and unjustify functions. +</p> +</dd> +<dt><code>--disable-libmagic</code></dt> +<dd><p>Disable the use of the library of magic-number tests (for determining +the file type and thus which syntax to use for colouring – often the +tests on filename extension and header line will be enough). +</p> +</dd> +<dt><code>--disable-mouse</code></dt> +<dd><p>Disable all mouse functionality. This also eliminates the -m +command-line option, which enables the mouse functionality. +</p> +</dd> +<dt><code>--disable-multibuffer</code></dt> +<dd><p>Disable support for opening multiple files at a time and switching +between them on the fly. This also eliminates the -F command-line +option, which switches the use of multiple file buffers on. +</p> +</dd> +<dt><code>--disable-nanorc</code></dt> +<dd><p>Disable support for reading the nanorc files at startup. With such +support, you can store custom settings in a system-wide and a per-user +nanorc file rather than having to pass command-line options to get +the desired behavior. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. +Disabling this also eliminates the -I and -q command-line options; +the first inhibits the reading of nanorcfiles, and the second +suppresses warnings about errors in those files. +</p> +</dd> +<dt><code>--disable-operatingdir</code></dt> +<dd><p>Disable setting the operating directory. This also eliminates the -o +command-line option, which sets the operating directory. +</p> +</dd> +<dt><code>--disable-speller</code></dt> +<dd><p>Disable use of the spell checker. This also eliminates the -s +command-line option, which allows specifying an alternate spell checker. +</p> +</dd> +<dt><code>--disable-tabcomp</code></dt> +<dd><p>Disable the tab completion code when reading or writing files. +</p> +</dd> +<dt><code>--disable-wrapping</code></dt> +<dd><p>Disable hard-wrapping of overlong lines. This also eliminates the -w +command-line option, which enables long-line wrapping. +</p> +</dd> +<dt><code>--enable-tiny</code></dt> +<dd><p>This option disables all the above. It also disables some of the larger +internals of the editor, like the marking code and the cut-to-end-of-line +code. It also disables the function toggles. By using the enabling +counterpart of the above options together with –enable-tiny, specific +features can be switched back on. +</p> +</dd> +<dt><code>--enable-debug</code></dt> +<dd><p>Enable support for runtime debug output. This can get pretty messy, so +chances are you only want this feature when you’re working on the nano source. +</p> +</dd> +<dt><code>--disable-nls</code></dt> +<dd><p>Disables Native Language support. This will disable the use of any available GNU <code>nano</code> translations. - - <br><dt><code>--disable-wrapping-as-root</code><dd>Disable long line wrapping by default when nano is run as root. - - <br><dt><code>--enable-utf8</code><dd>Enable support for reading and writing Unicode files. This will require +</p> +</dd> +<dt><code>--disable-wrapping-as-root</code></dt> +<dd><p>Disable hard-wrapping of overlong lines by default when <code>nano</code> +is run as root. +</p> +</dd> +<dt><code>--enable-utf8</code></dt> +<dd><p>Enable support for reading and writing Unicode files. This will require either a wide version of curses, or a UTF-8-enabled version of Slang. +</p> +</dd> +<dt><code>--disable-utf8</code></dt> +<dd><p>Disable support for reading and writing Unicode files. Normally the +configure script auto-detects whether to enable UTF-8 support or not. +You can use this or the previous option to override that detection. +</p> +</dd> +<dt><code>--with-slang</code></dt> +<dd><p>Compile <code>nano</code> against Slang instead of against ncurses or other +curses libraries. +</p> +</dd> +</dl> - <br><dt><code>--disable-utf8</code><dd>Disable support for reading and writing Unicode files. - - <br><dt><code>--with-slang</code><dd>Compiling <code>nano</code> with Slang is supported, and will make the binary -notably smaller than if compiled with ncurses or other curses libraries. +<a name="SEC_Contents"></a> +<h2 class="contents-heading">Table of Contents</h2> + +<div class="contents"> + +<ul class="no-bullet"> + <li><a name="toc-Introduction-1" href="#Introduction">1 Introduction</a> + <ul class="no-bullet"> + <li><a name="toc-Overview-1" href="#Overview">1.1 Overview</a></li> + <li><a name="toc-Command-Line-Options-1" href="#Command-Line-Options">1.2 Command Line Options</a></li> + </ul></li> + <li><a name="toc-Editor-Basics-1" href="#Editor-Basics">2 Editor Basics</a> + <ul class="no-bullet"> + <li><a name="toc-Entering-Text-1" href="#Entering-Text">2.1 Entering Text</a></li> + <li><a name="toc-Special-Functions-1" href="#Special-Functions">2.2 Special Functions</a></li> + <li><a name="toc-The-Cutbuffer-1" href="#The-Cutbuffer">2.3 The Cutbuffer</a></li> + <li><a name="toc-The-Mark-1" href="#The-Mark">2.4 The Mark</a></li> + <li><a name="toc-The-Titlebar-1" href="#The-Titlebar">2.5 The Titlebar</a></li> + <li><a name="toc-The-Statusbar-1" href="#The-Statusbar">2.6 The Statusbar</a></li> + <li><a name="toc-Shortcut-Lists-1" href="#Shortcut-Lists">2.7 Shortcut Lists</a></li> + <li><a name="toc-Using-the-Mouse-1" href="#Using-the-Mouse">2.8 Using the Mouse</a></li> + </ul></li> + <li><a name="toc-Online-Help-1" href="#Online-Help">3 Online Help</a></li> + <li><a name="toc-Feature-Toggles-1" href="#Feature-Toggles">4 Feature Toggles</a></li> + <li><a name="toc-Nanorc-Files-1" href="#Nanorc-Files">5 Nanorc Files</a> + <ul class="no-bullet"> + <li><a name="toc-Settings-1" href="#Settings">5.1 Settings</a></li> + <li><a name="toc-Syntax-Highlighting-1" href="#Syntax-Highlighting">5.2 Syntax Highlighting</a></li> + <li><a name="toc-Rebinding-Keys-1" href="#Rebinding-Keys">5.3 Rebinding Keys</a></li> + </ul></li> + <li><a name="toc-The-File-Browser-1" href="#The-File-Browser">6 The File Browser</a></li> + <li><a name="toc-Pico-Compatibility-1" href="#Pico-Compatibility">7 Pico Compatibility</a></li> + <li><a name="toc-Building-and-Configure-Options-1" href="#Building-and-Configure-Options">8 Building and Configure Options</a></li> +</ul> +</div> - </dl> +<hr> - <div class="contents"> -<h2>Table of Contents</h2> -<ul> -<li><a name="toc_Introduction" href="#Introduction">1 Introduction</a> -<ul> -<li><a href="#Overview">1.1 Overview</a> -<li><a href="#Command-Line-Options">1.2 Command Line Options</a> -</li></ul> -<li><a name="toc_Editor-Basics" href="#Editor-Basics">2 Editor Basics</a> -<ul> -<li><a href="#Entering-Text">2.1 Entering Text</a> -<li><a href="#Special-Functions">2.2 Special Functions</a> -<li><a href="#The-Titlebar">2.3 The Titlebar</a> -<li><a href="#The-Statusbar">2.4 The Statusbar</a> -<li><a href="#Shortcut-Lists">2.5 Shortcut Lists</a> -<li><a href="#Using-the-Mouse">2.6 Using the Mouse</a> -</li></ul> -<li><a name="toc_Online-Help" href="#Online-Help">3 Online Help</a> -<li><a name="toc_Feature-Toggles" href="#Feature-Toggles">4 Feature Toggles</a> -<li><a name="toc_Nanorc-Files" href="#Nanorc-Files">5 Nanorc Files</a> -<li><a name="toc_The-File-Browser" href="#The-File-Browser">6 The File Browser</a> -<li><a name="toc_Pico-Compatibility" href="#Pico-Compatibility">7 Pico Compatibility</a> -<li><a name="toc_Building-and-Configure-Options" href="#Building-and-Configure-Options">8 Building and Configure Options</a> -</li></ul> -</div> -</body></html> +</body> +</html> diff --git a/doc/texinfo/nano.info b/doc/texinfo/nano.info index f4cd7ed..4597c8b 100644 --- a/doc/texinfo/nano.info +++ b/doc/texinfo/nano.info @@ -1,4 +1,4 @@ -This is nano.info, produced by makeinfo version 4.13 from nano.texi. +This is nano.info, produced by makeinfo version 5.2 from nano.texi. INFO-DIR-SECTION Editors START-INFO-DIR-ENTRY @@ -6,9 +6,12 @@ START-INFO-DIR-ENTRY END-INFO-DIR-ENTRY -File: nano.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) +File: nano.info, Node: Top, Next: Introduction, Up: (dir) - This manual documents GNU `nano', a small and friendly text editor. +nano Command Manual +******************* + +This manual documents GNU 'nano', a small and friendly text editor. * Menu: @@ -27,10 +30,11 @@ File: nano.info, Node: Introduction, Next: Editor Basics, Prev: Top, Up: Top 1 Introduction ************** -GNU `nano' is a small and friendly text editor. Besides basic text -editing, `nano' offers many extra features like an interactive search -and replace, go to line and column number, auto-indentation, feature -toggles, internationalization support, and filename tab completion. +GNU 'nano' is a small and friendly text editor. Besides basic text +editing, 'nano' offers many extra features, like an interactive +search-and-replace, go-to-line-and-column-number, auto-indentation, +feature toggles, internationalization support, and filename tab +completion. * Menu: @@ -38,30 +42,30 @@ toggles, internationalization support, and filename tab completion. * Command Line Options:: -File: nano.info, Node: Overview, Next: Command Line Options, Prev: Introduction, Up: Introduction +File: nano.info, Node: Overview, Next: Command Line Options, Up: Introduction 1.1 Overview ============ -The original goal for `nano' was a complete bug-for-bug compatible -emulation of Pico, but `nano''s current goal is to be as compatible as +The original goal for 'nano' was a complete bug-for-bug compatible +emulation of Pico, but 'nano''s current goal is to be as compatible as possible while offering a superset of Pico's functionality. See *Note Pico Compatibility::, for more info. - The usual way to invoke `nano' is: + The usual way to invoke 'nano' is: - `nano [OPTION]... [FILE]' + 'nano [OPTION]... [FILE]' But it is also possible to edit several files in a row. Additionally, the cursor can be put on a desired line number by adding this number with a plus sign before any filename, and even in a desired column by adding it with a comma. So the complete synopsis is: - `nano [OPTION]... [[+LINE] FILE]...' + 'nano [OPTION]... [[+LINE] FILE]...' - `nano [OPTION]... [[+,COLUMN] FILE]...' + 'nano [OPTION]... [[+,COLUMN] FILE]...' - `nano [OPTION]... [[+LINE,COLUMN] FILE]...' + 'nano [OPTION]... [[+LINE,COLUMN] FILE]...' Email bug reports to <nano@nano-editor.org>. @@ -71,194 +75,255 @@ File: nano.info, Node: Command Line Options, Prev: Overview, Up: Introduction 1.2 Command Line Options ======================== -`nano' takes the following options from the command line: +'nano' takes the following options from the command line: -`+LINE,COLUMN' +'+LINE,COLUMN' Start at line number LINE and column number COLUMN (at least one of which must be specified) instead of the default of line 1, column 1. -`-?' - Same as `-h, --help'. - -`-A, --smarthome' +'-A' +'--smarthome' Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). - If the cursor is already at that position, it will jump to the - true beginning of the line. + If the cursor is already at that position, it will jump to the true + beginning of the line. -`-B, --backup' +'-B' +'--backup' When saving a file, back up the previous version of it to the - current filename suffixed with a ~. + current filename suffixed with a '~'. -`-C <dir>, --backupdir=<dir>' - Set the directory where `nano' puts unique backup files if file +'-C DIRECTORY' +'--backupdir=DIRECTORY' + Set the directory where 'nano' puts unique backup files if file backups are enabled. -`-D, --boldtext' +'-D' +'--boldtext' Use bold text instead of reverse video text. -`-E, --tabstospaces' +'-E' +'--tabstospaces' Convert typed tabs to spaces. -`-F, --multibuffer' - Enable multiple file buffers, if available. +'-F' +'--multibuffer' + Enable multiple file buffers (if support for them has been compiled + in). + +'-G' +'--locking' + Enable vim-style file locking when editing files. -`-H, --historylog' - Log search and replace strings to ~/.nano_history, so they can be - retrieved in later sessions, if nanorc support is available. +'-H' +'--historylog' + Log search and replace strings to '~/.nano/search_history', so they + can be retrieved in later sessions. -`-I, --ignorercfiles' - Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is - available. +'-I' +'--ignorercfiles' + Don't look at the system's nanorc file nor at the user's + '~/.nanorc'. -`-K, --rebindkeypad' +'-K' +'--rebindkeypad' Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. -`-L, --nonewlines' +'-L' +'--nonewlines' Don't add newlines to the ends of files. -`-N, --noconvert' - Don't convert files from DOS/Mac format. +'-N' +'--noconvert' + Disable automatic conversion of files from DOS/Mac format. -`-O, --morespace' +'-O' +'--morespace' Use the blank line below the titlebar as extra editing space. -`-Q <str>, --quotestr=<str>' +'-P' +'--poslog' + Log for each file the last location of the cursor, and read it back + upon reopening the file and place it there again. + +'-Q "CHARACTERS"' +'--quotestr="CHARACTERS"' Set the quoting string for justifying. The default value is - `^([ \t]*[|>:}#])+' + "^([ \t]*[|>:}#])+" - if extended regular expression support is available, or "> " - otherwise. Note that `\t' above stands for a literal Tab + if extended regular expression support is available, or '> ' + otherwise. Note that '\t' above stands for a literal Tab character. -`-R, --restricted' +'-R' +'--restricted' Restricted mode: don't read or write to any file not specified on - the command line; read any nanorc files; allow suspending; allow a - file to be appended to, prepended to, or saved under a different - name if it already has one; or use backup files or spell checking. - Also accessible by invoking `nano' with any name beginning with - 'r' (e.g. "rnano"). - -`-S, --smooth' - Enable smooth scrolling. Text will scroll line-by-line, instead - of the usual chunk-by-chunk behavior. - -`-T <#cols>, --tabsize=<#cols>' - Set the displayed tab length to #cols columns. The value of #cols - must be greater than 0. The default value is 8. - -`-U, --quickblank' + the command line; don't read any nanorc files nor history files; + don't allow suspending nor spell checking; don't allow a file to be + appended to, prepended to, or saved under a different name if it + already has one; and don't use backup files. This restricted mode + is also accessible by invoking 'nano' with any name beginning with + 'r' (e.g. 'rnano'). + +'-S' +'--smooth' + Enable smooth scrolling. Text will scroll line-by-line, instead of + the usual chunk-by-chunk behavior. + +'-T NUMBER' +'--tabsize=NUMBER' + Set the displayed tab length to NUMBER columns. The value of + NUMBER must be greater than 0. The default value is '8'. + +'-U' +'--quickblank' Do quick statusbar blanking. Statusbar messages will disappear - after 1 keystroke instead of 25. Note that -c overrides this. + after 1 keystroke instead of 25. Note that '-c' overrides this. -`-V, --version' +'-V' +'--version' Show the current version number and exit. -`-W, --wordbounds' +'-W' +'--wordbounds' Detect word boundaries more accurately by treating punctuation characters as parts of words. -`-Y <str>, --syntax=<str>' - Specify a specific syntax highlighting from the nanorc to use, if - available. See *Note Nanorc Files::, for more info. +'-Y NAME' +'--syntax=NAME' + Specify a specific syntax from the nanorc files to use for + highlighting. See *Note Syntax Highlighting::, for more info. -`-c, --const' +'-c' +'--const' Constantly display the cursor position and line number on the - statusbar. Note that this overrides -U. + statusbar. Note that this overrides '-U'. -`-d, --rebinddelete' +'-d' +'--rebinddelete' Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. -`-h, --help' - Show a summary of command line options and exit. +'-h' +'--help' + Show a summary of command-line options and exit. -`-i, --autoindent' +'-i' +'--autoindent' Automatically indent new lines to the same number of spaces and tabs as the previous line. -`-k, --cut' - Cut from the current cursor position to the end of the current - line. +'-k' +'--cut' + Make the 'Cut Text' command (normally ^K) cut from the current + cursor position to the end of the line, instead of cutting the + entire line. -`-l, --nofollow' +'-l' +'--nofollow' When writing files, if the given file is a symbolic link, it is removed and a new file is created. -`-m, --mouse' +'-m' +'--mouse' Enable mouse support, if available for your system. When enabled, mouse clicks can be used to place the cursor, set the mark (with a - double click), and execute shortcuts. The mouse will work in the - X Window System, and on the console when gpm is running. - -`-o <dir>, --operatingdir=<dir>' - Set operating directory. Makes `nano' set up something similar to - a chroot. - -`-p, --preserve' - Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent - to the editor can be can be stopped and started. - -`-q, --quiet' - Do not report errors in the nanorc file and ask them to be + double click), and execute shortcuts. The mouse will work in the X + Window System, and on the console when gpm is running. Text can + still be selected through dragging by holding down the Shift key. + +'-n' +'--noread' + Treat any name given on the command line as a new file. This + allows 'nano' to write to named pipes: it will start with a blank + buffer, and will write to the pipe when the user saves the "file". + This way 'nano' can be used as an editor in combination with for + instance 'gpg' without having to write sensitive data to disk + first. + +'-o DIRECTORY' +'--operatingdir=DIRECTORY' + Set the operating directory. This makes 'nano' set up something + similar to a chroot. + +'-p' +'--preserve' + Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to + the editor can be stopped and started. + +'-q' +'--quiet' + Do not report errors in the nanorc file nor ask them to be acknowledged by pressing Enter at startup. -`-r <#cols>, --fill=<#cols>' - Wrap lines at column #cols. If this value is 0 or less, wrapping - will occur at the width of the screen less #cols, allowing it to - vary along with the width of the screen if the screen is resized. - The default value is -8. - -`-s <prog>, --speller=<prog>' - Invoke the given program as the spell checker. By default, `nano' - uses the command specified in the SPELL environment variable, or, - if SPELL is not set, its own interactive spell checker that - requires the `spell' program to be installed on your system. - -`-t, --tempfile' +'-r NUMBER' +'--fill=NUMBER' + Hard-wrap lines at column NUMBER (by inserting a newline + character). If the given value is 0 or less, wrapping will occur + at the width of the screen minus the given amount, allowing the + wrapping width to vary along with the width of the screen if and + when it is resized. The default value is '-8'. This option + conflicts with '-w' - the last one given takes effect. + +'-s PROGRAM' +'--speller=PROGRAM' + Invoke the given program as the spell checker. By default, 'nano' + uses the command specified in the 'SPELL' environment variable, or, + if 'SPELL' is not set, its own interactive spell checker that + requires the 'spell' program to be installed on your system. + +'-t' +'--tempfile' Don't ask whether or not to save the current contents of the file - when exiting, assume yes. This is most useful when using `nano' - as the composer of a mailer program. - -`-u, --undo' - Enable experimental generic-purpose undo code. By default, the - undo and redo shortcuts are Meta-U and Meta-E, respectively. + when exiting, assume yes. This is most useful when using 'nano' as + the composer of a mailer program. -`-v, --view' +'-v' +'--view' Don't allow the contents of the file to be altered. Note that this option should NOT be used in place of correct file permissions to implement a read-only file. -`-w, --nowrap' - Don't wrap long lines at any length. This option overrides any - value for -r. +'-w' +'--nowrap' + Don't hard-wrap long lines at any length. This option conflicts + with '-r' - the last one given takes effect. -`-x, --nohelp' +'-x' +'--nohelp' Expert Mode: don't show the Shortcut Lists at the bottom of the screen. This affects the location of the statusbar as well, as in Expert Mode it is located at the very bottom of the editor. Note: When accessing the help system, Expert Mode is temporarily - disabled to display the help system navigation keys. + disabled to display the help-system navigation keys. -`-z, --suspend' - Enable `nano''s suspend ability using the system's suspend +'-z' +'--suspend' + Enable the ability to suspend 'nano' using the system's suspend keystroke (usually ^Z). -`-$, --softwrap' - Enable 'soft wrapping'. `nano' will attempt to display the entire - contents of a line, even if it is longer than the screen width. - Since '$' normally refers to a variable in the Unix shell, you - should specify this option last when using other options (e.g. - 'nano -wS$') or pass it separately (e.g. 'nano -wS -$'). - -`-a, -b, -e, -f, -g, -j' +'-$' +'--softwrap' + Enable 'soft wrapping'. This will make 'nano' attempt to display + the entire contents of any line, even if it is longer than the + screen width, by continuing it over multiple screen lines. Since + '$' normally refers to a variable in the Unix shell, you should + specify this option last when using other options (e.g. 'nano + -wS$') or pass it separately (e.g. 'nano -wS -$'). + +'-a' +'-b' +'-e' +'-f' +'-g' +'-j' Ignored, for compatibility with Pico. @@ -271,66 +336,103 @@ File: nano.info, Node: Editor Basics, Next: Online Help, Prev: Introduction, * Entering Text:: * Special Functions:: +* The Cutbuffer:: +* The Mark:: * The Titlebar:: * The Statusbar:: * Shortcut Lists:: * Using the Mouse:: -File: nano.info, Node: Entering Text, Next: Special Functions, Prev: Editor Basics, Up: Editor Basics +File: nano.info, Node: Entering Text, Next: Special Functions, Up: Editor Basics 2.1 Entering Text ================= -All key sequences in `nano' are entered using the keyboard. `nano' is -a "modeless" editor. All keys, with the exception of Control and Meta -key sequences, will enter text into the file being edited. +'nano' is a "modeless" editor. All keystrokes, with the exception of +Control and Meta key sequences, enter text into the file being edited. +All key sequences in 'nano' are entered using the keyboard. -File: nano.info, Node: Special Functions, Next: The Titlebar, Prev: Entering Text, Up: Editor Basics +File: nano.info, Node: Special Functions, Next: The Cutbuffer, Prev: Entering Text, Up: Editor Basics 2.2 Special Functions ===================== -Special functions use the Control (Ctrl) key, displayed in the help and -shortcut lists as ^; the Meta key, displayed as M; or the Escape (Esc) -key. +Special functions use the Control key (Ctrl), displayed in the help and +shortcut lists as ^; the Meta key (Alt or Cmd), displayed as M-; or the +Escape key (Esc). * Control key sequences are entered by holding down the Ctrl key and - pressing the desired key, or by pressing the Esc key twice and + pressing the desired key, or by pressing the Esc key twice and then pressing the desired key. - - * Pressing Esc twice and then typing a three-digit number from 000 - to 255 will enter the character with the corresponding value. - + * Pressing the Esc key twice and then typing a three-digit number + from 000 to 255 will enter the character with the corresponding + value. * Meta key sequences are entered by holding down the Meta key - (normally the Alt key) and pressing the desired key, or by - pressing the Esc key once and pressing the desired key. Certain + (normally the Alt key) and pressing the desired key, or by pressing + the Esc key once and then pressing the desired key. Certain operating systems "swallow" the Alt key so that it never reaches - the application; if your operating system does this, you should - use the Esc key to generate Meta key sequences. + the application; if your operating system does this, you should use + the Esc key to generate Meta key sequences. -File: nano.info, Node: The Titlebar, Next: The Statusbar, Prev: Special Functions, Up: Editor Basics +File: nano.info, Node: The Cutbuffer, Next: The Mark, Prev: Special Functions, Up: Editor Basics + +2.3 The Cutbuffer +================= + +Text can be cut from a file, a whole line at a time, by using the 'Cut +Text' command (default key binding: ^K). The cut line is stored in the +cutbuffer. Consecutive strokes of ^K will add each cut line to this +buffer, but a ^K after any other keystroke will overwrite the entire +cutbuffer. + + The contents of the cutbuffer can be pasted back into the file with +the 'Uncut Text' command (default key binding: ^U). + + A line of text can be copied into the cutbuffer (without cutting it) +with the 'Copy Text' command (default key binding: M-6). -2.3 The Titlebar + +File: nano.info, Node: The Mark, Next: The Titlebar, Prev: The Cutbuffer, Up: Editor Basics + +2.4 The Mark +============ + +Text can be selected by first 'setting the Mark' (default key bindings: +^6 and M-A) and then moving the cursor to the other end of the portion +to be selected. The selected portion of text will be highlighted in +reverse video (or in bold if you set the boldtext option). This +selection can now be cut or copied in its entirety with a single ^K or +M-6. Or the selection can be used to limit the scope of a +search-and-replace (^\) or spell-checking session (^T). + + Cutting or copying selected text will toggle the mark off +automatically. If necessary, it can be toggled off manually with +another ^6 or M-A. + + +File: nano.info, Node: The Titlebar, Next: The Statusbar, Prev: The Mark, Up: Editor Basics + +2.5 The Titlebar ================ The titlebar is the line displayed at the top of the editor. There are three sections: left, center and right. The section on the left -displays the version of `nano' being used. The center section displays +displays the version of 'nano' being used. The center section displays the current filename, or "New Buffer" if the file has not yet been -named. The section on the right will display "Modified" if the file -has been modified since it was last saved or opened. +named. The section on the right will display "Modified" if the file has +been modified since it was last saved or opened. - Special modes: When `nano' is in "File browser" mode, the center + Special modes: When 'nano' is in "File browser" mode, the center section will display the current directory instead of the filename. See *Note The File Browser::, for more info. File: nano.info, Node: The Statusbar, Next: Shortcut Lists, Prev: The Titlebar, Up: Editor Basics -2.4 The Statusbar +2.6 The Statusbar ================= The statusbar is the third line from the bottom of the screen, or the @@ -338,12 +440,12 @@ bottom line in Expert Mode. See *Note Expert Mode::, for more info. It shows important and informational messages. Any error messages that occur from using the editor will appear on the statusbar. Any questions that are asked of the user will be asked on the statusbar, and any user -input (search strings, filenames, etc.) will be input on the statusbar. +input (search strings, filenames, etc.) will be input on the statusbar. File: nano.info, Node: Shortcut Lists, Next: Using the Mouse, Prev: The Statusbar, Up: Editor Basics -2.5 Shortcut Lists +2.7 Shortcut Lists ================== The Shortcut Lists are the two lines at the bottom of the screen which @@ -352,13 +454,15 @@ show some of the more commonly used functions in the editor. File: nano.info, Node: Using the Mouse, Prev: Shortcut Lists, Up: Editor Basics -2.6 Using the Mouse +2.8 Using the Mouse =================== When mouse support has been configured and enabled, a single mouse click places the cursor at the indicated position. Clicking a second time in the same position toggles the mark. Clicking in the shortcut list -executes the selected shortcut. +executes the selected shortcut. To be able to select text with the left +button, or paste text with the middle button, hold down the Shift key +during those actions. The mouse will work in the X Window System, and on the console when gpm is running. @@ -369,10 +473,10 @@ File: nano.info, Node: Online Help, Next: Feature Toggles, Prev: Editor Basic 3 Online Help ************* -The online help system in `nano' is available by pressing ^G. It is -fairly self explanatory, documenting the various parts of the editor -and available keystrokes. Navigation is via the ^Y (Page Up) and ^V -(Page Down) keys. ^X exits the help system. +The online help system in 'nano' is available by pressing ^G. It is +fairly self-explanatory, documenting the various parts of the editor and +available keystrokes. Navigation is via the ^Y (Page Up) and ^V (Page +Down) keys. ^X exits the help system. File: nano.info, Node: Feature Toggles, Next: Nanorc Files, Prev: Online Help, Up: Top @@ -381,63 +485,62 @@ File: nano.info, Node: Feature Toggles, Next: Nanorc Files, Prev: Online Help ***************** Toggles allow you to change certain aspects of the editor that would -normally be done via command line options. They are invoked via Meta +normally be done via command-line options. They are invoked via Meta key sequences. See *Note Special Functions::, for more info. The following global toggles are available: -`Backup Files Toggle (Meta-B)' - toggles the -B (`--backup') command line option. +'Backup Files Toggle (Meta-B)' + toggles the -B ('--backup') command line option. -`Constant Cursor Position Display Toggle (Meta-C)' - toggles the -c (`--const') command line option. +'Constant Cursor Position Display Toggle (Meta-C)' + toggles the -c ('--const') command line option. -`Multiple File Buffers Toggle (Meta-F)' - toggles the -F (`--multibuffer') command line option. +'Multiple File Buffers Toggle (Meta-F)' + toggles the -F ('--multibuffer') command line option. -`Smart Home Key Toggle (Meta-H)' - toggles the -A (`--smarthome') command line option. +'Smart Home Key Toggle (Meta-H)' + toggles the -A ('--smarthome') command line option. -`Auto Indent Toggle (Meta-I)' - toggles the -i (`--autoindent') command line option. +'Auto Indent Toggle (Meta-I)' + toggles the -i ('--autoindent') command line option. -`Cut To End Toggle (Meta-K)' - toggles the -k (`--cut') command line option. +'Cut To End Toggle (Meta-K)' + toggles the -k ('--cut') command line option. -`Long Line Wrapping Toggle (Meta-L)' - toggles the -w (`--nowrap') command line option. +'Long Line Wrapping Toggle (Meta-L)' + toggles the -w ('--nowrap') command line option. -`Mouse Support Toggle (Meta-M)' - toggles the -m (`--mouse') command line option. +'Mouse Support Toggle (Meta-M)' + toggles the -m ('--mouse') command line option. -`No Conversion From DOS/Mac Format Toggle (Meta-N)' - toggles the -N (`--noconvert') command line option. +'No Conversion From DOS/Mac Format Toggle (Meta-N)' + toggles the -N ('--noconvert') command line option. -`More Space For Editing Toggle (Meta-O)' - toggles the -O (`--morespace') command line option. +'More Space For Editing Toggle (Meta-O)' + toggles the -O ('--morespace') command line option. -`Whitespace Display Toggle (Meta-P)' - toggles whitespace display mode if you have a "whitespace" option - in your nanorc. See *Note Nanorc Files::, for more info. +'Whitespace Display Toggle (Meta-P)' + toggles whitespace-display mode. See *Note Whitespace::, for more + info. -`Tabs to Spaces Toggle (Meta-Q)' - toggles the -E (`--tabstospaces') command line option. +'Tabs to Spaces Toggle (Meta-Q)' + toggles the -E ('--tabstospaces') command line option. -`Smooth Scrolling Toggle (Meta-S)' - toggles the -S (`--smooth') command line option. +'Smooth Scrolling Toggle (Meta-S)' + toggles the -S ('--smooth') command line option. -`Expert/No Help Toggle (Meta-X)' - toggles the -x (`--nohelp') command line option. +'Expert/No Help Toggle (Meta-X)' + toggles the -x ('--nohelp') command line option. -`Color Syntax Highlighting Toggle (Meta-Y)' +'Color Syntax Highlighting Toggle (Meta-Y)' toggles color syntax highlighting if you have color syntaxes in - your nanorc. See *Note Nanorc Files::, for more info. - -`Suspend Toggle (Meta-Z)' - toggles the -z (`--suspend') command line option. + your nanorc. See *Note Syntax Highlighting::, for more info. -`Soft Wrapping Toggle (Meta-$)' - toggles the -$ (`--softwrap') command line option. +'Suspend Toggle (Meta-Z)' + toggles the -z ('--suspend') command line option. +'Soft Wrapping Toggle (Meta-$)' + toggles the -$ ('--softwrap') command line option. File: nano.info, Node: Nanorc Files, Next: The File Browser, Prev: Feature Toggles, Up: Top @@ -445,225 +548,312 @@ File: nano.info, Node: Nanorc Files, Next: The File Browser, Prev: Feature To 5 Nanorc Files ************** -The nanorc files contain the default settings for `nano'. They should -not be in DOS or Mac format. During startup, `nano' will first read -its system-wide settings from SYSCONFDIR/nanorc, and then user-specific -settings from ~/.nanorc. +The nanorc files contain the default settings for 'nano'. They should +be in Unix format, not in DOS or Mac format. During startup, 'nano' +will first read the system-wide settings, from /etc/nanorc (the exact +path might be different), and then the user-specific settings, from +~/.nanorc. A nanorc file accepts a series of "set" and "unset" commands, which -can be used to configure `nano' on startup without using the command -line options. Additionally, the "syntax", "color", and "icolor" -keywords are used to define syntax highlighting rules for different text -patterns. `nano' will read one command per line. - - Options in nanorc files take precedence over `nano''s defaults, and -command line options override nanorc settings. Options are also unset -by default, except for those that take arguments. +can be used to configure 'nano' on startup without using command-line +options. Additionally, there are some commands to define syntax +highlighting and to rebind keys - *Note Syntax Highlighting::, and *Note +Rebinding Keys::. 'nano' will read one command per line. + + Options in nanorc files take precedence over 'nano''s defaults, and +command-line options override nanorc settings. Also, options that do +not take an argument are unset by default. So using the 'unset' command +is only needed when wanting to override a setting of the system's nanorc +file in your own '~/.nanorc'. Options that take an argument cannot be +unset. Quotes inside string parameters don't have to be escaped with backslashes. The last double quote in the string will be treated as its -end. For example, for the "brackets" option, +end. For example, for the "brackets" option, '""')>]}"' will match '"', +''', ')', '>', ']', and '}'. + +* Menu: + +* Settings:: +* Syntax Highlighting:: +* Rebinding Keys:: + + +File: nano.info, Node: Settings, Next: Syntax Highlighting, Up: Nanorc Files - `""')>]}"' +5.1 Settings +============ - will match `"', `'', `)', `>', `]', and `}'. +The supported settings in a nanorc file are: - The supported commands and arguments are: +'set allow_insecure_backup' + When backing up files, allow the backup to succeed even if its + permissions can't be (re)set due to special OS considerations. You + should NOT enable this option unless you are sure you need it. -`set/unset autoindent' +'set autoindent' Use auto-indentation. -`set/unset backup' - Create backup files in "filename~". +'set backup' + When saving a file, back up the previous version of it to the + current filename suffixed with a tilde ('~'). -`set backupdir "directory"' - Set the directory where `nano' puts unique backup files if file +'set backupdir "directory"' + Set the directory where 'nano' puts unique backup files, if file backups are enabled. -`set/unset backwards' +'set backwards' Do backwards searches by default. -`set/unset boldtext' - Use bold text instead of reverse video text. +'set boldtext' + Use bold instead of reverse video for the titlebar, statusbar, key + combos, and selected text. This can be overridden for the first + three by setting the options "titlecolor", "statuscolor", and + "keycolor". -`set brackets "string"' +'set brackets "STRING"' Set the characters treated as closing brackets when justifying - paragraphs. They cannot contain blank characters. Only closing - punctuation, optionally followed by closing brackets, can end - sentences. The default value is + paragraphs. This may not include blank characters. Only closing + punctuation (see "punct"), optionally followed by the specified + closing brackets, can end sentences. The default value is - `""')>]}"' + ""')>]}" -`set/unset casesensitive' - Do case sensitive searches by default. +'set casesensitive' + Do case-sensitive searches by default. -`set/unset const' +'set const' Constantly display the cursor position in the status bar. -`set/unset cut' - Use cut to end of line by default, instead of cutting the whole +'set cut' + Use cut-to-end-of-line by default, instead of cutting the whole line. -`set fill "n"' - Wrap lines at column number "n". If "n" is 0 or less, the maximum - line length will be the screen width less "n" columns. The - default value is -8. +'set fill NUMBER' + Hard-wrap lines at column number NUMBER. If NUMBER is 0 or less, + the maximum line length will be the screen width less NUMBER + columns. The default value is -8. + +'set functioncolor FGCOLOR,BGCOLOR' + Specify the color combination to use for the function descriptions + in the two help lines at the bottom of the screen. See 'set + titlecolor' for more details. + +'set historylog' + Enable the use of '~/.nano/search_history' for saving and reading + search/replace strings. -`set/unset historylog' - Enable ~/.nano_history for saving and reading search/replace - strings. +'set keycolor FGCOLOR,BGCOLOR' + Specify the color combination to use for the shortcut key combos in + the two help lines at the bottom of the screen. See 'set + titlecolor' for more details. -`set matchbrackets "string"' +'set locking' + Enable vim-style lock-files for when editing files. + +'set matchbrackets "STRING"' Set the opening and closing brackets that can be found by bracket - searches. They cannot contain blank characters. The former set - must come before the latter set, and both must be in the same - order. The default value is + searches. This may not include blank characters. The opening set + must come before the closing set, and the two sets must be in the + same order. The default value is - `"(<[{)>]}"' + "(<[{)>]}" -`set/unset morespace' +'set morespace' Use the blank line below the titlebar as extra editing space. -`set/unset mouse' +'set mouse' Enable mouse support, so that mouse clicks can be used to place the cursor, set the mark (with a double click), or execute shortcuts. -`set/unset multibuffer' +'set multibuffer' Allow inserting files into their own buffers. -`set/unset noconvert' +'set noconvert' Don't convert files from DOS/Mac format. -`set/unset nofollow' +'set nofollow' Don't follow symlinks when writing files. -`set/unset nohelp' +'set nohelp' Don't display the help lists at the bottom of the screen. -`set/unset nonewlines' +'set nonewlines' Don't add newlines to the ends of files. -`set/unset nowrap' - Don't wrap text at all. +'set nowrap' + Don't hard-wrap text at all. -`set operatingdir "directory"' - `nano' will only read and write files inside "directory" and its +'set operatingdir "directory"' + 'nano' will only read and write files inside "directory" and its subdirectories. Also, the current directory is changed to here, so files are inserted from this directory. By default, the operating directory feature is turned off. -`set/unset preserve' +'set poslog' + Save the cursor position of files between editing sessions. + +'set preserve' Preserve the XON and XOFF keys (^Q and ^S). -`set punct "string"' +'set punct "STRING"' Set the characters treated as closing punctuation when justifying - paragraphs. They cannot contain blank characters. Only closing - punctuation, optionally followed by closing brackets, can end - sentences. The default value is `"!.?"'. + paragraphs. This may not include blank characters. Only the + specified closing punctuation, optionally followed by closing + brackets (see "brackets"), can end sentences. The default value is + "!.?". -`set/unset quickblank' +'set quickblank' Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25. -`set quotestr "string"' +'set quiet' + When set, 'nano' will not report errors in the nanorc file nor ask + them to be acknowledged by pressing Enter at startup. If this + option is used, it should be placed at the top of the file to be + fully effective. + +'set quotestr "STRING"' The email-quote string, used to justify email-quoted paragraphs. This is an extended regular expression if your system supports them, otherwise a literal string. The default value is - `"^([ \\t]*[#:>\\|}])+"' + "^([ \\t]*[#:>\\|}])+" - if you have extended regular expression support, or "> " otherwise. - Note that '\\t' stands for a literal Tab character. + if you have extended regular expression support, and "> " + otherwise. Note that '\\t' stands for a literal Tab character. -`set/unset rebinddelete' +'set rebinddelete' Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. -`set/unset rebindkeypad' +'set rebindkeypad' Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. -`set/unset regexp' +'set regexp' Do extended regular expression searches by default. -`set/unset smarthome' +'set smarthome' Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). - If the cursor is already at that position, it will jump to the - true beginning of the line. + If the cursor is already at that position, it will jump to the true + beginning of the line. -`set/unset smooth' +'set smooth' Use smooth scrolling by default. -`set/unset softwrap' - Use soft wrapping by default. +'set softwrap' + Enable soft line wrapping for easier viewing of very long lines. -`set speller "spellprog"' +'set speller "spellprog"' Use spelling checker "spellprog" instead of the built-in one, which calls "spell". -`set/unset suspend' - Allow `nano' to be suspended. +'set statuscolor FGCOLOR,BGCOLOR' + Specify the color combination to use for the statusbar. See 'set + titlecolor' for more details. -`set/unset suspendenable' - If `nano' is allowed to be suspended, allow the suspend key - (usually ^Z) to actually suspend it. +'set suspend' + Allow 'nano' to be suspended. -`set tabsize "n"' - Use a tab size of "n" columns. The value of "n" must be greater - than 0. The default value is 8. +'set tabsize NUMBER' + Use a tab size of NUMBER columns. The value of NUMBER must be + greater than 0. The default value is 8. -`set/unset tabstospaces' +'set tabstospaces' Convert typed tabs to spaces. -`set/unset tempfile' +'set tempfile' Save automatically on exit, don't prompt. -`set/unset undo' - Enable experimental generic-purpose undo code. +'set titlecolor FGCOLOR,BGCOLOR' + Specify the color combination to use for the titlebar. Valid color + names for foreground and background are: white, black, red, blue, + green, yellow, magenta, and cyan. And either FGCOLOR or ,BGCOLOR + may be left out. -`set/unset view' +'set view' Disallow file modification. -`set whitespace "string"' - Set the two characters used to display the first characters of - tabs and spaces. They must be single-column characters. +'set whitespace "STRING"' + Set the two characters used to indicate the presence of tabs and + spaces. They must be single-column characters. The default pair + for a UTF-8 locale is "»·", and for other locales ">.". -`set/unset wordbounds' +'set wordbounds' Detect word boundaries more accurately by treating punctuation characters as part of a word. -`syntax "str" ["fileregex" ... ]' + +File: nano.info, Node: Syntax Highlighting, Next: Rebinding Keys, Prev: Settings, Up: Nanorc Files + +5.2 Syntax Highlighting +======================= + +Coloring the different syntactic elements of a file is done via regular +expressions (see the 'color' command below). This is inherently +imperfect, because regular expressions are not powerful enough to fully +parse a file. Nevertheless, regular expressions can do a lot and are +easy to make, so they are a good fit for a small editor like 'nano'. + + A separate syntax can be defined for each kind of file via the +following commands in a nanorc file: + +'syntax "str" ["fileregex" ...]' Defines a syntax named "str" which can be activated via the - -Y/-syntax command line option, or will be automatically activated + -Y/-syntax command-line option, or will be automatically activated if the current filename matches the extended regular expression "fileregex". All following "color" and "icolor" statements will - apply to "syntax" until a new syntax is defined. - - The "none" syntax is reserved; specifying it on the command line - is the same as not having a syntax at all. The "default" syntax - is special: it takes no "fileregex", and applies to files that - don't match any other syntax's "fileregex". - -`color fgcolor,bgcolor "regex" ...' + apply to this "str" syntax until a new syntax is defined. + + The "none" syntax is reserved; specifying it on the command line is + the same as not having a syntax at all. The "default" syntax is + special: it takes no "fileregex", and applies to files that don't + match any other syntax's "fileregex". + +'linter program [arg ...]' + For the currently defined syntax, use the given program to invoke + the linter (this overrides the speller function when defined). + +'formatter program [arg ...]' + For the currently defined syntax, use the given program to + automatically reformat text. Useful in certain programming + languages (e.g. go). + +'header "regex" ...' + For the currently defined syntax, add one or more regexes which + will be compared against the very first line of the file to be + edited, to determine whether this syntax should be used for that + file. + +'magic "regex" ...' + For the currently defined syntax, add one or more regexes which + will be compared against the result of querying the magic database + about the file to be edited, to determine whether this syntax + should be used for that file. This functionality only works when + libmagic is installed on the system and will be silently ignored + otherwise. + +'color fgcolor,bgcolor "regex" ...' For the currently defined syntax, display all expressions matching the extended regular expression "regex" with foreground color "fgcolor" and background color "bgcolor", at least one of which - must be specified. Legal colors for foreground and background - color are: white, black, red, blue, green, yellow, magenta, and - cyan. You may use the prefix "bright" to force a stronger color - highlight for the foreground. If your terminal supports - transparency, not specifying a "bgcolor" tells "nano" to attempt - to use a transparent background. - -`icolor fgcolor,bgcolor "regex" ...' + must be specified. Valid colors for foreground and background are: + white, black, red, blue, green, yellow, magenta, and cyan. You may + use the prefix "bright" to get a stronger color highlight for the + foreground. If your terminal supports transparency, not specifying + a "bgcolor" tells 'nano' to attempt to use a transparent + background. + +'icolor fgcolor,bgcolor "regex" ...' Same as above, except that the expression matching is case insensitive. -`color fgcolor,bgcolor start="sr" end="er"' +'color fgcolor,bgcolor start="sr" end="er"' Display expressions which start with the extended regular expression "sr" and end with the extended regular expression "er" with foreground color "fgcolor" and background color "bgcolor", at @@ -672,15 +862,378 @@ end. For example, for the "brackets" option, instances of "sr" after an initial "sr" is found will be highlighted until the first instance of "er". -`icolor fgcolor,bgcolor start="sr" end="er"' +'icolor fgcolor,bgcolor start="sr" end="er"' Same as above, except that the expression matching is case insensitive. -`include "syntaxfile"' +'include "syntaxfile"' Read in self-contained color syntaxes from "syntaxfile". Note that - "syntaxfile" can only contain "syntax", "color", and "icolor" - commands. + "syntaxfile" can only contain the above commands, from "syntax" to + "icolor". + +'extendsyntax str directive [arg ...]' + Extend the syntax previously defined as str to include new + information. Allows you to add a new color, icolor, magic, header, + or linter directive to an already defined syntax. Useful when you + want to add to definitions from the system-installed syntax + definitions (which are normally not writable). + + +File: nano.info, Node: Rebinding Keys, Prev: Syntax Highlighting, Up: Nanorc Files + +5.3 Rebinding Keys +================== + +Key bindings may be reassigned via the following two commands in a +nanorc file: + +'bind key function menu' + Rebinds 'key' to 'function' in the context of 'menu' (or in all + menus where the function exists by using 'all'). + +'unbind key menu' + Unbinds 'key' from 'menu' (or from all menus where it exists by + using 'all'). + + The format of 'key' should be one of: + +'^' + followed by an alpha character or the word "Space". Example: '^C' + +'M-' + followed by a printable character or the word "Space". Example: + 'M-C' + +'F' + followed by a numeric value from 1 to 16. Example: 'F10' + + Valid names for the 'function' to be bound are: + +'help' + Invokes the help viewer. + +'cancel' + Cancels the current command. + +'exit' + Exits from the program (or from the help viewer or the file + browser). + +'writeout' + Writes the current buffer to disk. + +'insert' + Inserts a file into the current buffer (or into a new buffer when + multibuffer is enabled). + +'whereis' + Searches for text in the current buffer - or for filenames matching + a string in the current list in the file browser + +'searchagain' + Repeats the last search command. + +'replace' + Interactively replaces text within the current buffer. + +'cut' + Cuts and stores the current line (or the marked region). + +'copytext' + Copies the current line (or the marked region) without deleting it. + +'uncut' + Copies the currently stored text into the current buffer at the + current cursor position. + +'mark' + Sets the mark at the current position, to start selecting text. + +'cutrestoffile' + Cuts all text from the cursor position till the end of the buffer. + +'curpos' + Shows the current cursor position: the line, column, and character + positions. + +'wordcount' + Counts the number of words, lines and characters in the current + buffer. + +'speller' + Invokes a spell-checking program (or a linting program, if the + current syntax highlighting defines one). + +'justify' + Justifies the current paragraph. + +'fulljustify' + Justifies the entire current buffer. + +'indent' + Indents (shifts to the right) the currently marked text. + +'unindent' + Unindents (shifts to the left) the currently marked text. + +'left' + Goes left one position (in the editor or browser). + +'right' + Goes right one position (in the editor or browser). + +'up' + Goes one line up (in the editor or browser). + +'down' + Goes one line down (in the editor or browser). +'scrollup' + Scrolls up one line of text from the current position. + +'scrolldown' + Scrolls down one line of text from the current position. + +'nextword' + Moves the cursor to the beginning of the next word. + +'prevword' + Moves the cursor to the beginning of the previous word. + +'home' + Moves the cursor to the beginning of the current line. + +'end' + Moves the cursor to the end of the current line. + +'beginpara' + Moves the cursor to the beginning of the current paragraph. + +'endpara' + Moves the cursor to the end of the current paragraph. + +'prevpage' + Goes up one screenful. + +'nextpage' + Goes down one screenful. + +'firstline' + Goes to the first line of the file. + +'lastline' + Goes to the last line of the file. + +'gotoline' + Goes to a specific line (and column if specified). + +'gototext' + Switches from targeting a line number to searching for text. + +'findbracket' + Moves the cursor to the bracket (brace, parenthesis, etc.) that + matches (pairs) with the one under the cursor. + +'prevbuf' + Switches to editing/viewing the previous buffer when using + multibuffer mode. + +'nextbuf' + Switches to editing/viewing the next buffer when using multibuffer + mode. + +'verbatim' + Inserts the next character verbatim into the file. + +'tab' + Inserts a tab at the current cursor location. + +'enter' + Inserts a new line below the current one. + +'delete' + Deletes the character under the cursor. + +'backspace' + Deletes the character before the cursor. + +'undo' + Undoes the last performed text action (add text, delete text, etc). + +'redo' + Redoes the last undone action (i.e., it undoes an undo). + +'refresh' + Refreshes the screen. + +'suspend' + Suspends the editor (if the suspending function is enabled, see the + "suspendenable" entry below). + +'casesens' + Toggles case sensitivity in searching (search/replace menus only). + +'regexp' + Toggles whether searching/replacing is based on literal strings or + regular expressions. + +'backwards' + Toggles whether searching/replacing goes forward or backward. + +'prevhistory' + Shows the previous history entry in the prompt menus (e.g. + search). + +'nexthistory' + Shows the next history entry in the prompt menus (e.g. search). + +'flipreplace' + Toggles between searching for something and replacing something. + +'flipexecute' + Toggles between inserting a file and executing a command. + +'flipnewbuffer' + Toggles between inserting into the current buffer and into a new + empty buffer. + +'dosformat' + When writing a file, switches to writing a DOS format (CR/LF). + +'macformat' + When writing a file, switches to writing a Mac format. + +'append' + When writing a file, appends to the end instead of overwriting. + +'prepend' + When writing a file, 'prepends' (writes at the beginning) instead + of overwriting. + +'backup' + When writing a file, creates a backup of the current file. + +'tofiles' + Starts the file browser, allowing to select a file from a list. + +'gotodir' + Goes to a directory to be specified, allowing to browse anywhere in + the filesystem. + +'firstfile' + Goes to the first file when using the file browser (reading or + writing files). + +'lastfile' + Goes to the last file when using the file browser (reading or + writing files). + +'nohelp' + Toggles the presence of the two-line list of key bindings at the + bottom of the screen. + +'constupdate' + Toggles the constant display of the current line, column, and + character positions. + +'morespace' + Toggles the presence of the blank line which 'separates' the + titlebar from the file text. + +'smoothscroll' + Toggles smooth scrolling (when moving around with the arrow keys). + +'softwrap' + Toggles the displaying of overlong lines on multiple screen lines. + +'whitespacedisplay' + Toggles the showing of whitespace. + +'nosyntax' + Toggles syntax highlighting. + +'smarthome' + Toggles the smartness of the Home key. + +'autoindent' + Toggles whether new lines will contain the same amount of + whitespace as the preceding line. + +'cuttoend' + Toggles whether cutting text will cut the whole line or just from + the current cursor position to the end of the line. + +'nowrap' + Toggles whether long lines will be hard-wrapped to the next line. + +'tabstospaces' + Toggles whether typed tabs will be converted to spaces. + +'backupfile' + Toggles whether a backup will be made of the file to be edited. + +'multibuffer' + Toggles the use of multiple file buffers (if available). + +'mouse' + Toggles mouse support. + +'noconvert' + Toggles automatic conversion of files from DOS/Mac format. + +'suspendenable' + Toggles whether the suspend sequence (normally ^Z) will suspend the + editor window. + + Valid names for 'menu' are: + +'main' + The main editor window where text is entered and edited. + +'search' + The search menu (AKA whereis). + +'replace' + The 'search to replace' menu. + +'replacewith' + The 'replace with' menu, which comes up after 'search to replace'. + +'gotoline' + The 'goto line (and column)' menu. + +'writeout' + The 'write file' menu. + +'insert' + The 'insert file' menu. + +'extcmd' + The menu for inserting output from an external command, reached + from the insert menu. + +'help' + The help-viewer menu. + +'spell' + The interactive spell checker Yes/no menu. + +'linter' + The linter menu. + +'browser' + The file browser for inserting or writing a file. + +'whereisfile' + The 'search for a file' menu in the file browser. + +'gotodir' + The 'go to directory' menu in the file browser. + +'all' + A special name that encompasses all menus. For 'bind' it means all + menus where the specified 'function' exists; for 'unbind' it means + all menus where the specified 'key' exists. File: nano.info, Node: The File Browser, Next: Pico Compatibility, Prev: Nanorc Files, Up: Top @@ -707,52 +1260,52 @@ File: nano.info, Node: Pico Compatibility, Next: Building and Configure Option 7 Pico Compatibility ******************** -`nano' attempts to emulate Pico as closely as possible, but there are +'nano' attempts to emulate Pico as closely as possible, but there are certain differences between the editors: -`Search and Replace History' - As of version 1.1.99pre1 of `nano', text entered as search or +'Search and Replace History' + As of version 1.1.99pre1 of 'nano', text entered as search or replace strings will be stored and can be accessed with the up/down - arrow keys. Previously, `nano' offered a more consistent, but + arrow keys. Previously, 'nano' offered a more consistent, but incompatible with Pico, method for entering search and replace - strings. In the old method, previous entries would be displayed - by default as editable text in front of the cursor, as opposed to + strings. In the old method, previous entries would be displayed by + default as editable text in front of the cursor, as opposed to being bracketed and uneditable as it is in Pico. The old behavior - could be made compatible with Pico via the `-p' option, but recent - versions of Pico use the `-p' option to preserve the XON and XOFF + could be made compatible with Pico via the '-p' option, but recent + versions of Pico use the '-p' option to preserve the XON and XOFF sequences within the editor. Since, with the new method, search and replace strings can still be edited by simply hitting the up arrow key once, the old method was removed completely. -`Writing, Appending, or Prepending Selected Text to Files' +'Writing, Appending, or Prepending Selected Text to Files' Text selected using the marking key (^^) can be written out, - appended, or prepended to a new or existing file using the - WriteOut key (^O). + appended, or prepended to a new or existing file using the WriteOut + key (^O). -`Toggles' +'Toggles' Many options which alter the functionality of the program can be "toggled" on or off using Meta key sequences, meaning the program does not have to be restarted to turn a particular feature of the - editor on or off. Please see the internal help function (^G) for - a list of what functions can be toggled for a particular version - of `nano'. See *Note Feature Toggles::, for more info. - -`Cursor Position Display' - The output of the "Display Cursor Position" in `nano' displays the - given column position, as well as the row and total character - position of the cursor. - -`Interactive Replace and Spell Checker' - It is worth noting that `nano''s replace function is interactive, - i.e. it does not stop after one search string is found and - automatically replace it. The `nano' implementation will pause at - each search string found and query whether to replace this - instance or not. The internal spell checker operates similarly. - Note that there is no way to force these functions to behave in - the Pico fashion. As of version 1.1.99pre1, misspelled words are - sorted and trimmed for uniqueness in the internal spell checker - such that the words 'apple' and 'Apple' will be prompted for - correction separately. + editor on or off. Please see the internal help function (^G) for a + list of what functions can be toggled for a particular version of + 'nano'. See *Note Feature Toggles::, for more info. + +'Cursor Position Display' + The output of the "Display Cursor Position" in 'nano' displays the + current line position of the cursor, as well as the column and + total character position. + +'Interactive Replace and Spell Checker' + It is worth noting that 'nano''s replace function is interactive, + i.e. it does not stop after one search string was found and + automatically replaced. The 'nano' implementation will pause at + each found search string and query whether to replace this instance + or not. The internal spell checker operates similarly. Note that + there is no way to force these functions to behave in the Pico + fashion. As of version 1.1.99pre1, misspelled words are sorted and + trimmed for uniqueness in the internal spell checker such that the + words 'apple' and 'Apple' will be prompted for correction + separately. File: nano.info, Node: Building and Configure Options, Prev: Pico Compatibility, Up: Top @@ -760,125 +1313,146 @@ File: nano.info, Node: Building and Configure Options, Prev: Pico Compatibilit 8 Building and Configure Options ******************************** -Building `nano' from source is fairly straightforward if you are +Building 'nano' from source is fairly straightforward if you are familiar with compiling programs with autoconf support: - * tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of `nano') - + * tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of 'nano') * cd nano-x.y.z/ - * ./configure - * make - * make install - The possible options to `./configure' are: + The possible options to './configure' are: -`--disable-browser' +'--disable-browser' Disable the mini file browser when reading or writing files. -`--disable-help' +'--disable-color' + Disable support for the syntax coloring of files. This also + eliminates the -Y command-line option, which chooses a specific + syntax. + +'--disable-extra' + Disable extra features. At the moment, this is just + easter-egg-type stuff. + +'--disable-help' Disable the help function. Doing this makes the binary much smaller, but makes it difficult for new users to learn more than very basic things about using the editor. -`--disable-justify' - Disable the justify and unjustify functions. - -`--disable-mouse' - Disable all mouse functionality. This also disables the -m - command line option, which enables the mouse functionality. +'--disable-histories' + Disable the code for the handling of the history files: the search + and replace strings that were used, and the cursor position at + which each file was closed. This also eliminates the -H and -P + command-line options, which switch on the logging of search/replace + strings and cursor positions. -`--disable-operatingdir' - Disable setting the operating directory. This also disables the -o - command line option, which sets the operating directory. +'--disable-justify' + Disable the justify and unjustify functions. -`--disable-speller' - Disable use of the spell checker. This also disables the -s - command line option, which allows specifying an alternate spell +'--disable-libmagic' + Disable the use of the library of magic-number tests (for + determining the file type and thus which syntax to use for + colouring - often the tests on filename extension and header line + will be enough). + +'--disable-mouse' + Disable all mouse functionality. This also eliminates the -m + command-line option, which enables the mouse functionality. + +'--disable-multibuffer' + Disable support for opening multiple files at a time and switching + between them on the fly. This also eliminates the -F command-line + option, which switches the use of multiple file buffers on. + +'--disable-nanorc' + Disable support for reading the nanorc files at startup. With such + support, you can store custom settings in a system-wide and a + per-user nanorc file rather than having to pass command-line + options to get the desired behavior. See *Note Nanorc Files::, for + more info. Disabling this also eliminates the -I and -q + command-line options; the first inhibits the reading of + nanorcfiles, and the second suppresses warnings about errors in + those files. + +'--disable-operatingdir' + Disable setting the operating directory. This also eliminates the + -o command-line option, which sets the operating directory. + +'--disable-speller' + Disable use of the spell checker. This also eliminates the -s + command-line option, which allows specifying an alternate spell checker. -`--disable-tabcomp' +'--disable-tabcomp' Disable the tab completion code when reading or writing files. -`--disable-wrapping' - Disable all long line wrapping. This also eliminates the -w - command line option, which enables long line wrapping. +'--disable-wrapping' + Disable hard-wrapping of overlong lines. This also eliminates the + -w command-line option, which enables long-line wrapping. -`--enable-tiny' +'--enable-tiny' This option disables all the above. It also disables some of the - larger internals of the editor, like the marking code and the cut - to end of line code. It also disables the function toggles. + larger internals of the editor, like the marking code and the + cut-to-end-of-line code. It also disables the function toggles. + By using the enabling counterpart of the above options together + with -enable-tiny, specific features can be switched back on. -`--enable-debug' +'--enable-debug' Enable support for runtime debug output. This can get pretty - messy, so chances are you only want this feature to work on the - nano source. - -`--enable-extra' - Enable extra features. At the moment, this is just easter egg-type - stuff. + messy, so chances are you only want this feature when you're + working on the nano source. -`--enable-color' - Enable support for syntax coloring of files using the nanorc file. - This enables nanorc support as well. +'--disable-nls' + Disables Native Language support. This will disable the use of any + available GNU 'nano' translations. -`--enable-multibuffer' - Enable support for opening multiple files at a time and switching - between them on the fly. +'--disable-wrapping-as-root' + Disable hard-wrapping of overlong lines by default when 'nano' is + run as root. -`--enable-nanorc' - Enable support for reading the nanorc file at startup. You can - store custom settings in the nanorc file rather than having to - pass command line options to get desired behavior. See *Note - Nanorc Files::, for more info. - -`--enable-all' - Shortcut for enabling the above four features (extra, color, - multibuffer, and nanorc). - -`--disable-nls' - Disables Native Language support. This will disable use of the - available GNU `nano' translations. - -`--disable-wrapping-as-root' - Disable long line wrapping by default when nano is run as root. - -`--enable-utf8' +'--enable-utf8' Enable support for reading and writing Unicode files. This will - require either a wide version of curses, or a UTF-8-enabled - version of Slang. - -`--disable-utf8' - Disable support for reading and writing Unicode files. + require either a wide version of curses, or a UTF-8-enabled version + of Slang. -`--with-slang' - Compiling `nano' with Slang is supported, and will make the binary - notably smaller than if compiled with ncurses or other curses - libraries. +'--disable-utf8' + Disable support for reading and writing Unicode files. Normally + the configure script auto-detects whether to enable UTF-8 support + or not. You can use this or the previous option to override that + detection. +'--with-slang' + Compile 'nano' against Slang instead of against ncurses or other + curses libraries. Tag Table: -Node: Top200 -Node: Introduction527 -Node: Overview966 -Node: Command Line Options1871 -Ref: Expert Mode7858 -Node: Editor Basics8745 -Node: Entering Text8994 -Node: Special Functions9342 -Node: The Titlebar10346 -Node: The Statusbar11071 -Node: Shortcut Lists11643 -Node: Using the Mouse11923 -Node: Online Help12383 -Node: Feature Toggles12760 -Node: Nanorc Files14867 -Node: The File Browser23472 -Node: Pico Compatibility24294 -Node: Building and Configure Options26950 +Node: Top199 +Node: Introduction550 +Node: Overview990 +Node: Command Line Options1874 +Ref: Expert Mode8793 +Node: Editor Basics9758 +Node: Entering Text10038 +Node: Special Functions10364 +Node: The Cutbuffer11404 +Node: The Mark12091 +Node: The Titlebar12828 +Node: The Statusbar13544 +Node: Shortcut Lists14117 +Node: Using the Mouse14397 +Node: Online Help14990 +Node: Feature Toggles15366 +Node: Nanorc Files17428 +Node: Settings18859 +Ref: Whitespace25479 +Node: Syntax Highlighting25831 +Node: Rebinding Keys29957 +Node: The File Browser38444 +Node: Pico Compatibility39266 +Node: Building and Configure Options41926 End Tag Table diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi index fe12428..b77feb1 100644 --- a/doc/texinfo/nano.texi +++ b/doc/texinfo/nano.texi @@ -7,9 +7,9 @@ @c This file has the new style title page commands. @c Run 'makeinfo' rather than 'texinfo-format-buffer'. @smallbook -@set EDITION 0.1 -@set VERSION 2.2.0 -@set UPDATED 30 Nov 2009 +@set EDITION 0.3 +@set VERSION 2.4.0 +@set UPDATED March 2015 @dircategory Editors @direntry @@ -23,7 +23,7 @@ @titlepage @title GNU @code{nano} @subtitle a small and friendly text editor. -@subtitle version 2.2.0 +@subtitle version 2.4.0 @author Chris Allegretta @page @@ -32,9 +32,9 @@ This manual documents GNU @code{nano}, a small and friendly text editor. This manual is part of the GNU @code{nano} distribution.@* -@sp4 +@sp 4 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, -2008, 2009 Free Software Foundation, Inc. +2009, 2014, 2015 Free Software Foundation, Inc. This document is dual-licensed. You may distribute and/or modify it under the terms of either of the following licenses: @@ -54,7 +54,9 @@ You may contact the author by e-mail: @email{chrisa@@asty.org}@* @end titlepage -@node Top, Introduction, (dir), (dir) + +@node Top +@top This manual documents GNU @code{nano}, a small and friendly text editor. @@ -70,12 +72,13 @@ editor. * Building and Configure Options:: @end menu -@node Introduction, Editor Basics, Top, Top + +@node Introduction @chapter Introduction GNU @code{nano} is a small and friendly text editor. Besides basic text -editing, @code{nano} offers many extra features like an interactive -search and replace, go to line and column number, auto-indentation, +editing, @code{nano} offers many extra features, like an interactive +search-and-replace, go-to-line-and-column-number, auto-indentation, feature toggles, internationalization support, and filename tab completion. @@ -84,7 +87,7 @@ completion. * Command Line Options:: @end menu -@node Overview, Command Line Options, Introduction, Introduction +@node Overview @section Overview The original goal for @code{nano} was a complete bug-for-bug compatible @@ -113,245 +116,334 @@ adding it with a comma. So the complete synopsis is: Email bug reports to @email{nano@@nano-editor.org}. -@node Command Line Options, , Overview, Introduction +@node Command Line Options @section Command Line Options -@code{nano} takes the following options from the command line: +@command{nano} takes the following options from the command line: -@table @code -@item +LINE,COLUMN -Start at line number LINE and column number COLUMN (at least one of +@table @option +@item +@var{line},@var{column} +Start at line number @var{line} and column number @var{column} (at least one of which must be specified) instead of the default of line 1, column 1. -@item -? -Same as @code{-h, --help}. - -@item -A, --smarthome +@item -A +@itemx --smarthome Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line. -@item -B, --backup +@item -B +@itemx --backup When saving a file, back up the previous version of it to the current -filename suffixed with a ~. +filename suffixed with a @samp{~}. -@item -C <dir>, --backupdir=<dir> -Set the directory where @code{nano} puts unique backup files if file +@item -C @var{directory} +@itemx --backupdir=@var{directory} +Set the directory where @command{nano} puts unique backup files if file backups are enabled. -@item -D, --boldtext +@item -D +@itemx --boldtext Use bold text instead of reverse video text. -@item -E, --tabstospaces +@item -E +@itemx --tabstospaces Convert typed tabs to spaces. -@item -F, --multibuffer -Enable multiple file buffers, if available. +@item -F +@itemx --multibuffer +Enable multiple file buffers (if support for them has been compiled in). + +@item -G +@itemx --locking +Enable vim-style file locking when editing files. -@item -H, --historylog -Log search and replace strings to ~/.nano_history, so they can be -retrieved in later sessions, if nanorc support is available. +@item -H +@itemx --historylog +Log search and replace strings to @file{~/.nano/search_history}, +so they can be retrieved in later sessions. -@item -I, --ignorercfiles -Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is -available. +@item -I +@itemx --ignorercfiles +Don't look at the system's nanorc file nor at the user's @file{~/.nanorc}. -@item -K, --rebindkeypad +@item -K +@itemx --rebindkeypad Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. -@item -L, --nonewlines +@item -L +@itemx --nonewlines Don't add newlines to the ends of files. -@item -N, --noconvert -Don't convert files from DOS/Mac format. +@item -N +@itemx --noconvert +Disable automatic conversion of files from DOS/Mac format. -@item -O, --morespace +@item -O +@itemx --morespace Use the blank line below the titlebar as extra editing space. -@item -Q <str>, --quotestr=<str> +@item -P +@itemx --poslog +Log for each file the last location of the cursor, and read it +back upon reopening the file and place it there again. + +@item -Q "@var{characters}" +@itemx --quotestr="@var{characters}" Set the quoting string for justifying. The default value is @quotation -@code{^([ \t]*[|>:@}#])+} +"^([ \t]*[|>:@}#])+" @end quotation -if extended regular expression support is available, or "> " otherwise. +if extended regular expression support is available, or @code{> } otherwise. Note that @code{\t} above stands for a literal Tab character. -@item -R, --restricted +@item -R +@itemx --restricted Restricted mode: don't read or write to any file not specified on the -command line; read any nanorc files; allow suspending; allow a file to -be appended to, prepended to, or saved under a different name if it -already has one; or use backup files or spell checking. Also accessible -by invoking @code{nano} with any name beginning with 'r' (e.g. "rnano"). - -@item -S, --smooth +command line; don't read any nanorc files nor history files; don't allow +suspending nor spell checking; don't +allow a file to be appended to, prepended to, or saved under a different +name if it already has one; and don't use backup files. +This restricted mode is also accessible by invoking @command{nano} with +any name beginning with @samp{r} (e.g. @command{rnano}). + +@item -S +@itemx --smooth Enable smooth scrolling. Text will scroll line-by-line, instead of the usual chunk-by-chunk behavior. -@item -T <#cols>, --tabsize=<#cols> -Set the displayed tab length to #cols columns. The value of #cols must -be greater than 0. The default value is 8. +@item -T @var{number} +@itemx --tabsize=@var{number} +Set the displayed tab length to @var{number} columns. The value of +@var{number} must be greater than 0. The default value is @samp{8}. -@item -U, --quickblank +@item -U +@itemx --quickblank Do quick statusbar blanking. Statusbar messages will disappear after 1 -keystroke instead of 25. Note that -c overrides this. +keystroke instead of 25. Note that @option{-c} overrides this. -@item -V, --version +@item -V +@itemx --version Show the current version number and exit. -@item -W, --wordbounds +@item -W +@itemx --wordbounds Detect word boundaries more accurately by treating punctuation characters as parts of words. -@item -Y <str>, --syntax=<str> -Specify a specific syntax highlighting from the nanorc to use, if -available. See @xref{Nanorc Files}, for more info. +@item -Y @var{name} +@itemx --syntax=@var{name} +Specify a specific syntax from the nanorc files to use for highlighting. +See @xref{Syntax Highlighting}, for more info. -@item -c, --const +@item -c +@itemx --const Constantly display the cursor position and line number on the statusbar. -Note that this overrides -U. +Note that this overrides @option{-U}. -@item -d, --rebinddelete +@item -d +@itemx --rebinddelete Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. -@item -h, --help -Show a summary of command line options and exit. +@item -h +@itemx --help +Show a summary of command-line options and exit. -@item -i, --autoindent +@item -i +@itemx --autoindent Automatically indent new lines to the same number of spaces and tabs as the previous line. -@item -k, --cut -Cut from the current cursor position to the end of the current line. +@item -k +@itemx --cut +Make the 'Cut Text' command (normally ^K) cut from the current cursor +position to the end of the line, instead of cutting the entire line. -@item -l, --nofollow +@item -l +@itemx --nofollow When writing files, if the given file is a symbolic link, it is removed and a new file is created. -@item -m, --mouse +@item -m +@itemx --mouse Enable mouse support, if available for your system. When enabled, mouse clicks can be used to place the cursor, set the mark (with a double click), and execute shortcuts. The mouse will work in the X Window -System, and on the console when gpm is running. - -@item -o <dir>, --operatingdir=<dir> -Set operating directory. Makes @code{nano} set up something similar to -a chroot. - -@item -p, --preserve +System, and on the console when gpm is running. Text can still be +selected through dragging by holding down the Shift key. + +@item -n +@itemx --noread +Treat any name given on the command line as a new file. This allows +@command{nano} to write to named pipes: it will start with a blank buffer, +and will write to the pipe when the user saves the "file". This way +@command{nano} can be used as an editor in combination with for instance +@command{gpg} without having to write sensitive data to disk first. + +@item -o @var{directory} +@itemx --operatingdir=@var{directory} +Set the operating directory. This makes @command{nano} set up something +similar to a chroot. + +@item -p +@itemx --preserve Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the -editor can be can be stopped and started. +editor can be stopped and started. -@item -q, --quiet -Do not report errors in the nanorc file and ask them to be acknowledged +@item -q +@itemx --quiet +Do not report errors in the nanorc file nor ask them to be acknowledged by pressing Enter at startup. -@item -r <#cols>, --fill=<#cols> -Wrap lines at column #cols. If this value is 0 or less, wrapping will -occur at the width of the screen less #cols, allowing it to vary along -with the width of the screen if the screen is resized. The default -value is -8. - -@item -s <prog>, --speller=<prog> -Invoke the given program as the spell checker. By default, @code{nano} -uses the command specified in the SPELL environment variable, or, if -SPELL is not set, its own interactive spell checker that requires the -@code{spell} program to be installed on your system. - -@item -t, --tempfile +@item -r @var{number} +@itemx --fill=@var{number} +Hard-wrap lines at column @var{number} (by inserting a newline character). +If the given value is 0 or less, wrapping will occur at the width of +the screen minus the given amount, allowing the wrapping width to +vary along with the width of the screen if and when it is resized. +The default value is @samp{-8}. This option conflicts with @option{-w} +-- the last one given takes effect. + +@item -s @var{program} +@itemx --speller=@var{program} +Invoke the given program as the spell checker. By default, @command{nano} +uses the command specified in the @env{SPELL} environment variable, or, +if @env{SPELL} is not set, its own interactive spell checker that requires +the @command{spell} program to be installed on your system. + +@item -t +@itemx --tempfile Don't ask whether or not to save the current contents of the file when -exiting, assume yes. This is most useful when using @code{nano} as the +exiting, assume yes. This is most useful when using @command{nano} as the composer of a mailer program. -@item -u, --undo -Enable experimental generic-purpose undo code. By default, the undo and -redo shortcuts are Meta-U and Meta-E, respectively. - -@item -v, --view +@item -v +@itemx --view Don't allow the contents of the file to be altered. Note that this option should NOT be used in place of correct file permissions to implement a read-only file. -@item -w, --nowrap -Don't wrap long lines at any length. This option overrides any value -for -r. +@item -w +@itemx --nowrap +Don't hard-wrap long lines at any length. This option conflicts with +@option{-r} -- the last one given takes effect. @anchor{Expert Mode} -@item -x, --nohelp +@item -x +@itemx --nohelp Expert Mode: don't show the Shortcut Lists at the bottom of the screen. This affects the location of the statusbar as well, as in Expert Mode it is located at the very bottom of the editor. Note: When accessing the help system, Expert Mode is temporarily -disabled to display the help system navigation keys. +disabled to display the help-system navigation keys. -@item -z, --suspend -Enable @code{nano}'s suspend ability using the system's suspend +@item -z +@itemx --suspend +Enable the ability to suspend @command{nano} using the system's suspend keystroke (usually ^Z). -@item -$, --softwrap -Enable 'soft wrapping'. @code{nano} will attempt to display the entire -contents of a line, even if it is longer than the screen width. Since -'$' normally refers to a variable in the Unix shell, you should specify -this option last when using other options (e.g. 'nano -wS$') or pass it -separately (e.g. 'nano -wS -$'). - -@item -a, -b, -e, -f, -g, -j +@item -$ +@itemx --softwrap +Enable 'soft wrapping'. This will make @command{nano} attempt to display the +entire contents of any line, even if it is longer than the screen width, by +continuing it over multiple screen lines. Since +@samp{$} normally refers to a variable in the Unix shell, you should specify +this option last when using other options (e.g. @code{nano -wS$}) or pass it +separately (e.g. @code{nano -wS -$}). + +@item -a +@itemx -b +@itemx -e +@itemx -f +@itemx -g +@itemx -j Ignored, for compatibility with Pico. @end table -@node Editor Basics, Online Help, Introduction, Top +@node Editor Basics @chapter Editor Basics + @menu * Entering Text:: * Special Functions:: +* The Cutbuffer:: +* The Mark:: * The Titlebar:: * The Statusbar:: * Shortcut Lists:: * Using the Mouse:: @end menu -@node Entering Text, Special Functions, Editor Basics, Editor Basics +@node Entering Text @section Entering Text +@code{nano} is a "modeless" editor. All keystrokes, with the exception +of Control and Meta key sequences, enter text into the file being edited. All key sequences in @code{nano} are entered using the keyboard. -@code{nano} is a "modeless" editor. All keys, with the exception of -Control and Meta key sequences, will enter text into the file being -edited. -@node Special Functions, The Titlebar, Entering Text, Editor Basics +@node Special Functions @section Special Functions -Special functions use the Control (Ctrl) key, displayed in the help and -shortcut lists as ^; the Meta key, displayed as M; or the Escape (Esc) -key. +Special functions use the Control key (Ctrl), displayed in the help and +shortcut lists as ^; the Meta key (Alt or Cmd), displayed as M-; or the +Escape key (Esc). @itemize @bullet @item Control key sequences are entered by holding down the Ctrl key and -pressing the desired key, or by pressing the Esc key twice and pressing -the desired key. +pressing the desired key, or by pressing the Esc key twice and then +pressing the desired key. @item -Pressing Esc twice and then typing a three-digit number from 000 to 255 -will enter the character with the corresponding value. +Pressing the Esc key twice and then typing a three-digit number from +000 to 255 will enter the character with the corresponding value. @item Meta key sequences are entered by holding down the Meta key (normally the Alt key) and pressing the desired key, or by pressing the Esc key -once and pressing the desired key. Certain operating systems "swallow" +once and then pressing the desired key. Certain operating systems "swallow" the Alt key so that it never reaches the application; if your operating system does this, you should use the Esc key to generate Meta key sequences. @end itemize -@node The Titlebar, The Statusbar, Special Functions, Editor Basics +@node The Cutbuffer +@section The Cutbuffer + +Text can be cut from a file, a whole line at a time, by using the 'Cut Text' +command (default key binding: ^K). The cut line is stored in the cutbuffer. +Consecutive strokes of ^K will add each cut line to this buffer, but a ^K +after any other keystroke will overwrite the entire cutbuffer. + +The contents of the cutbuffer can be pasted back into the file with the +'Uncut Text' command (default key binding: ^U). + +A line of text can be copied into the cutbuffer (without cutting it) with +the 'Copy Text' command (default key binding: M-6). + +@node The Mark +@section The Mark + +Text can be selected by first 'setting the Mark' (default key bindings: +^6 and M-A) and then moving the cursor to the other end of the portion +to be selected. The selected portion of text will be highlighted in +reverse video (or in bold if you set the boldtext option). +This selection can now be cut or copied in its entirety with a single +^K or M-6. Or the selection can be used to limit the scope of a +search-and-replace (^\) or spell-checking session (^T). + +Cutting or copying selected text will toggle the mark off automatically. +If necessary, it can be toggled off manually with another ^6 or M-A. + +@node The Titlebar @section The Titlebar The titlebar is the line displayed at the top of the editor. There are @@ -365,7 +457,7 @@ Special modes: When @code{nano} is in "File browser" mode, the center section will display the current directory instead of the filename. See @xref{The File Browser}, for more info. -@node The Statusbar, Shortcut Lists, The Titlebar, Editor Basics +@node The Statusbar @section The Statusbar The statusbar is the third line from the bottom of the screen, or the @@ -375,38 +467,40 @@ occur from using the editor will appear on the statusbar. Any questions that are asked of the user will be asked on the statusbar, and any user input (search strings, filenames, etc.) will be input on the statusbar. -@node Shortcut Lists, Using the Mouse, The Statusbar, Editor Basics +@node Shortcut Lists @section Shortcut Lists The Shortcut Lists are the two lines at the bottom of the screen which show some of the more commonly used functions in the editor. -@node Using the Mouse, , Shortcut Lists, Editor Basics +@node Using the Mouse @section Using the Mouse When mouse support has been configured and enabled, a single mouse click places the cursor at the indicated position. Clicking a second time in the same position toggles the mark. Clicking in the shortcut list -executes the selected shortcut. +executes the selected shortcut. To be able to select text with the +left button, or paste text with the middle button, hold down the +Shift key during those actions. The mouse will work in the X Window System, and on the console when gpm is running. -@node Online Help, Feature Toggles, Editor Basics, Top +@node Online Help @chapter Online Help The online help system in @code{nano} is available by pressing ^G. -It is fairly self explanatory, documenting the various parts of the +It is fairly self-explanatory, documenting the various parts of the editor and available keystrokes. Navigation is via the ^Y (Page Up) and ^V (Page Down) keys. ^X exits the help system. -@node Feature Toggles, Nanorc Files, Online Help, Top +@node Feature Toggles @chapter Feature Toggles Toggles allow you to change certain aspects of the editor that would -normally be done via command line options. They are invoked via Meta +normally be done via command-line options. They are invoked via Meta key sequences. See @xref{Special Functions}, for more info. The following global toggles are available: @@ -443,8 +537,8 @@ toggles the -N (@code{--noconvert}) command line option. toggles the -O (@code{--morespace}) command line option. @item Whitespace Display Toggle (Meta-P) -toggles whitespace display mode if you have a "whitespace" option in -your nanorc. See @xref{Nanorc Files}, for more info. +toggles whitespace-display mode. +See @xref{Whitespace}, for more info. @item Tabs to Spaces Toggle (Meta-Q) toggles the -E (@code{--tabstospaces}) command line option. @@ -457,7 +551,7 @@ toggles the -x (@code{--nohelp}) command line option. @item Color Syntax Highlighting Toggle (Meta-Y) toggles color syntax highlighting if you have color syntaxes in your -nanorc. See @xref{Nanorc Files}, for more info. +nanorc. See @xref{Syntax Highlighting}, for more info. @item Suspend Toggle (Meta-Z) toggles the -z (@code{--suspend}) command line option. @@ -468,116 +562,145 @@ toggles the -$ (@code{--softwrap}) command line option. @end table -@node Nanorc Files, The File Browser, Feature Toggles, Top +@node Nanorc Files @chapter Nanorc Files The nanorc files contain the default settings for @code{nano}. They -should not be in DOS or Mac format. During startup, @code{nano} will -first read its system-wide settings from SYSCONFDIR/nanorc, and then -user-specific settings from ~/.nanorc. +should be in Unix format, not in DOS or Mac format. During startup, +@code{nano} will first read the system-wide settings, from /etc/nanorc +(the exact path might be different), and then the user-specific settings, +from ~/.nanorc. A nanorc file accepts a series of "set" and "unset" commands, which can -be used to configure @code{nano} on startup without using the command -line options. Additionally, the "syntax", "color", and "icolor" -keywords are used to define syntax highlighting rules for different text -patterns. @code{nano} will read one command per line. +be used to configure @code{nano} on startup without using command-line +options. Additionally, there are some commands to define syntax highlighting +and to rebind keys -- @xref{Syntax Highlighting}, and @xref{Rebinding Keys}. +@code{nano} will read one command per line. Options in nanorc files take precedence over @code{nano}'s defaults, and -command line options override nanorc settings. Options are also unset -by default, except for those that take arguments. +command-line options override nanorc settings. Also, options that do not +take an argument are unset by default. So using the @code{unset} command +is only needed when wanting to override a setting of the system's nanorc +file in your own @file{~/.nanorc}. Options that take an argument cannot +be unset. Quotes inside string parameters don't have to be escaped with backslashes. The last double quote in the string will be treated as its -end. For example, for the "brackets" option, +end. For example, for the "brackets" option, @code{""')>]@}"} will match +@code{"}, @code{'}, @code{)}, @code{>}, @code{]}, and @code{@}}. -@quotation -@code{""')>]@}"} -@end quotation +@menu +* Settings:: +* Syntax Highlighting:: +* Rebinding Keys:: +@end menu -will match @code{"}, @code{'}, @code{)}, @code{>}, @code{]}, and -@code{@}}. +@node Settings +@section Settings -The supported commands and arguments are: +The supported settings in a nanorc file are: @table @code -@item set/unset autoindent +@item set allow_insecure_backup +When backing up files, allow the backup to succeed even if its +permissions can't be (re)set due to special OS considerations. +You should NOT enable this option unless you are sure you need it. + +@item set autoindent Use auto-indentation. -@item set/unset backup -Create backup files in "filename~". +@item set backup +When saving a file, back up the previous version of it to the current +filename suffixed with a tilde (@code{~}). @item set backupdir "directory" -Set the directory where @code{nano} puts unique backup files if file +Set the directory where @code{nano} puts unique backup files, if file backups are enabled. -@item set/unset backwards +@item set backwards Do backwards searches by default. -@item set/unset boldtext -Use bold text instead of reverse video text. +@item set boldtext +Use bold instead of reverse video for the titlebar, statusbar, key combos, +and selected text. This can be overridden for the first three by setting +the options "titlecolor", "statuscolor", and "keycolor". -@item set brackets "string" +@item set brackets "@var{string}" Set the characters treated as closing brackets when justifying -paragraphs. They cannot contain blank characters. Only closing -punctuation, optionally followed by closing brackets, can end sentences. -The default value is +paragraphs. This may not include blank characters. Only closing +punctuation (see "punct"), optionally followed by the specified +closing brackets, can end sentences. The default value is @quotation -@code{""')>]@}"} +""')>]@}" @end quotation -@item set/unset casesensitive -Do case sensitive searches by default. +@item set casesensitive +Do case-sensitive searches by default. -@item set/unset const +@item set const Constantly display the cursor position in the status bar. -@item set/unset cut -Use cut to end of line by default, instead of cutting the whole line. +@item set cut +Use cut-to-end-of-line by default, instead of cutting the whole line. -@item set fill "n" -Wrap lines at column number "n". If "n" is 0 or less, the maximum line -length will be the screen width less "n" columns. The default value is --8. +@item set fill @var{number} +Hard-wrap lines at column number @var{number}. If @var{number} is 0 or less, +the maximum line length will be the screen width less @var{number} columns. +The default value is -8. -@item set/unset historylog -Enable ~/.nano_history for saving and reading search/replace strings. +@item set functioncolor @var{fgcolor},@var{bgcolor} +Specify the color combination to use for the function descriptions +in the two help lines at the bottom of the screen. +See @code{set titlecolor} for more details. -@item set matchbrackets "string" +@item set historylog +Enable the use of @file{~/.nano/search_history} for saving and reading +search/replace strings. + +@item set keycolor @var{fgcolor},@var{bgcolor} +Specify the color combination to use for the shortcut key combos +in the two help lines at the bottom of the screen. +See @code{set titlecolor} for more details. + +@item set locking +Enable vim-style lock-files for when editing files. + +@item set matchbrackets "@var{string}" Set the opening and closing brackets that can be found by bracket -searches. They cannot contain blank characters. The former set must -come before the latter set, and both must be in the same order. The -default value is +searches. This may not include blank characters. The opening set must +come before the closing set, and the two sets must be in the same order. +The default value is @quotation -@code{"(<[@{)>]@}"} +"(<[@{)>]@}" @end quotation -@item set/unset morespace +@item set morespace Use the blank line below the titlebar as extra editing space. -@item set/unset mouse +@item set mouse Enable mouse support, so that mouse clicks can be used to place the cursor, set the mark (with a double click), or execute shortcuts. -@item set/unset multibuffer +@item set multibuffer Allow inserting files into their own buffers. -@item set/unset noconvert +@item set noconvert Don't convert files from DOS/Mac format. -@item set/unset nofollow +@item set nofollow Don't follow symlinks when writing files. -@item set/unset nohelp +@item set nohelp Don't display the help lists at the bottom of the screen. -@item set/unset nonewlines +@item set nonewlines Don't add newlines to the ends of files. -@item set/unset nowrap -Don't wrap text at all. +@item set nowrap +Don't hard-wrap text at all. @item set operatingdir "directory" @code{nano} will only read and write files inside "directory" and its @@ -585,112 +708,162 @@ subdirectories. Also, the current directory is changed to here, so files are inserted from this directory. By default, the operating directory feature is turned off. -@item set/unset preserve +@item set poslog +Save the cursor position of files between editing sessions. + +@item set preserve Preserve the XON and XOFF keys (^Q and ^S). -@item set punct "string" +@item set punct "@var{string}" Set the characters treated as closing punctuation when justifying -paragraphs. They cannot contain blank characters. Only closing -punctuation, optionally followed by closing brackets, can end sentences. -The default value is @code{"!.?"}. +paragraphs. This may not include blank characters. Only the +specified closing punctuation, optionally followed by closing brackets +(see "brackets"), can end sentences. The default value is "!.?". -@item set/unset quickblank +@item set quickblank Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25. -@item set quotestr "string" +@item set quiet +When set, @code{nano} will not report errors in the nanorc file nor ask them +to be acknowledged by pressing Enter at startup. If this option is used, it +should be placed at the top of the file to be fully effective. + +@item set quotestr "@var{string}" The email-quote string, used to justify email-quoted paragraphs. This is an extended regular expression if your system supports them, otherwise a literal string. The default value is @quotation -@code{"^([ \\t]*[#:>\\|@}])+"} +"^([ \\t]*[#:>\\|@}])+" @end quotation -if you have extended regular expression support, or "> " otherwise. +if you have extended regular expression support, and "> " otherwise. Note that '\\t' stands for a literal Tab character. -@item set/unset rebinddelete +@item set rebinddelete Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. -@item set/unset rebindkeypad +@item set rebindkeypad Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. -@item set/unset regexp +@item set regexp Do extended regular expression searches by default. -@item set/unset smarthome +@item set smarthome Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line. -@item set/unset smooth +@item set smooth Use smooth scrolling by default. -@item set/unset softwrap -Use soft wrapping by default. +@item set softwrap +Enable soft line wrapping for easier viewing of very long lines. @item set speller "spellprog" Use spelling checker "spellprog" instead of the built-in one, which calls "spell". -@item set/unset suspend -Allow @code{nano} to be suspended. +@item set statuscolor @var{fgcolor},@var{bgcolor} +Specify the color combination to use for the statusbar. +See @code{set titlecolor} for more details. -@item set/unset suspendenable -If @code{nano} is allowed to be suspended, allow the suspend key -(usually ^Z) to actually suspend it. +@item set suspend +Allow @code{nano} to be suspended. -@item set tabsize "n" -Use a tab size of "n" columns. The value of "n" must be greater than 0. -The default value is 8. +@item set tabsize @var{number} +Use a tab size of @var{number} columns. The value of @var{number} must be +greater than 0. The default value is 8. -@item set/unset tabstospaces +@item set tabstospaces Convert typed tabs to spaces. -@item set/unset tempfile +@item set tempfile Save automatically on exit, don't prompt. -@item set/unset undo -Enable experimental generic-purpose undo code. +@item set titlecolor @var{fgcolor},@var{bgcolor} +Specify the color combination to use for the titlebar. +Valid color names for foreground and background are: +white, black, red, blue, green, yellow, magenta, and cyan. +And either @var{fgcolor} or @var{,bgcolor} may be left out. -@item set/unset view +@item set view Disallow file modification. -@item set whitespace "string" -Set the two characters used to display the first characters of tabs and -spaces. They must be single-column characters. +@anchor{Whitespace} +@item set whitespace "@var{string}" +Set the two characters used to indicate the presence of tabs and +spaces. They must be single-column characters. The default pair +for a UTF-8 locale is "»·", and for other locales ">.". -@item set/unset wordbounds +@item set wordbounds Detect word boundaries more accurately by treating punctuation characters as part of a word. -@item syntax "str" ["fileregex" @dots{} ] +@end table + +@node Syntax Highlighting +@section Syntax Highlighting + +Coloring the different syntactic elements of a file +is done via regular expressions (see the @code{color} command below). +This is inherently imperfect, because regular expressions are not +powerful enough to fully parse a file. Nevertheless, regular +expressions can do a lot and are easy to make, so they are a +good fit for a small editor like @code{nano}. + +A separate syntax can be defined for each kind of file +via the following commands in a nanorc file: + +@table @code + +@item syntax "str" ["fileregex" @dots{}] Defines a syntax named "str" which can be activated via the -Y/--syntax -command line option, or will be automatically activated if the current +command-line option, or will be automatically activated if the current filename matches the extended regular expression "fileregex". All -following "color" and "icolor" statements will apply to "syntax" until a -new syntax is defined. +following "color" and "icolor" statements will apply to this "str" +syntax until a new syntax is defined. The "none" syntax is reserved; specifying it on the command line is the same as not having a syntax at all. The "default" syntax is special: it takes no "fileregex", and applies to files that don't match any other syntax's "fileregex". +@item linter program [arg @dots{}] +For the currently defined syntax, use the given program to invoke the +linter (this overrides the speller function when defined). + +@item formatter program [arg @dots{}] +For the currently defined syntax, use the given program to automatically +reformat text. Useful in certain programming languages (e.g. go). + +@item header "regex" @dots{} +For the currently defined syntax, add one or more regexes which will +be compared against the very first line of the file to be edited, +to determine whether this syntax should be used for that file. + +@item magic "regex" @dots{} +For the currently defined syntax, add one or more regexes which will be +compared against the result of querying the magic database about the file +to be edited, to determine whether this syntax should be used for that +file. This functionality only works when libmagic is installed on the +system and will be silently ignored otherwise. + @item color fgcolor,bgcolor "regex" @dots{} For the currently defined syntax, display all expressions matching the extended regular expression "regex" with foreground color "fgcolor" and background color "bgcolor", at least one of which must be specified. -Legal colors for foreground and background color are: white, black, red, +Valid colors for foreground and background are: white, black, red, blue, green, yellow, magenta, and cyan. You may use the prefix "bright" -to force a stronger color highlight for the foreground. If your -terminal supports transparency, not specifying a "bgcolor" tells "nano" +to get a stronger color highlight for the foreground. If your +terminal supports transparency, not specifying a "bgcolor" tells @code{nano} to attempt to use a transparent background. @item icolor fgcolor,bgcolor "regex" @dots{} @@ -709,12 +882,374 @@ Same as above, except that the expression matching is case insensitive. @item include "syntaxfile" Read in self-contained color syntaxes from "syntaxfile". Note that -"syntaxfile" can only contain "syntax", "color", and "icolor" commands. +"syntaxfile" can only contain the above commands, from "syntax" to +"icolor". + +@item extendsyntax str directive [arg @dots{}] +Extend the syntax previously defined as str to include new information. +Allows you to add a new color, icolor, magic, header, or linter directive +to an already defined syntax. Useful when you want to add to definitions +from the system-installed syntax definitions (which are normally not writable). + +@end table + +@node Rebinding Keys +@section Rebinding Keys + +Key bindings may be reassigned via the following two commands in a +nanorc file: + +@table @code + +@item bind key function menu +Rebinds @code{key} to @code{function} in the context of @code{menu} +(or in all menus where the function exists by using @code{all}). + +@item unbind key menu +Unbinds @code{key} from @code{menu} +(or from all menus where it exists by using @code{all}). + +@end table + +The format of @code{key} should be one of: + +@table @code + +@item ^ +followed by an alpha character or the word "Space". +Example: @code{^C} + +@item M- +followed by a printable character or the word "Space". +Example: @code{M-C} + +@item F +followed by a numeric value from 1 to 16. +Example: @code{F10} @end table +Valid names for the @code{function} to be bound are: + +@table @code + +@item help +Invokes the help viewer. + +@item cancel +Cancels the current command. + +@item exit +Exits from the program (or from the help viewer or the file browser). + +@item writeout +Writes the current buffer to disk. + +@item insert +Inserts a file into the current buffer (or into a new buffer when multibuffer +is enabled). + +@item whereis +Searches for text in the current buffer -- or for filenames matching +a string in the current list in the file browser + +@item searchagain +Repeats the last search command. + +@item replace +Interactively replaces text within the current buffer. + +@item cut +Cuts and stores the current line (or the marked region). + +@item copytext +Copies the current line (or the marked region) without deleting it. + +@item uncut +Copies the currently stored text into the current buffer at the +current cursor position. + +@item mark +Sets the mark at the current position, to start selecting text. + +@item cutrestoffile +Cuts all text from the cursor position till the end of the buffer. + +@item curpos +Shows the current cursor position: the line, column, and character positions. + +@item wordcount +Counts the number of words, lines and characters in the current buffer. + +@item speller +Invokes a spell-checking program (or a linting program, if the current +syntax highlighting defines one). + +@item justify +Justifies the current paragraph. + +@item fulljustify +Justifies the entire current buffer. + +@item indent +Indents (shifts to the right) the currently marked text. + +@item unindent +Unindents (shifts to the left) the currently marked text. + +@item left +Goes left one position (in the editor or browser). + +@item right +Goes right one position (in the editor or browser). + +@item up +Goes one line up (in the editor or browser). + +@item down +Goes one line down (in the editor or browser). + +@item scrollup +Scrolls up one line of text from the current position. + +@item scrolldown +Scrolls down one line of text from the current position. -@node The File Browser, Pico Compatibility, Nanorc Files, Top +@item nextword +Moves the cursor to the beginning of the next word. + +@item prevword +Moves the cursor to the beginning of the previous word. + +@item home +Moves the cursor to the beginning of the current line. + +@item end +Moves the cursor to the end of the current line. + +@item beginpara +Moves the cursor to the beginning of the current paragraph. + +@item endpara +Moves the cursor to the end of the current paragraph. + +@item prevpage +Goes up one screenful. + +@item nextpage +Goes down one screenful. + +@item firstline +Goes to the first line of the file. + +@item lastline +Goes to the last line of the file. + +@item gotoline +Goes to a specific line (and column if specified). + +@item gototext +Switches from targeting a line number to searching for text. + +@item findbracket +Moves the cursor to the bracket (brace, parenthesis, etc.) that matches +(pairs) with the one under the cursor. + +@item prevbuf +Switches to editing/viewing the previous buffer when using multibuffer mode. + +@item nextbuf +Switches to editing/viewing the next buffer when using multibuffer mode. + +@item verbatim +Inserts the next character verbatim into the file. + +@item tab +Inserts a tab at the current cursor location. + +@item enter +Inserts a new line below the current one. + +@item delete +Deletes the character under the cursor. + +@item backspace +Deletes the character before the cursor. + +@item undo +Undoes the last performed text action (add text, delete text, etc). + +@item redo +Redoes the last undone action (i.e., it undoes an undo). + +@item refresh +Refreshes the screen. + +@item suspend +Suspends the editor (if the suspending function is enabled, see the +"suspendenable" entry below). + +@item casesens +Toggles case sensitivity in searching (search/replace menus only). + +@item regexp +Toggles whether searching/replacing is based on literal strings or regular expressions. + +@item backwards +Toggles whether searching/replacing goes forward or backward. + +@item prevhistory +Shows the previous history entry in the prompt menus (e.g. search). + +@item nexthistory +Shows the next history entry in the prompt menus (e.g. search). + +@item flipreplace +Toggles between searching for something and replacing something. + +@item flipexecute +Toggles between inserting a file and executing a command. + +@item flipnewbuffer +Toggles between inserting into the current buffer and into a new +empty buffer. + +@item dosformat +When writing a file, switches to writing a DOS format (CR/LF). + +@item macformat +When writing a file, switches to writing a Mac format. + +@item append +When writing a file, appends to the end instead of overwriting. + +@item prepend +When writing a file, 'prepends' (writes at the beginning) instead of overwriting. + +@item backup +When writing a file, creates a backup of the current file. + +@item tofiles +Starts the file browser, allowing to select a file from a list. + +@item gotodir +Goes to a directory to be specified, allowing to browse anywhere +in the filesystem. + +@item firstfile +Goes to the first file when using the file browser (reading or writing files). + +@item lastfile +Goes to the last file when using the file browser (reading or writing files). + +@item nohelp +Toggles the presence of the two-line list of key bindings at the bottom of the screen. + +@item constupdate +Toggles the constant display of the current line, column, and character positions. + +@item morespace +Toggles the presence of the blank line which 'separates' the titlebar from the file text. + +@item smoothscroll +Toggles smooth scrolling (when moving around with the arrow keys). + +@item softwrap +Toggles the displaying of overlong lines on multiple screen lines. + +@item whitespacedisplay +Toggles the showing of whitespace. + +@item nosyntax +Toggles syntax highlighting. + +@item smarthome +Toggles the smartness of the Home key. + +@item autoindent +Toggles whether new lines will contain the same amount of whitespace as the preceding line. + +@item cuttoend +Toggles whether cutting text will cut the whole line or just from the current cursor +position to the end of the line. + +@item nowrap +Toggles whether long lines will be hard-wrapped to the next line. + +@item tabstospaces +Toggles whether typed tabs will be converted to spaces. + +@item backupfile +Toggles whether a backup will be made of the file to be edited. + +@item multibuffer +Toggles the use of multiple file buffers (if available). + +@item mouse +Toggles mouse support. + +@item noconvert +Toggles automatic conversion of files from DOS/Mac format. + +@item suspendenable +Toggles whether the suspend sequence (normally ^Z) will suspend the editor window. + +@end table + +Valid names for @code{menu} are: + +@table @code + +@item main +The main editor window where text is entered and edited. + +@item search +The search menu (AKA whereis). + +@item replace +The 'search to replace' menu. + +@item replacewith +The 'replace with' menu, which comes up after 'search to replace'. + +@item gotoline +The 'goto line (and column)' menu. + +@item writeout +The 'write file' menu. + +@item insert +The 'insert file' menu. + +@item extcmd +The menu for inserting output from an external command, reached from the insert menu. + +@item help +The help-viewer menu. + +@item spell +The interactive spell checker Yes/no menu. + +@item linter +The linter menu. + +@item browser +The file browser for inserting or writing a file. + +@item whereisfile +The 'search for a file' menu in the file browser. + +@item gotodir +The 'go to directory' menu in the file browser. + +@item all +A special name that encompasses all menus. For @code{bind} it means +all menus where the specified @code{function} exists; for @code{unbind} +it means all menus where the specified @code{key} exists. +@end table + + +@node The File Browser @chapter The File Browser When reading or writing files, pressing ^T will invoke the file browser. @@ -730,7 +1265,8 @@ enter and display the contents of the directory. If the object is a file, this filename and path are copied to the statusbar, and the file browser exits. -@node Pico Compatibility, Building and Configure Options, The File Browser, Top + +@node Pico Compatibility @chapter Pico Compatibility @code{nano} attempts to emulate Pico as closely as possible, but there @@ -766,14 +1302,14 @@ functions can be toggled for a particular version of @code{nano}. See @item Cursor Position Display The output of the "Display Cursor Position" in @code{nano} displays -the given column position, as well as the row and total character -position of the cursor. +the current line position of the cursor, as well as the column and +total character position. @item Interactive Replace and Spell Checker It is worth noting that @code{nano}'s replace function is interactive, -i.e. it does not stop after one search string is found and automatically -replace it. The @code{nano} implementation will pause at each search -string found and query whether to replace this instance or not. The +i.e. it does not stop after one search string was found and automatically +replaced. The @code{nano} implementation will pause at each found +search string and query whether to replace this instance or not. The internal spell checker operates similarly. Note that there is no way to force these functions to behave in the Pico fashion. As of version 1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in @@ -781,7 +1317,8 @@ the internal spell checker such that the words 'apple' and 'Apple' will be prompted for correction separately. @end table -@node Building and Configure Options, , Pico Compatibility, Top + +@node Building and Configure Options @chapter Building and Configure Options Building @code{nano} from source is fairly straightforward if you are @@ -803,81 +1340,98 @@ The possible options to @code{./configure} are: @item --disable-browser Disable the mini file browser when reading or writing files. +@item --disable-color +Disable support for the syntax coloring of files. This also eliminates +the -Y command-line option, which chooses a specific syntax. + +@item --disable-extra +Disable extra features. At the moment, this is just easter-egg-type +stuff. + @item --disable-help Disable the help function. Doing this makes the binary much smaller, but makes it difficult for new users to learn more than very basic things about using the editor. +@item --disable-histories +Disable the code for the handling of the history files: the search and +replace strings that were used, and the cursor position at which each +file was closed. This also eliminates the -H and -P command-line +options, which switch on the logging of search/replace strings and +cursor positions. + @item --disable-justify Disable the justify and unjustify functions. +@item --disable-libmagic +Disable the use of the library of magic-number tests (for determining +the file type and thus which syntax to use for colouring -- often the +tests on filename extension and header line will be enough). + @item --disable-mouse -Disable all mouse functionality. This also disables the -m command line -option, which enables the mouse functionality. +Disable all mouse functionality. This also eliminates the -m +command-line option, which enables the mouse functionality. + +@item --disable-multibuffer +Disable support for opening multiple files at a time and switching +between them on the fly. This also eliminates the -F command-line +option, which switches the use of multiple file buffers on. + +@item --disable-nanorc +Disable support for reading the nanorc files at startup. With such +support, you can store custom settings in a system-wide and a per-user +nanorc file rather than having to pass command-line options to get +the desired behavior. See @xref{Nanorc Files}, for more info. +Disabling this also eliminates the -I and -q command-line options; +the first inhibits the reading of nanorcfiles, and the second +suppresses warnings about errors in those files. @item --disable-operatingdir -Disable setting the operating directory. This also disables the -o -command line option, which sets the operating directory. +Disable setting the operating directory. This also eliminates the -o +command-line option, which sets the operating directory. @item --disable-speller -Disable use of the spell checker. This also disables the -s command -line option, which allows specifying an alternate spell checker. +Disable use of the spell checker. This also eliminates the -s +command-line option, which allows specifying an alternate spell checker. @item --disable-tabcomp Disable the tab completion code when reading or writing files. @item --disable-wrapping -Disable all long line wrapping. This also eliminates the -w command -line option, which enables long line wrapping. +Disable hard-wrapping of overlong lines. This also eliminates the -w +command-line option, which enables long-line wrapping. @item --enable-tiny This option disables all the above. It also disables some of the larger -internals of the editor, like the marking code and the cut to end of -line code. It also disables the function toggles. +internals of the editor, like the marking code and the cut-to-end-of-line +code. It also disables the function toggles. By using the enabling +counterpart of the above options together with --enable-tiny, specific +features can be switched back on. @item --enable-debug Enable support for runtime debug output. This can get pretty messy, so -chances are you only want this feature to work on the nano source. - -@item --enable-extra -Enable extra features. At the moment, this is just easter egg-type -stuff. - -@item --enable-color -Enable support for syntax coloring of files using the nanorc file. This -enables nanorc support as well. - -@item --enable-multibuffer -Enable support for opening multiple files at a time and switching -between them on the fly. - -@item --enable-nanorc -Enable support for reading the nanorc file at startup. You can store -custom settings in the nanorc file rather than having to pass command -line options to get desired behavior. See @xref{Nanorc Files}, for -more info. - -@item --enable-all -Shortcut for enabling the above four features (extra, color, -multibuffer, and nanorc). +chances are you only want this feature when you're working on the nano source. @item --disable-nls -Disables Native Language support. This will disable use of the +Disables Native Language support. This will disable the use of any available GNU @code{nano} translations. @item --disable-wrapping-as-root -Disable long line wrapping by default when nano is run as root. +Disable hard-wrapping of overlong lines by default when @code{nano} +is run as root. @item --enable-utf8 Enable support for reading and writing Unicode files. This will require either a wide version of curses, or a UTF-8-enabled version of Slang. @item --disable-utf8 -Disable support for reading and writing Unicode files. +Disable support for reading and writing Unicode files. Normally the +configure script auto-detects whether to enable UTF-8 support or not. +You can use this or the previous option to override that detection. @item --with-slang -Compiling @code{nano} with Slang is supported, and will make the binary -notably smaller than if compiled with ncurses or other curses libraries. +Compile @code{nano} against Slang instead of against ncurses or other +curses libraries. @end table diff --git a/doc/texinfo/texinfo.tex b/doc/texinfo/texinfo.tex index 9140826..85f184c 100644 --- a/doc/texinfo/texinfo.tex +++ b/doc/texinfo/texinfo.tex @@ -3,11 +3,11 @@ % Load plain if necessary, i.e., if running under initex. \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi % -\def\texinfoversion{2009-08-14.15} +\def\texinfoversion{2013-02-01.11} % % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, -% 2007, 2008, 2009 Free Software Foundation, Inc. +% 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc. % % This texinfo.tex file is free software: you can redistribute it and/or % modify it under the terms of the GNU General Public License as @@ -24,13 +24,14 @@ % % As a special exception, when this file is read by TeX when processing % a Texinfo source document, you may use the result without -% restriction. (This has been our intent since Texinfo was invented.) +% restriction. This Exception is an additional permission under section 7 +% of the GNU General Public License, version 3 ("GPLv3"). % % Please try the latest version of texinfo.tex before submitting bug % reports; you can get the latest version from: -% http://www.gnu.org/software/texinfo/ (the Texinfo home page), or -% ftp://tug.org/tex/texinfo.tex -% (and all CTAN mirrors, see http://www.ctan.org). +% http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or +% http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or +% http://www.gnu.org/software/texinfo/ (the Texinfo home page) % The texinfo.tex in any given distribution could well be out % of date, so if that's what you're using, please check. % @@ -65,7 +66,6 @@ \everyjob{\message{[Texinfo version \texinfoversion]}% \catcode`+=\active \catcode`\_=\active} - \chardef\other=12 % We never want plain's \outer definition of \+ in Texinfo. @@ -93,14 +93,13 @@ \let\ptexnewwrite\newwrite \let\ptexnoindent=\noindent \let\ptexplus=+ +\let\ptexraggedright=\raggedright \let\ptexrbrace=\} \let\ptexslash=\/ \let\ptexstar=\* \let\ptext=\t \let\ptextop=\top -{\catcode`\'=\active -\global\let\ptexquoteright'}% Math-mode def from plain.tex. -\let\ptexraggedright=\raggedright +{\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode % If this character appears in an error message or help string, it % starts a new line in the output. @@ -118,10 +117,11 @@ % Set up fixed words for English if not already set. \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi +\ifx\putworderror\undefined \gdef\putworderror{error}\fi \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi \ifx\putwordin\undefined \gdef\putwordin{in}\fi -\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi -\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi +\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi +\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi @@ -160,15 +160,18 @@ \def\spaceisspace{\catcode`\ =\spacecat} % sometimes characters are active, so we need control sequences. +\chardef\ampChar = `\& \chardef\colonChar = `\: \chardef\commaChar = `\, \chardef\dashChar = `\- \chardef\dotChar = `\. \chardef\exclamChar= `\! +\chardef\hashChar = `\# \chardef\lquoteChar= `\` \chardef\questChar = `\? \chardef\rquoteChar= `\' \chardef\semiChar = `\; +\chardef\slashChar = `\/ \chardef\underChar = `\_ % Ignore a token. @@ -199,36 +202,7 @@ % that mark overfull boxes (in case you have decided % that the text looks ok even though it passes the margin). % -\def\finalout{\overfullrule=0pt} - -% @| inserts a changebar to the left of the current line. It should -% surround any changed text. This approach does *not* work if the -% change spans more than two lines of output. To handle that, we would -% have adopt a much more difficult approach (putting marks into the main -% vertical list for the beginning and end of each change). -% -\def\|{% - % \vadjust can only be used in horizontal mode. - \leavevmode - % - % Append this vertical mode material after the current line in the output. - \vadjust{% - % We want to insert a rule with the height and depth of the current - % leading; that is exactly what \strutbox is supposed to record. - \vskip-\baselineskip - % - % \vadjust-items are inserted at the left edge of the type. So - % the \llap here moves out into the left-hand margin. - \llap{% - % - % For a thicker or thinner bar, change the `1pt'. - \vrule height\baselineskip width1pt - % - % This is the space between the bar and the text. - \hskip 12pt - }% - }% -} +\def\finalout{\overfullrule=0pt } % Sometimes it is convenient to have everything in the transcript file % and nothing on the terminal. We don't just call \tracingall here, @@ -246,7 +220,7 @@ \tracingmacros2 \tracingrestores1 \showboxbreadth\maxdimen \showboxdepth\maxdimen - \ifx\eTeXversion\undefined\else % etex gives us more logging + \ifx\eTeXversion\thisisundefined\else % etex gives us more logging \tracingscantokens1 \tracingifs1 \tracinggroups1 @@ -257,6 +231,13 @@ \errorcontextlines16 }% +% @errormsg{MSG}. Do the index-like expansions on MSG, but if things +% aren't perfect, it's not the end of the world, being an error message, +% after all. +% +\def\errormsg{\begingroup \indexnofonts \doerrormsg} +\def\doerrormsg#1{\errmessage{#1}} + % add check for \lastpenalty to plain's definitions. If the last thing % we did was a \nobreak, we don't want to insert more space. % @@ -267,7 +248,6 @@ \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount \removelastskip\penalty-200\bigskip\fi\fi} -% For @cropmarks command. % Do @cropmarks to get crop marks. % \newif\ifcropmarks @@ -577,7 +557,7 @@ } \def\inenvironment#1{% \ifx#1\empty - out of any environment% + outside of any environment% \else in environment \expandafter\string#1% \fi @@ -589,7 +569,7 @@ \parseargdef\end{% \if 1\csname iscond.#1\endcsname \else - % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 + % The general wording of \badenverr may not be ideal. \expandafter\checkenv\csname#1\endcsname \csname E#1\endcsname \endgroup @@ -599,85 +579,6 @@ \newhelp\EMsimple{Press RETURN to continue.} -%% Simple single-character @ commands - -% @@ prints an @ -% Kludge this until the fonts are right (grr). -\def\@{{\tt\char64}} - -% This is turned off because it was never documented -% and you can use @w{...} around a quote to suppress ligatures. -%% Define @` and @' to be the same as ` and ' -%% but suppressing ligatures. -%\def\`{{`}} -%\def\'{{'}} - -% Used to generate quoted braces. -\def\mylbrace {{\tt\char123}} -\def\myrbrace {{\tt\char125}} -\let\{=\mylbrace -\let\}=\myrbrace -\begingroup - % Definitions to produce \{ and \} commands for indices, - % and @{ and @} for the aux/toc files. - \catcode`\{ = \other \catcode`\} = \other - \catcode`\[ = 1 \catcode`\] = 2 - \catcode`\! = 0 \catcode`\\ = \other - !gdef!lbracecmd[\{]% - !gdef!rbracecmd[\}]% - !gdef!lbraceatcmd[@{]% - !gdef!rbraceatcmd[@}]% -!endgroup - -% @comma{} to avoid , parsing problems. -\let\comma = , - -% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent -% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. -\let\, = \c -\let\dotaccent = \. -\def\ringaccent#1{{\accent23 #1}} -\let\tieaccent = \t -\let\ubaraccent = \b -\let\udotaccent = \d - -% Other special characters: @questiondown @exclamdown @ordf @ordm -% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. -\def\questiondown{?`} -\def\exclamdown{!`} -\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} -\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} - -% Dotless i and dotless j, used for accents. -\def\imacro{i} -\def\jmacro{j} -\def\dotless#1{% - \def\temp{#1}% - \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi - \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi - \else \errmessage{@dotless can be used only with i or j}% - \fi\fi -} - -% The \TeX{} logo, as in plain, but resetting the spacing so that a -% period following counts as ending a sentence. (Idea found in latex.) -% -\edef\TeX{\TeX \spacefactor=1000 } - -% @LaTeX{} logo. Not quite the same results as the definition in -% latex.ltx, since we use a different font for the raised A; it's most -% convenient for us to use an explicitly smaller font, rather than using -% the \scriptstyle font (since we don't reset \scriptstyle and -% \scriptscriptstyle). -% -\def\LaTeX{% - L\kern-.36em - {\setbox0=\hbox{T}% - \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}% - \kern-.15em - \TeX -} - % Be sure we're in horizontal mode when doing a tie, since we make space % equivalent to this in @example-like environments. Otherwise, a space % at the beginning of a line will start with \penalty -- and @@ -694,7 +595,7 @@ \def\:{\spacefactor=1000 } % @* forces a line break. -\def\*{\hfil\break\hbox{}\ignorespaces} +\def\*{\unskip\hfil\break\hbox{}\ignorespaces} % @/ allows a line break. \let\/=\allowbreak @@ -719,7 +620,7 @@ \else\ifx\temp\offword \plainnonfrenchspacing \else \errhelp = \EMsimple - \errmessage{Unknown @frenchspacing option `\temp', must be on/off}% + \errmessage{Unknown @frenchspacing option `\temp', must be on|off}% \fi\fi } @@ -801,15 +702,6 @@ where each line of input produces a line of output.} \newdimen\mil \mil=0.001in -% Old definition--didn't work. -%\parseargdef\need{\par % -%% This method tries to make TeX break the page naturally -%% if the depth of the box does not fit. -%{\baselineskip=0pt% -%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak -%\prevdepth=-1000pt -%}} - \parseargdef\need{% % Ensure vertical mode, so we don't make a big box in the middle of a % paragraph. @@ -873,7 +765,7 @@ where each line of input produces a line of output.} % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current % paragraph. For more general purposes, use the \margin insertion -% class. WHICH is `l' or `r'. +% class. WHICH is `l' or `r'. Not documented, written for gawk manual. % \newskip\inmarginspacing \inmarginspacing=1cm \def\strutdepth{\dp\strutbox} @@ -920,6 +812,36 @@ where each line of input produces a line of output.} \temp } +% @| inserts a changebar to the left of the current line. It should +% surround any changed text. This approach does *not* work if the +% change spans more than two lines of output. To handle that, we would +% have adopt a much more difficult approach (putting marks into the main +% vertical list for the beginning and end of each change). This command +% is not documented, not supported, and doesn't work. +% +\def\|{% + % \vadjust can only be used in horizontal mode. + \leavevmode + % + % Append this vertical mode material after the current line in the output. + \vadjust{% + % We want to insert a rule with the height and depth of the current + % leading; that is exactly what \strutbox is supposed to record. + \vskip-\baselineskip + % + % \vadjust-items are inserted at the left edge of the type. So + % the \llap here moves out into the left-hand margin. + \llap{% + % + % For a thicker or thinner bar, change the `1pt'. + \vrule height\baselineskip width1pt + % + % This is the space between the bar and the text. + \hskip 12pt + }% + }% +} + % @include FILE -- \input text of FILE. % \def\include{\parseargusing\filenamecatcodes\includezzz} @@ -930,6 +852,7 @@ where each line of input produces a line of output.} \makevalueexpandable % we want to expand any @value in FILE. \turnoffactive % and allow special characters in the expansion \indexnofonts % Allow `@@' and other weird things in file names. + \wlog{texinfo.tex: doing @include of #1^^J}% \edef\temp{\noexpand\input #1 }% % % This trickery is to read FILE outside of a group, in case it makes @@ -965,7 +888,7 @@ where each line of input produces a line of output.} \def\popthisfilestack{\errthisfilestackempty} \def\errthisfilestackempty{\errmessage{Internal error: the stack of filenames is empty.}} - +% \def\thisfile{} % @center line @@ -973,36 +896,46 @@ where each line of input produces a line of output.} % \parseargdef\center{% \ifhmode - \let\next\centerH + \let\centersub\centerH \else - \let\next\centerV + \let\centersub\centerV \fi - \next{\hfil \ignorespaces#1\unskip \hfil}% + \centersub{\hfil \ignorespaces#1\unskip \hfil}% + \let\centersub\relax % don't let the definition persist, just in case } -\def\centerH#1{% - {% - \hfil\break - \advance\hsize by -\leftskip - \advance\hsize by -\rightskip - \line{#1}% - \break - }% +\def\centerH#1{{% + \hfil\break + \advance\hsize by -\leftskip + \advance\hsize by -\rightskip + \line{#1}% + \break +}} +% +\newcount\centerpenalty +\def\centerV#1{% + % The idea here is the same as in \startdefun, \cartouche, etc.: if + % @center is the first thing after a section heading, we need to wipe + % out the negative parskip inserted by \sectionheading, but still + % prevent a page break here. + \centerpenalty = \lastpenalty + \ifnum\centerpenalty>10000 \vskip\parskip \fi + \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi + \line{\kern\leftskip #1\kern\rightskip}% } -\def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}} % @sp n outputs n lines of vertical space - +% \parseargdef\sp{\vskip #1\baselineskip} % @comment ...line which is ignored... % @c is the same as @comment % @ignore ... @end ignore is another way to write a comment - +% \def\comment{\begingroup \catcode`\^^M=\other% \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% \commentxxx} {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} - +% \let\c=\comment % @paragraphindent NCHARS @@ -1095,109 +1028,6 @@ where each line of input produces a line of output.} } -% @asis just yields its argument. Used with @table, for example. -% -\def\asis#1{#1} - -% @math outputs its argument in math mode. -% -% One complication: _ usually means subscripts, but it could also mean -% an actual _ character, as in @math{@var{some_variable} + 1}. So make -% _ active, and distinguish by seeing if the current family is \slfam, -% which is what @var uses. -{ - \catcode`\_ = \active - \gdef\mathunderscore{% - \catcode`\_=\active - \def_{\ifnum\fam=\slfam \_\else\sb\fi}% - } -} -% Another complication: we want \\ (and @\) to output a \ character. -% FYI, plain.tex uses \\ as a temporary control sequence (why?), but -% this is not advertised and we don't care. Texinfo does not -% otherwise define @\. -% -% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. -\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} -% -\def\math{% - \tex - \mathunderscore - \let\\ = \mathbackslash - \mathactive - % make the texinfo accent commands work in math mode - \let\"=\ddot - \let\'=\acute - \let\==\bar - \let\^=\hat - \let\`=\grave - \let\u=\breve - \let\v=\check - \let\~=\tilde - \let\dotaccent=\dot - $\finishmath -} -\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. - -% Some active characters (such as <) are spaced differently in math. -% We have to reset their definitions in case the @math was an argument -% to a command which sets the catcodes (such as @item or @section). -% -{ - \catcode`^ = \active - \catcode`< = \active - \catcode`> = \active - \catcode`+ = \active - \catcode`' = \active - \gdef\mathactive{% - \let^ = \ptexhat - \let< = \ptexless - \let> = \ptexgtr - \let+ = \ptexplus - \let' = \ptexquoteright - } -} - -% Some math mode symbols. -\def\bullet{$\ptexbullet$} -\def\geq{\ifmmode \ge\else $\ge$\fi} -\def\leq{\ifmmode \le\else $\le$\fi} -\def\minus{\ifmmode -\else $-$\fi} - -% @dots{} outputs an ellipsis using the current font. -% We do .5em per period so that it has the same spacing in the cm -% typewriter fonts as three actual period characters; on the other hand, -% in other typewriter fonts three periods are wider than 1.5em. So do -% whichever is larger. -% -\def\dots{% - \leavevmode - \setbox0=\hbox{...}% get width of three periods - \ifdim\wd0 > 1.5em - \dimen0 = \wd0 - \else - \dimen0 = 1.5em - \fi - \hbox to \dimen0{% - \hskip 0pt plus.25fil - .\hskip 0pt plus1fil - .\hskip 0pt plus1fil - .\hskip 0pt plus.5fil - }% -} - -% @enddots{} is an end-of-sentence ellipsis. -% -\def\enddots{% - \dots - \spacefactor=\endofsentencespacefactor -} - -% @comma{} is so commas can be inserted into text without messing up -% Texinfo's parsing. -% -\let\comma = , - % @refill is a no-op. \let\refill=\relax @@ -1262,9 +1092,8 @@ where each line of input produces a line of output.} \newif\ifpdfmakepagedest % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 -% can be set). So we test for \relax and 0 as well as \undefined, -% borrowed from ifpdf.sty. -\ifx\pdfoutput\undefined +% can be set). So we test for \relax and 0 as well as being undefined. +\ifx\pdfoutput\thisisundefined \else \ifx\pdfoutput\relax \else @@ -1279,50 +1108,24 @@ where each line of input produces a line of output.} % for display in the outlines, and in other places. Thus, we have to % double any backslashes. Otherwise, a name like "\node" will be % interpreted as a newline (\n), followed by o, d, e. Not good. -% http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html -% (and related messages, the final outcome is that it is up to the TeX -% user to double the backslashes and otherwise make the string valid, so -% that's what we do). - -% double active backslashes. -% -{\catcode`\@=0 \catcode`\\=\active - @gdef@activebackslashdouble{% - @catcode`@\=@active - @let\=@doublebackslash} -} - -% To handle parens, we must adopt a different approach, since parens are -% not active characters. hyperref.dtx (which has the same problem as -% us) handles it with this amazing macro to replace tokens, with minor -% changes for Texinfo. It is included here under the GPL by permission -% from the author, Heiko Oberdiek. -% -% #1 is the tokens to replace. -% #2 is the replacement. -% #3 is the control sequence with the string. -% -\def\HyPsdSubst#1#2#3{% - \def\HyPsdReplace##1#1##2\END{% - ##1% - \ifx\\##2\\% - \else - #2% - \HyReturnAfterFi{% - \HyPsdReplace##2\END - }% - \fi - }% - \xdef#3{\expandafter\HyPsdReplace#3#1\END}% -} -\long\def\HyReturnAfterFi#1\fi{\fi#1} - -% #1 is a control sequence in which to do the replacements. -\def\backslashparens#1{% - \xdef#1{#1}% redefine it as its expansion; the definition is simply - % \lastnode when called from \setref -> \pdfmkdest. - \HyPsdSubst{(}{\realbackslash(}{#1}% - \HyPsdSubst{)}{\realbackslash)}{#1}% +% +% See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and +% related messages. The final outcome is that it is up to the TeX user +% to double the backslashes and otherwise make the string valid, so +% that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to +% do this reliably, so we use it. + +% #1 is a control sequence in which to do the replacements, +% which we \xdef. +\def\txiescapepdf#1{% + \ifx\pdfescapestring\thisisundefined + % No primitive available; should we give a warning or log? + % Many times it won't matter. + \else + % The expandable \pdfescapestring primitive escapes parentheses, + % backslashes, and other special chars. + \xdef#1{\pdfescapestring{#1}}% + \fi } \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images @@ -1381,32 +1184,34 @@ output) for that.)} % % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto). \def\dopdfimage#1#2#3{% - \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% - \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% + \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% + \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% % - % pdftex (and the PDF format) support .png, .jpg, .pdf (among - % others). Let's try in that order. + % pdftex (and the PDF format) support .pdf, .png, .jpg (among + % others). Let's try in that order, PDF first since if + % someone has a scalable image, presumably better to use that than a + % bitmap. \let\pdfimgext=\empty \begingroup - \openin 1 #1.png \ifeof 1 - \openin 1 #1.jpg \ifeof 1 - \openin 1 #1.jpeg \ifeof 1 - \openin 1 #1.JPG \ifeof 1 - \openin 1 #1.pdf \ifeof 1 - \openin 1 #1.PDF \ifeof 1 + \openin 1 #1.pdf \ifeof 1 + \openin 1 #1.PDF \ifeof 1 + \openin 1 #1.png \ifeof 1 + \openin 1 #1.jpg \ifeof 1 + \openin 1 #1.jpeg \ifeof 1 + \openin 1 #1.JPG \ifeof 1 \errhelp = \nopdfimagehelp \errmessage{Could not find image file #1 for pdf}% - \else \gdef\pdfimgext{PDF}% + \else \gdef\pdfimgext{JPG}% \fi - \else \gdef\pdfimgext{pdf}% + \else \gdef\pdfimgext{jpeg}% \fi - \else \gdef\pdfimgext{JPG}% + \else \gdef\pdfimgext{jpg}% \fi - \else \gdef\pdfimgext{jpeg}% + \else \gdef\pdfimgext{png}% \fi - \else \gdef\pdfimgext{jpg}% + \else \gdef\pdfimgext{PDF}% \fi - \else \gdef\pdfimgext{png}% + \else \gdef\pdfimgext{pdf}% \fi \closein 1 \endgroup @@ -1418,8 +1223,8 @@ output) for that.)} \else \immediate\pdfximage \fi - \ifdim \wd0 >0pt width \imagewidth \fi - \ifdim \wd2 >0pt height \imageheight \fi + \ifdim \wd0 >0pt width \pdfimagewidth \fi + \ifdim \wd2 >0pt height \pdfimageheight \fi \ifnum\pdftexversion<13 #1.\pdfimgext \else @@ -1434,10 +1239,9 @@ output) for that.)} % such as \, aren't expanded when present in a section title. \indexnofonts \turnoffactive - \activebackslashdouble \makevalueexpandable \def\pdfdestname{#1}% - \backslashparens\pdfdestname + \txiescapepdf\pdfdestname \safewhatsit{\pdfdest name{\pdfdestname} xyz}% }} % @@ -1469,29 +1273,24 @@ output) for that.)} % page number. We could generate a destination for the section % text in the case where a section has no node, but it doesn't % seem worth the trouble, since most documents are normally structured. - \def\pdfoutlinedest{#3}% + \edef\pdfoutlinedest{#3}% \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}% \else - % Doubled backslashes in the name. - {\activebackslashdouble \xdef\pdfoutlinedest{#3}% - \backslashparens\pdfoutlinedest}% + \txiescapepdf\pdfoutlinedest \fi % - % Also double the backslashes in the display string. - {\activebackslashdouble \xdef\pdfoutlinetext{#1}% - \backslashparens\pdfoutlinetext}% + % Also escape PDF chars in the display string. + \edef\pdfoutlinetext{#1}% + \txiescapepdf\pdfoutlinetext % \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}% } % \def\pdfmakeoutlines{% \begingroup - % Thanh's hack / proper braces in bookmarks - \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace - \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace - % % Read toc silently, to get counts of subentries for \pdfoutline. + \def\partentry##1##2##3##4{}% ignore parts in the outlines \def\numchapentry##1##2##3##4{% \def\thischapnum{##2}% \def\thissecnum{0}% @@ -1545,25 +1344,41 @@ output) for that.)} % Latin 2 (0xea) gets translated to a | character. Info from % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. % - % xx to do this right, we have to translate 8-bit characters to - % their "best" equivalent, based on the @documentencoding. Right - % now, I guess we'll just let the pdf reader have its way. + % TODO this right, we have to translate 8-bit characters to + % their "best" equivalent, based on the @documentencoding. Too + % much work for too little return. Just use the ASCII equivalents + % we use for the index sort strings. + % \indexnofonts \setupdatafile + % We can have normal brace characters in the PDF outlines, unlike + % Texinfo index files. So set that up. + \def\{{\lbracecharliteral}% + \def\}{\rbracecharliteral}% \catcode`\\=\active \otherbackslash \input \tocreadfilename \endgroup } + {\catcode`[=1 \catcode`]=2 + \catcode`{=\other \catcode`}=\other + \gdef\lbracecharliteral[{]% + \gdef\rbracecharliteral[}]% + ] % \def\skipspaces#1{\def\PP{#1}\def\D{|}% \ifx\PP\D\let\nextsp\relax \else\let\nextsp\skipspaces - \ifx\p\space\else\addtokens{\filename}{\PP}% - \advance\filenamelength by 1 - \fi + \addtokens{\filename}{\PP}% + \advance\filenamelength by 1 \fi \nextsp} - \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} + \def\getfilename#1{% + \filenamelength=0 + % If we don't expand the argument now, \skipspaces will get + % snagged on things like "@value{foo}". + \edef\temp{#1}% + \expandafter\skipspaces\temp|\relax + } \ifnum\pdftexversion < 14 \let \startlink \pdfannotlink \else @@ -1660,9 +1475,6 @@ output) for that.)} \def\ttsl{\setfontstyle{ttsl}} -% Default leading. -\newdimen\textleading \textleading = 13.2pt - % Set the baselineskip to #1, and the lineskip and strut size % correspondingly. There is no deep meaning behind these magic numbers % used as factors; they just match (closely enough) what Knuth defined. @@ -1674,6 +1486,7 @@ output) for that.)} % can get a sort of poor man's double spacing by redefining this. \def\baselinefactor{1} % +\newdimen\textleading \def\setleading#1{% \dimen0 = #1\relax \normalbaselineskip = \baselinefactor\dimen0 @@ -1695,7 +1508,7 @@ output) for that.)} % if we are producing pdf, and we have \pdffontattr, then define cmaps. % (\pdffontattr was introduced many years ago, but people still run % older pdftex's; it's easy to conditionalize, so we do.) -\ifpdf \ifx\pdffontattr\undefined \else +\ifpdf \ifx\pdffontattr\thisisundefined \else \begingroup \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap @@ -1946,28 +1759,34 @@ end \fi\fi -% Set the font macro #1 to the font named #2, adding on the -% specified font prefix (normally `cm'). +% Set the font macro #1 to the font named \fontprefix#2. % #3 is the font's design size, #4 is a scale factor, #5 is the CMap -% encoding (currently only OT1, OT1IT and OT1TT are allowed, pass -% empty to omit). +% encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit). +% Example: +% #1 = \textrm +% #2 = \rmshape +% #3 = 10 +% #4 = \mainmagstep +% #5 = OT1 +% \def\setfont#1#2#3#4#5{% \font#1=\fontprefix#2#3 scaled #4 \csname cmap#5\endcsname#1% } % This is what gets called when #5 of \setfont is empty. \let\cmap\gobble -% emacs-page end of cmaps +% +% (end of cmaps) % Use cm as the default font prefix. % To specify the font prefix, you must define \fontprefix % before you read in texinfo.tex. -\ifx\fontprefix\undefined +\ifx\fontprefix\thisisundefined \def\fontprefix{cm} \fi % Support font families that don't use the same naming scheme as CM. \def\rmshape{r} -\def\rmbshape{bx} %where the normal face is bold +\def\rmbshape{bx} % where the normal face is bold \def\bfshape{b} \def\bxshape{bx} \def\ttshape{tt} @@ -1982,8 +1801,7 @@ end \def\scshape{csc} \def\scbshape{csc} -% Definitions for a main text size of 11pt. This is the default in -% Texinfo. +% Definitions for a main text size of 11pt. (The default in Texinfo.) % \def\definetextfontsizexi{% % Text fonts (11.2pt, magstep1). @@ -2105,10 +1923,10 @@ end \font\reducedsy=cmsy10 \def\reducedecsize{1000} -% reset the current fonts -\textfonts +\textleading = 13.2pt % line spacing for 11pt CM +\textfonts % reset the current fonts \rm -} % end of 11pt text font size definitions +} % end of 11pt text font size definitions, \definetextfontsizexi % Definitions to make the main text be 10pt Computer Modern, with @@ -2236,25 +2054,24 @@ end \font\reducedsy=cmsy9 \def\reducedecsize{0900} -% reduce space between paragraphs -\divide\parskip by 2 - -% reset the current fonts -\textfonts +\divide\parskip by 2 % reduce space between paragraphs +\textleading = 12pt % line spacing for 10pt CM +\textfonts % reset the current fonts \rm -} % end of 10pt text font size definitions +} % end of 10pt text font size definitions, \definetextfontsizex % We provide the user-level command % @fonttextsize 10 % (or 11) to redefine the text font size. pt is assumed. % -\def\xword{10} \def\xiword{11} +\def\xword{10} +\def\xwordpt{10pt} % \parseargdef\fonttextsize{% \def\textsizearg{#1}% - \wlog{doing @fonttextsize \textsizearg}% + %\wlog{doing @fonttextsize \textsizearg}% % % Set \globaldefs so that documents can use this inside @tex, since % makeinfo 4.8 does not support it, but we need it nonetheless. @@ -2308,7 +2125,7 @@ end \let\tenttsl=\titlettsl \def\curfontsize{title}% \def\lsize{chap}\def\lllsize{subsec}% - \resetmathfonts \setleading{25pt}} + \resetmathfonts \setleading{27pt}} \def\titlefont#1{{\titlefonts\rmisbold #1}} \def\chapfonts{% \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl @@ -2436,12 +2253,14 @@ end % Markup style setup for left and right quotes. \defmarkupstylesetup\markupsetuplq{% - \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname + \expandafter\let\expandafter \temp + \csname markupsetuplq\currentmarkupstyle\endcsname \ifx\temp\relax \markupsetuplqdefault \else \temp \fi } \defmarkupstylesetup\markupsetuprq{% - \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname + \expandafter\let\expandafter \temp + \csname markupsetuprq\currentmarkupstyle\endcsname \ifx\temp\relax \markupsetuprqdefault \else \temp \fi } @@ -2454,28 +2273,31 @@ end \gdef\markupsetcodequoteleft{\let`\codequoteleft} \gdef\markupsetcodequoteright{\let'\codequoteright} - -\gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft} } \let\markupsetuplqcode \markupsetcodequoteleft \let\markupsetuprqcode \markupsetcodequoteright +% \let\markupsetuplqexample \markupsetcodequoteleft \let\markupsetuprqexample \markupsetcodequoteright +% +\let\markupsetuplqkbd \markupsetcodequoteleft +\let\markupsetuprqkbd \markupsetcodequoteright +% +\let\markupsetuplqsamp \markupsetcodequoteleft +\let\markupsetuprqsamp \markupsetcodequoteright +% \let\markupsetuplqverb \markupsetcodequoteleft \let\markupsetuprqverb \markupsetcodequoteright +% \let\markupsetuplqverbatim \markupsetcodequoteleft \let\markupsetuprqverbatim \markupsetcodequoteright -\let\markupsetuplqsamp \markupsetnoligaturesquoteleft -\let\markupsetuplqkbd \markupsetnoligaturesquoteleft - -% Allow an option to not replace quotes with a regular directed right -% quote/apostrophe (char 0x27), but instead use the undirected quote -% from cmtt (char 0x0d). The undirected quote is ugly, so don't make it -% the default, but it works for pasting with more pdf viewers (at least -% evince), the lilypond developers report. xpdf does work with the -% regular 0x27. +% Allow an option to not use regular directed right quote/apostrophe +% (char 0x27), but instead the undirected quote from cmtt (char 0x0d). +% The undirected quote is ugly, so don't make it the default, but it +% works for pasting with more pdf viewers (at least evince), the +% lilypond developers report. xpdf does work with the regular 0x27. % \def\codequoteright{% \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax @@ -2499,33 +2321,83 @@ end \else \char'22 \fi } +% Commands to set the quote options. +% +\parseargdef\codequoteundirected{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETtxicodequoteundirected\endcsname + = t% + \else\ifx\temp\offword + \expandafter\let\csname SETtxicodequoteundirected\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}% + \fi\fi +} +% +\parseargdef\codequotebacktick{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETtxicodequotebacktick\endcsname + = t% + \else\ifx\temp\offword + \expandafter\let\csname SETtxicodequotebacktick\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}% + \fi\fi +} + % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font. \def\noligaturesquoteleft{\relax\lq} % Count depth in font-changes, for error checks \newcount\fontdepth \fontdepth=0 -%% Add scribe-like font environments, plus @l for inline lisp (usually sans -%% serif) and @ii for TeX italic +% Font commands. -% \smartitalic{ARG} outputs arg in italics, followed by an italic correction -% unless the following character is such as not to need one. -\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else - \ptexslash\fi\fi\fi} -\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} -\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} +% #1 is the font command (\sl or \it), #2 is the text to slant. +% If we are in a monospaced environment, however, 1) always use \ttsl, +% and 2) do not add an italic correction. +\def\dosmartslant#1#2{% + \ifusingtt + {{\ttsl #2}\let\next=\relax}% + {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}% + \next +} +\def\smartslanted{\dosmartslant\sl} +\def\smartitalic{\dosmartslant\it} -% like \smartslanted except unconditionally uses \ttsl. -% @var is set to this for defun arguments. -\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} +% Output an italic correction unless \next (presumed to be the following +% character) is such as not to need one. +\def\smartitaliccorrection{% + \ifx\next,% + \else\ifx\next-% + \else\ifx\next.% + \else\ptexslash + \fi\fi\fi + \aftersmartic +} + +% Unconditional use \ttsl, and no ic. @var is set to this for defuns. +\def\ttslanted#1{{\ttsl #1}} % @cite is like \smartslanted except unconditionally use \sl. We never want % ttsl for book titles, do we? -\def\cite#1{{\sl #1}\futurelet\next\smartitalicx} +\def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection} + +\def\aftersmartic{} +\def\var#1{% + \let\saveaftersmartic = \aftersmartic + \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}% + \smartslanted{#1}% +} \let\i=\smartitalic \let\slanted=\smartslanted -\def\var#1{{\setupmarkupstyle{var}\smartslanted{#1}}} \let\dfn=\smartslanted \let\emph=\smartitalic @@ -2575,34 +2447,12 @@ end % @samp. \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}} -% definition of @key that produces a lozenge. Doesn't adjust to text size. -%\setfont\keyrm\rmshape{8}{1000}{OT1} -%\font\keysy=cmsy9 -%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% -% \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% -% \vbox{\hrule\kern-0.4pt -% \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% -% \kern-0.4pt\hrule}% -% \kern-.06em\raise0.4pt\hbox{\angleright}}}} +% @indicateurl is \samp, that is, with quotes. +\let\indicateurl=\samp -% definition of @key with no lozenge. If the current font is already -% monospace, don't change it; that way, we respect @kbdinputstyle. But -% if it isn't monospace, then use \tt. -% -\def\key#1{{\setupmarkupstyle{key}% - \nohyphenation - \ifmonospace\else\tt\fi - #1}\null} - -% ctrl is no longer a Texinfo command. -\def\ctrl #1{{\tt \rawbackslash \hat}#1} - -% @file, @option are the same as @samp. -\let\file=\samp -\let\option=\samp - -% @code is a modification of @t, -% which makes spaces the same size as normal in the surrounding text. +% @code (and similar) prints in typewriter, but with spaces the same +% size as normal in the surrounding text, without hyphenation, etc. +% This is a subroutine for that. \def\tclose#1{% {% % Change normal interword space to be same as for the current font. @@ -2621,13 +2471,13 @@ end \plainfrenchspacing #1% }% - \null + \null % reset spacefactor to 1000 } % We *must* turn on hyphenation at `-' and `_' in @code. % Otherwise, it is too hard to avoid overfull hboxes % in the Emacs manual, the Library manual, etc. - +% % Unfortunately, TeX uses one parameter (\hyphenchar) to control % both hyphenation at - and hyphenation within words. % We must therefore turn them both off (\tclose does that) @@ -2646,14 +2496,16 @@ end \let-\codedash \let_\codeunder \else - \let-\realdash + \let-\normaldash \let_\realunder \fi \codex } } -\def\realdash{-} +\def\codex #1{\tclose{#1}\endgroup} + +\def\normaldash{-} \def\codedash{-\discretionary{}{}{}} \def\codeunder{% % this is all so @math{@code{var_name}+1} can work. In math mode, _ @@ -2666,12 +2518,11 @@ end \discretionary{}{}{}}% {\_}% } -\def\codex #1{\tclose{#1}\endgroup} % An additional complication: the above will allow breaks after, e.g., -% each of the four underscores in __typeof__. This is undesirable in -% some manuals, especially if they don't have long identifiers in -% general. @allowcodebreaks provides a way to control this. +% each of the four underscores in __typeof__. This is bad. +% @allowcodebreaks provides a document-level way to turn breaking at - +% and _ on and off. % \newif\ifallowcodebreaks \allowcodebreakstrue @@ -2686,63 +2537,25 @@ end \allowcodebreaksfalse \else \errhelp = \EMsimple - \errmessage{Unknown @allowcodebreaks option `\txiarg'}% + \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}% \fi\fi } -% @kbd is like @code, except that if the argument is just one @key command, -% then @kbd has no effect. -\def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}} - -% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), -% `example' (@kbd uses ttsl only inside of @example and friends), -% or `code' (@kbd uses normal tty font always). -\parseargdef\kbdinputstyle{% - \def\txiarg{#1}% - \ifx\txiarg\worddistinct - \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% - \else\ifx\txiarg\wordexample - \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% - \else\ifx\txiarg\wordcode - \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% - \else - \errhelp = \EMsimple - \errmessage{Unknown @kbdinputstyle option `\txiarg'}% - \fi\fi\fi -} -\def\worddistinct{distinct} -\def\wordexample{example} -\def\wordcode{code} - -% Default is `distinct'. -\kbdinputstyle distinct - -\def\xkey{\key} -\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% -\ifx\one\xkey\ifx\threex\three \key{#2}% -\else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi -\else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi} - -% For @indicateurl, @env, @command quotes seem unnecessary, so use \code. -\let\indicateurl=\code -\let\env=\code +% For @command, @env, @file, @option quotes seem unnecessary, +% so use \code rather than \samp. \let\command=\code - -% @clicksequence{File @click{} Open ...} -\def\clicksequence#1{\begingroup #1\endgroup} - -% @clickstyle @arrow (by default) -\parseargdef\clickstyle{\def\click{#1}} -\def\click{\arrow} +\let\env=\code +\let\file=\code +\let\option=\code % @uref (abbreviation for `urlref') takes an optional (comma-separated) % second argument specifying the text to display and an optional third % arg as text to display instead of (rather than in addition to) the url -% itself. First (mandatory) arg is the url. Perhaps eventually put in -% a hypertex \special here. -% -\def\uref#1{\douref #1,,,\finish} -\def\douref#1,#2,#3,#4\finish{\begingroup +% itself. First (mandatory) arg is the url. +% (This \urefnobreak definition isn't used now, leaving it for a while +% for comparison.) +\def\urefnobreak#1{\dourefnobreak #1,,,\finish} +\def\dourefnobreak#1,#2,#3,#4\finish{\begingroup \unsepspaces \pdfurl{#1}% \setbox0 = \hbox{\ignorespaces #3}% @@ -2763,6 +2576,103 @@ end \endlink \endgroup} +% This \urefbreak definition is the active one. +\def\urefbreak{\begingroup \urefcatcodes \dourefbreak} +\let\uref=\urefbreak +\def\dourefbreak#1{\urefbreakfinish #1,,,\finish} +\def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example + \unsepspaces + \pdfurl{#1}% + \setbox0 = \hbox{\ignorespaces #3}% + \ifdim\wd0 > 0pt + \unhbox0 % third arg given, show only that + \else + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0 > 0pt + \ifpdf + \unhbox0 % PDF: 2nd arg given, show only it + \else + \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url + \fi + \else + \urefcode{#1}% only url given, so show it + \fi + \fi + \endlink +\endgroup} + +% Allow line breaks around only a few characters (only). +\def\urefcatcodes{% + \catcode\ampChar=\active \catcode\dotChar=\active + \catcode\hashChar=\active \catcode\questChar=\active + \catcode\slashChar=\active +} +{ + \urefcatcodes + % + \global\def\urefcode{\begingroup + \setupmarkupstyle{code}% + \urefcatcodes + \let&\urefcodeamp + \let.\urefcodedot + \let#\urefcodehash + \let?\urefcodequest + \let/\urefcodeslash + \codex + } + % + % By default, they are just regular characters. + \global\def&{\normalamp} + \global\def.{\normaldot} + \global\def#{\normalhash} + \global\def?{\normalquest} + \global\def/{\normalslash} +} + +% we put a little stretch before and after the breakable chars, to help +% line breaking of long url's. The unequal skips make look better in +% cmtt at least, especially for dots. +\def\urefprestretch{\urefprebreak \hskip0pt plus.13em } +\def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em } +% +\def\urefcodeamp{\urefprestretch \&\urefpoststretch} +\def\urefcodedot{\urefprestretch .\urefpoststretch} +\def\urefcodehash{\urefprestretch \#\urefpoststretch} +\def\urefcodequest{\urefprestretch ?\urefpoststretch} +\def\urefcodeslash{\futurelet\next\urefcodeslashfinish} +{ + \catcode`\/=\active + \global\def\urefcodeslashfinish{% + \urefprestretch \slashChar + % Allow line break only after the final / in a sequence of + % slashes, to avoid line break between the slashes in http://. + \ifx\next/\else \urefpoststretch \fi + } +} + +% One more complication: by default we'll break after the special +% characters, but some people like to break before the special chars, so +% allow that. Also allow no breaking at all, for manual control. +% +\parseargdef\urefbreakstyle{% + \def\txiarg{#1}% + \ifx\txiarg\wordnone + \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak} + \else\ifx\txiarg\wordbefore + \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak} + \else\ifx\txiarg\wordafter + \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak} + \else + \errhelp = \EMsimple + \errmessage{Unknown @urefbreakstyle setting `\txiarg'}% + \fi\fi\fi +} +\def\wordafter{after} +\def\wordbefore{before} +\def\wordnone{none} + +\urefbreakstyle after + % @url synonym for @uref, since that's how everyone uses it. % \let\url=\uref @@ -2784,6 +2694,67 @@ end \let\email=\uref \fi +% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), +% `example' (@kbd uses ttsl only inside of @example and friends), +% or `code' (@kbd uses normal tty font always). +\parseargdef\kbdinputstyle{% + \def\txiarg{#1}% + \ifx\txiarg\worddistinct + \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% + \else\ifx\txiarg\wordexample + \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% + \else\ifx\txiarg\wordcode + \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% + \else + \errhelp = \EMsimple + \errmessage{Unknown @kbdinputstyle setting `\txiarg'}% + \fi\fi\fi +} +\def\worddistinct{distinct} +\def\wordexample{example} +\def\wordcode{code} + +% Default is `distinct'. +\kbdinputstyle distinct + +% @kbd is like @code, except that if the argument is just one @key command, +% then @kbd has no effect. +\def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}} + +\def\xkey{\key} +\def\kbdsub#1#2#3\par{% + \def\one{#1}\def\three{#3}\def\threex{??}% + \ifx\one\xkey\ifx\threex\three \key{#2}% + \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi + \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi +} + +% definition of @key that produces a lozenge. Doesn't adjust to text size. +%\setfont\keyrm\rmshape{8}{1000}{OT1} +%\font\keysy=cmsy9 +%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% +% \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% +% \vbox{\hrule\kern-0.4pt +% \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% +% \kern-0.4pt\hrule}% +% \kern-.06em\raise0.4pt\hbox{\angleright}}}} + +% definition of @key with no lozenge. If the current font is already +% monospace, don't change it; that way, we respect @kbdinputstyle. But +% if it isn't monospace, then use \tt. +% +\def\key#1{{\setupmarkupstyle{key}% + \nohyphenation + \ifmonospace\else\tt\fi + #1}\null} + +% @clicksequence{File @click{} Open ...} +\def\clicksequence#1{\begingroup #1\endgroup} + +% @clickstyle @arrow (by default) +\parseargdef\clickstyle{\def\click{#1}} +\def\click{\arrow} + % Typeset a dimension, e.g., `in' or `pt'. The only reason for the % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. % @@ -2805,6 +2776,7 @@ end \ifx\temp\empty \else \space ({\unsepspaces \ignorespaces \temp \unskip})% \fi + \null % reset \spacefactor=1000 } % @abbr for "Comput. J." and the like. @@ -2817,10 +2789,222 @@ end \ifx\temp\empty \else \space ({\unsepspaces \ignorespaces \temp \unskip})% \fi + \null % reset \spacefactor=1000 +} + +% @asis just yields its argument. Used with @table, for example. +% +\def\asis#1{#1} + +% @math outputs its argument in math mode. +% +% One complication: _ usually means subscripts, but it could also mean +% an actual _ character, as in @math{@var{some_variable} + 1}. So make +% _ active, and distinguish by seeing if the current family is \slfam, +% which is what @var uses. +{ + \catcode`\_ = \active + \gdef\mathunderscore{% + \catcode`\_=\active + \def_{\ifnum\fam=\slfam \_\else\sb\fi}% + } +} +% Another complication: we want \\ (and @\) to output a math (or tt) \. +% FYI, plain.tex uses \\ as a temporary control sequence (for no +% particular reason), but this is not advertised and we don't care. +% +% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. +\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} +% +\def\math{% + \tex + \mathunderscore + \let\\ = \mathbackslash + \mathactive + % make the texinfo accent commands work in math mode + \let\"=\ddot + \let\'=\acute + \let\==\bar + \let\^=\hat + \let\`=\grave + \let\u=\breve + \let\v=\check + \let\~=\tilde + \let\dotaccent=\dot + $\finishmath +} +\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. + +% Some active characters (such as <) are spaced differently in math. +% We have to reset their definitions in case the @math was an argument +% to a command which sets the catcodes (such as @item or @section). +% +{ + \catcode`^ = \active + \catcode`< = \active + \catcode`> = \active + \catcode`+ = \active + \catcode`' = \active + \gdef\mathactive{% + \let^ = \ptexhat + \let< = \ptexless + \let> = \ptexgtr + \let+ = \ptexplus + \let' = \ptexquoteright + } +} + +% ctrl is no longer a Texinfo command, but leave this definition for fun. +\def\ctrl #1{{\tt \rawbackslash \hat}#1} + +% @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}. +% Ignore unless FMTNAME == tex; then it is like @iftex and @tex, +% except specified as a normal braced arg, so no newlines to worry about. +% +\def\outfmtnametex{tex} +% +\long\def\inlinefmt#1{\doinlinefmt #1,\finish} +\long\def\doinlinefmt#1,#2,\finish{% + \def\inlinefmtname{#1}% + \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi +} +% For raw, must switch into @tex before parsing the argument, to avoid +% setting catcodes prematurely. Doing it this way means that, for +% example, @inlineraw{html, foo{bar} gets a parse error instead of being +% ignored. But this isn't important because if people want a literal +% *right* brace they would have to use a command anyway, so they may as +% well use a command to get a left brace too. We could re-use the +% delimiter character idea from \verb, but it seems like overkill. +% +\long\def\inlineraw{\tex \doinlineraw} +\long\def\doinlineraw#1{\doinlinerawtwo #1,\finish} +\def\doinlinerawtwo#1,#2,\finish{% + \def\inlinerawname{#1}% + \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi + \endgroup % close group opened by \tex. } \message{glyphs,} +% and logos. + +% @@ prints an @, as does @atchar{}. +\def\@{\char64 } +\let\atchar=\@ + +% @{ @} @lbracechar{} @rbracechar{} all generate brace characters. +% Unless we're in typewriter, use \ecfont because the CM text fonts do +% not have braces, and we don't want to switch into math. +\def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}} +\def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}} +\let\{=\mylbrace \let\lbracechar=\{ +\let\}=\myrbrace \let\rbracechar=\} +\begingroup + % Definitions to produce \{ and \} commands for indices, + % and @{ and @} for the aux/toc files. + \catcode`\{ = \other \catcode`\} = \other + \catcode`\[ = 1 \catcode`\] = 2 + \catcode`\! = 0 \catcode`\\ = \other + !gdef!lbracecmd[\{]% + !gdef!rbracecmd[\}]% + !gdef!lbraceatcmd[@{]% + !gdef!rbraceatcmd[@}]% +!endgroup + +% @comma{} to avoid , parsing problems. +\let\comma = , + +% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent +% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. +\let\, = \ptexc +\let\dotaccent = \ptexdot +\def\ringaccent#1{{\accent23 #1}} +\let\tieaccent = \ptext +\let\ubaraccent = \ptexb +\let\udotaccent = \d + +% Other special characters: @questiondown @exclamdown @ordf @ordm +% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. +\def\questiondown{?`} +\def\exclamdown{!`} +\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} +\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} + +% Dotless i and dotless j, used for accents. +\def\imacro{i} +\def\jmacro{j} +\def\dotless#1{% + \def\temp{#1}% + \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi + \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi + \else \errmessage{@dotless can be used only with i or j}% + \fi\fi +} + +% The \TeX{} logo, as in plain, but resetting the spacing so that a +% period following counts as ending a sentence. (Idea found in latex.) +% +\edef\TeX{\TeX \spacefactor=1000 } + +% @LaTeX{} logo. Not quite the same results as the definition in +% latex.ltx, since we use a different font for the raised A; it's most +% convenient for us to use an explicitly smaller font, rather than using +% the \scriptstyle font (since we don't reset \scriptstyle and +% \scriptscriptstyle). +% +\def\LaTeX{% + L\kern-.36em + {\setbox0=\hbox{T}% + \vbox to \ht0{\hbox{% + \ifx\textnominalsize\xwordpt + % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX. + % Revert to plain's \scriptsize, which is 7pt. + \count255=\the\fam $\fam\count255 \scriptstyle A$% + \else + % For 11pt, we can use our lllsize. + \selectfonts\lllsize A% + \fi + }% + \vss + }}% + \kern-.15em + \TeX +} + +% Some math mode symbols. +\def\bullet{$\ptexbullet$} +\def\geq{\ifmmode \ge\else $\ge$\fi} +\def\leq{\ifmmode \le\else $\le$\fi} +\def\minus{\ifmmode -\else $-$\fi} + +% @dots{} outputs an ellipsis using the current font. +% We do .5em per period so that it has the same spacing in the cm +% typewriter fonts as three actual period characters; on the other hand, +% in other typewriter fonts three periods are wider than 1.5em. So do +% whichever is larger. +% +\def\dots{% + \leavevmode + \setbox0=\hbox{...}% get width of three periods + \ifdim\wd0 > 1.5em + \dimen0 = \wd0 + \else + \dimen0 = 1.5em + \fi + \hbox to \dimen0{% + \hskip 0pt plus.25fil + .\hskip 0pt plus1fil + .\hskip 0pt plus1fil + .\hskip 0pt plus.5fil + }% +} + +% @enddots{} is an end-of-sentence ellipsis. +% +\def\enddots{% + \dots + \spacefactor=\endofsentencespacefactor +} % @point{}, @result{}, @expansion{}, @print{}, @equiv{}. % @@ -2842,7 +3026,7 @@ end {\tentt \global\dimen0 = 3em}% Width of the box. \dimen2 = .55pt % Thickness of rules % The text. (`r' is open on the right, `e' somewhat less so on the left.) -\setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt} +\setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt} % \setbox\errorbox=\hbox to \dimen0{\hfil \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. @@ -2963,12 +3147,17 @@ end % hopefully nobody will notice/care. \edef\ecsize{\csname\curfontsize ecsize\endcsname}% \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}% - \ifx\curfontstyle\bfstylename - % bold: - \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize + \ifmonospace + % typewriter: + \font\thisecfont = ectt\ecsize \space at \nominalsize \else - % regular: - \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize + \ifx\curfontstyle\bfstylename + % bold: + \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize + \else + % regular: + \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize + \fi \fi \thisecfont } @@ -2991,7 +3180,7 @@ end % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38 % so we'll define it if necessary. % -\ifx\Orb\undefined +\ifx\Orb\thisisundefined \def\Orb{\mathhexbox20D} \fi @@ -3019,8 +3208,9 @@ end \newif\ifsetshortcontentsaftertitlepage \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue -\parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% - \endgroup\page\hbox{}\page} +\parseargdef\shorttitlepage{% + \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}% + \endgroup\page\hbox{}\page} \envdef\titlepage{% % Open one extra group, as we want to close it in the middle of \Etitlepage. @@ -3080,14 +3270,28 @@ end \finishedtitlepagetrue } -%%% Macros to be used within @titlepage: +% Settings used for typesetting titles: no hyphenation, no indentation, +% don't worry much about spacing, ragged right. This should be used +% inside a \vbox, and fonts need to be set appropriately first. Because +% it is always used for titles, nothing else, we call \rmisbold. \par +% should be specified before the end of the \vbox, since a vbox is a group. +% +\def\raggedtitlesettings{% + \rmisbold + \hyphenpenalty=10000 + \parindent=0pt + \tolerance=5000 + \ptexraggedright +} + +% Macros to be used within @titlepage: \let\subtitlerm=\tenrm \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} \parseargdef\title{% \checkenv\titlepage - \leftline{\titlefonts\rmisbold #1} + \vbox{\titlefonts \raggedtitlesettings #1\par}% % print a rule at the page bottom also. \finishedtitlepagefalse \vskip4pt \hrule height 4pt width \hsize \vskip4pt @@ -3113,7 +3317,7 @@ end } -%%% Set up page headings and footings. +% Set up page headings and footings. \let\thispage=\folio @@ -3207,10 +3411,14 @@ end \def\headings #1 {\csname HEADINGS#1\endcsname} -\def\HEADINGSoff{% -\global\evenheadline={\hfil} \global\evenfootline={\hfil} -\global\oddheadline={\hfil} \global\oddfootline={\hfil}} -\HEADINGSoff +\def\headingsoff{% non-global headings elimination + \evenheadline={\hfil}\evenfootline={\hfil}% + \oddheadline={\hfil}\oddfootline={\hfil}% +} + +\def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting +\HEADINGSoff % it's the default + % When we turn headings on, set the page number to 1. % For double-sided printing, put current file name in lower left corner, % chapter name on inside top of right hand pages, document @@ -3261,7 +3469,7 @@ end % This produces Day Month Year style of output. % Only define if not already defined, in case a txi-??.tex file has set % up a different format (e.g., txi-cs.tex does this). -\ifx\today\undefined +\ifx\today\thisisundefined \def\today{% \number\day\space \ifcase\month @@ -3322,7 +3530,7 @@ end \begingroup \advance\leftskip by-\tableindent \advance\hsize by\tableindent - \advance\rightskip by0pt plus1fil + \advance\rightskip by0pt plus1fil\relax \leavevmode\unhbox0\par \endgroup % @@ -3808,18 +4016,18 @@ end \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip \global\advance\multitablelinespace by-\ht0 \fi -%% Test to see if parskip is larger than space between lines of -%% table. If not, do nothing. -%% If so, set to same dimension as multitablelinespace. +% Test to see if parskip is larger than space between lines of +% table. If not, do nothing. +% If so, set to same dimension as multitablelinespace. \ifdim\multitableparskip>\multitablelinespace \global\multitableparskip=\multitablelinespace -\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller - %% than skip between lines in the table. +\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller + % than skip between lines in the table. \fi% \ifdim\multitableparskip=0pt \global\multitableparskip=\multitablelinespace -\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller - %% than skip between lines in the table. +\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller + % than skip between lines in the table. \fi} @@ -3980,7 +4188,7 @@ end % ..., but we might end up with active ones in the argument if % we're called from @code, as @code{@value{foo-bar_}}, though. % So \let them to their normal equivalents. - \let-\realdash \let_\normalunderscore + \let-\normaldash \let_\normalunderscore } } @@ -4020,7 +4228,7 @@ end } \def\ifsetfail{\doignore{ifset}} -% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been +% @ifclear VAR ... @end executes the `...' iff VAR has never been % defined with @set, or has been undefined with @clear. % % The `\else' inside the `\doifset' parameter is a trick to reuse the @@ -4031,6 +4239,35 @@ end \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} \def\ifclearfail{\doignore{ifclear}} +% @ifcommandisdefined CMD ... @end executes the `...' if CMD (written +% without the @) is in fact defined. We can only feasibly check at the +% TeX level, so something like `mathcode' is going to considered +% defined even though it is not a Texinfo command. +% +\makecond{ifcommanddefined} +\def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}} +% +\def\doifcmddefined#1#2{{% + \makevalueexpandable + \let\next=\empty + \expandafter\ifx\csname #2\endcsname\relax + #1% If not defined, \let\next as above. + \fi + \expandafter + }\next +} +\def\ifcmddefinedfail{\doignore{ifcommanddefined}} + +% @ifcommandnotdefined CMD ... handled similar to @ifclear above. +\makecond{ifcommandnotdefined} +\def\ifcommandnotdefined{% + \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}} +\def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}} + +% Set the `txicommandconditionals' variable, so documents have a way to +% test if the @ifcommand...defined conditionals are available. +\set txicommandconditionals + % @dircategory CATEGORY -- specify a category of the dir file % which this file should belong to. Ignore this in TeX. \let\dircategory=\comment @@ -4134,11 +4371,14 @@ end \def\@{@}% change to @@ when we switch to @ as escape char in index files. \def\ {\realbackslash\space }% % - % Need these in case \tex is in effect and \{ is a \delimiter again. - % But can't use \lbracecmd and \rbracecmd because texindex assumes - % braces and backslashes are used only as delimiters. - \let\{ = \mylbrace - \let\} = \myrbrace + % Need these unexpandable (because we define \tt as a dummy) + % definitions when @{ or @} appear in index entry text. Also, more + % complicated, when \tex is in effect and \{ is a \delimiter again. + % We can't use \lbracecmd and \rbracecmd because texindex assumes + % braces and backslashes are used only as delimiters. Perhaps we + % should define @lbrace and @rbrace commands a la @comma. + \def\{{{\tt\char123}}% + \def\}{{\tt\char125}}% % % I don't entirely understand this, but when an index entry is % generated from a macro call, the \endinput which \scanmacro inserts @@ -4191,7 +4431,7 @@ end \def\commondummies{% % % \definedummyword defines \#1 as \string\#1\space, thus effectively - % preventing its expansion. This is used only for control% words, + % preventing its expansion. This is used only for control words, % not control letters, because the \space would be incorrect for % control characters, but is needed to separate the control word % from whatever follows. @@ -4210,6 +4450,7 @@ end \commondummiesnofonts % \definedummyletter\_% + \definedummyletter\-% % % Non-English letters. \definedummyword\AA @@ -4246,20 +4487,25 @@ end \definedummyword\TeX % % Assorted special characters. + \definedummyword\arrow \definedummyword\bullet \definedummyword\comma \definedummyword\copyright \definedummyword\registeredsymbol \definedummyword\dots \definedummyword\enddots + \definedummyword\entrybreak \definedummyword\equiv \definedummyword\error \definedummyword\euro + \definedummyword\expansion + \definedummyword\geq \definedummyword\guillemetleft \definedummyword\guillemetright \definedummyword\guilsinglleft \definedummyword\guilsinglright - \definedummyword\expansion + \definedummyword\lbracechar + \definedummyword\leq \definedummyword\minus \definedummyword\ogonek \definedummyword\pounds @@ -4271,6 +4517,7 @@ end \definedummyword\quoteleft \definedummyword\quoteright \definedummyword\quotesinglbase + \definedummyword\rbracechar \definedummyword\result \definedummyword\textdegree % @@ -4316,19 +4563,27 @@ end \definedummyword\b \definedummyword\i \definedummyword\r + \definedummyword\sansserif \definedummyword\sc + \definedummyword\slanted \definedummyword\t % % Commands that take arguments. + \definedummyword\abbr \definedummyword\acronym + \definedummyword\anchor \definedummyword\cite \definedummyword\code \definedummyword\command \definedummyword\dfn + \definedummyword\dmn \definedummyword\email \definedummyword\emph \definedummyword\env \definedummyword\file + \definedummyword\image + \definedummyword\indicateurl + \definedummyword\inforef \definedummyword\kbd \definedummyword\key \definedummyword\math @@ -4356,7 +4611,7 @@ end \def\definedummyaccent##1{\let##1\asis}% % We can just ignore other control letters. \def\definedummyletter##1{\let##1\empty}% - % Hopefully, all control words can become @asis. + % All control words become @asis by default; overrides below. \let\definedummyword\definedummyaccent % \commondummiesnofonts @@ -4368,8 +4623,17 @@ end % \def\ { }% \def\@{@}% - % how to handle braces? \def\_{\normalunderscore}% + \def\-{}% @- shouldn't affect sorting + % + % Unfortunately, texindex is not prepared to handle braces in the + % content at all. So for index sorting, we map @{ and @} to strings + % starting with |, since that ASCII character is between ASCII { and }. + \def\{{|a}% + \def\lbracechar{|a}% + % + \def\}{|b}% + \def\rbracechar{|b}% % % Non-English letters. \def\AA{AA}% @@ -4397,6 +4661,7 @@ end % % Assorted special characters. % (The following {} will end up in the sort string, but that's ok.) + \def\arrow{->}% \def\bullet{bullet}% \def\comma{,}% \def\copyright{copyright}% @@ -4406,10 +4671,12 @@ end \def\error{error}% \def\euro{euro}% \def\expansion{==>}% + \def\geq{>=}% \def\guillemetleft{<<}% \def\guillemetright{>>}% \def\guilsinglleft{<}% \def\guilsinglright{>}% + \def\leq{<=}% \def\minus{-}% \def\point{.}% \def\pounds{pounds}% @@ -4424,6 +4691,9 @@ end \def\result{=>}% \def\textdegree{o}% % + \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax + \else \indexlquoteignore \fi + % % We need to get rid of all macros, leaving only the arguments (if present). % Of course this is not nearly correct, but it is the best we can do for now. % makeinfo does not expand macros in the argument to @deffn, which ends up @@ -4437,6 +4707,11 @@ end \macrolist } +% Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us +% ignore left quotes in the sort term. +{\catcode`\`=\active + \gdef\indexlquoteignore{\let`=\empty}} + \let\indexbackslash=0 %overridden during \printindex. \let\SETmarginindex=\relax % put index entries in margin (undocumented)? @@ -4534,10 +4809,9 @@ end % % ..., ready, GO: % -\def\safewhatsit#1{% -\ifhmode +\def\safewhatsit#1{\ifhmode #1% -\else + \else % \lastskip and \lastpenalty cannot both be nonzero simultaneously. \whatsitskip = \lastskip \edef\lastskipmacro{\the\lastskip}% @@ -4561,7 +4835,6 @@ end % to re-insert the same penalty (values >10000 are used for various % signals); since we just inserted a non-discardable item, any % following glue (such as a \parskip) would be a breakpoint. For example: - % % @deffn deffn-whatever % @vindex index-whatever % Description. @@ -4574,8 +4847,7 @@ end % (the whatsit from the \write), so we must insert a \nobreak. \nobreak\vskip\whatsitskip \fi -\fi -} +\fi} % The index entry written in the file actually looks like % \entry {sortstring}{page}{topic} @@ -4694,7 +4966,6 @@ end % But this freezes the catcodes in the argument, and can cause problems to % @code, which sets - active. This problem was fixed by a kludge--- % ``-'' was active throughout whole index, but this isn't really right. -% % The right solution is to prevent \entry from swallowing the whole text. % --kasal, 21nov03 \def\entry{% @@ -4731,10 +5002,17 @@ end % columns. \vskip 0pt plus1pt % + % When reading the text of entry, convert explicit line breaks + % from @* into spaces. The user might give these in long section + % titles, for instance. + \def\*{\unskip\space\ignorespaces}% + \def\entrybreak{\hfil\break}% + % % Swallow the left brace of the text (first parameter): \afterassignment\doentry \let\temp = } +\def\entrybreak{\unskip\space\ignorespaces}% \def\doentry{% \bgroup % Instead of the swallowed brace. \noindent @@ -4967,7 +5245,22 @@ end \message{sectioning,} % Chapters, sections, etc. -% \unnumberedno is an oxymoron, of course. But we count the unnumbered +% Let's start with @part. +\outer\parseargdef\part{\partzzz{#1}} +\def\partzzz#1{% + \chapoddpage + \null + \vskip.3\vsize % move it down on the page a bit + \begingroup + \noindent \titlefonts\rmisbold #1\par % the text + \let\lastnode=\empty % no node to associate with + \writetocentry{part}{#1}{}% but put it in the toc + \headingsoff % no headline or footline on the part page + \chapoddpage + \endgroup +} + +% \unnumberedno is an oxymoron. But we count the unnumbered % sections so that we can refer to them unambiguously in the pdf % outlines by their "section number". We avoid collisions with chapter % numbers by starting them at 10000. (If a document ever has 10000 @@ -5046,8 +5339,8 @@ end \chardef\maxseclevel = 3 % % A numbered section within an unnumbered changes to unnumbered too. -% To achive this, remember the "biggest" unnum. sec. we are currently in: -\chardef\unmlevel = \maxseclevel +% To achieve this, remember the "biggest" unnum. sec. we are currently in: +\chardef\unnlevel = \maxseclevel % % Trace whether the current chapter is an appendix or not: % \chapheadtype is "N" or "A", unnumbered chapters are ignored. @@ -5072,8 +5365,8 @@ end % The heading type: \def\headtype{#1}% \if \headtype U% - \ifnum \absseclevel < \unmlevel - \chardef\unmlevel = \absseclevel + \ifnum \absseclevel < \unnlevel + \chardef\unnlevel = \absseclevel \fi \else % Check for appendix sections: @@ -5085,10 +5378,10 @@ end \fi\fi \fi % Check for numbered within unnumbered: - \ifnum \absseclevel > \unmlevel + \ifnum \absseclevel > \unnlevel \def\headtype{U}% \else - \chardef\unmlevel = 3 + \chardef\unnlevel = 3 \fi \fi % Now print the heading: @@ -5174,7 +5467,8 @@ end \global\let\subsubsection = \appendixsubsubsec } -\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz +% normally unnmhead0 calls unnumberedzzz: +\outer\parseargdef\unnumbered{\unnmhead0{#1}} \def\unnumberedzzz#1{% \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 \global\advance\unnumberedno by 1 @@ -5218,40 +5512,47 @@ end \let\top\unnumbered % Sections. +% \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz \def\seczzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% } -\outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz +% normally calls appendixsectionzzz: +\outer\parseargdef\appendixsection{\apphead1{#1}} \def\appendixsectionzzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% } \let\appendixsec\appendixsection -\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz +% normally calls unnumberedseczzz: +\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} \def\unnumberedseczzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% } % Subsections. -\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz +% +% normally calls numberedsubseczzz: +\outer\parseargdef\numberedsubsec{\numhead2{#1}} \def\numberedsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% } -\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz +% normally calls appendixsubseczzz: +\outer\parseargdef\appendixsubsec{\apphead2{#1}} \def\appendixsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Yappendix}% {\appendixletter.\the\secno.\the\subsecno}% } -\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz +% normally calls unnumberedsubseczzz: +\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} \def\unnumberedsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Ynothing}% @@ -5259,21 +5560,25 @@ end } % Subsubsections. -\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz +% +% normally numberedsubsubseczzz: +\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} \def\numberedsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Ynumbered}% {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% } -\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz +% normally appendixsubsubseczzz: +\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} \def\appendixsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Yappendix}% {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% } -\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz +% normally unnumberedsubsubseczzz: +\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} \def\unnumberedsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Ynothing}% @@ -5289,14 +5594,6 @@ end % Define @majorheading, @heading and @subheading -% NOTE on use of \vbox for chapter headings, section headings, and such: -% 1) We use \vbox rather than the earlier \line to permit -% overlong headings to fold. -% 2) \hyphenpenalty is set to 10000 because hyphenation in a -% heading is obnoxious; this forbids it. -% 3) Likewise, headings look best if no \parindent is used, and -% if justification is not attempted. Hence \raggedright. - \def\majorheading{% {\advance\chapheadingskip by 10pt \chapbreak }% \parsearg\chapheadingzzz @@ -5304,10 +5601,8 @@ end \def\chapheading{\chapbreak \parsearg\chapheadingzzz} \def\chapheadingzzz#1{% - {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt\ptexraggedright - \rmisbold #1\hfill}}% - \bigskip \par\penalty 200\relax + \vbox{\chapfonts \raggedtitlesettings #1\par}% + \nobreak\bigskip \nobreak \suppressfirstparagraphindent } @@ -5323,14 +5618,13 @@ end % (including whitespace, linebreaking, etc. around it), % given all the information in convenient, parsed form. -%%% Args are the skip and penalty (usually negative) +% Args are the skip and penalty (usually negative) \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} -%%% Define plain chapter starts, and page on/off switching for it % Parameter controlling skip before chapter headings (if needed) - \newskip\chapheadingskip +% Define plain chapter starts, and page on/off switching for it. \def\chapbreak{\dobreak \chapheadingskip {-4000}} \def\chappager{\par\vfill\supereject} % Because \domark is called before \chapoddpage, the filler page will @@ -5340,9 +5634,8 @@ end \chappager \ifodd\pageno \else \begingroup - \evenheadline={\hfil}\evenfootline={\hfil}% - \oddheadline={\hfil}\oddfootline={\hfil}% - \hbox to 0pt{}% + \headingsoff + \null \chappager \endgroup \fi @@ -5468,8 +5761,7 @@ end % % Typeset the actual heading. \nobreak % Avoid page breaks at the interline glue. - \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright - \hangindent=\wd0 \centerparametersmaybe + \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe \unhbox0 #1\par}% }% \nobreak\bigskip % no page break after a chapter title @@ -5491,18 +5783,18 @@ end \def\setchapterstyle #1 {\csname CHAPF#1\endcsname} % \def\unnchfopen #1{% -\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt\ptexraggedright - \rmisbold #1\hfill}}\bigskip \par\nobreak + \chapoddpage + \vbox{\chapfonts \raggedtitlesettings #1\par}% + \nobreak\bigskip\nobreak } \def\chfopen #1#2{\chapoddpage {\chapfonts \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% \par\penalty 5000 % } \def\centerchfopen #1{% -\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt - \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak + \chapoddpage + \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}% + \nobreak\bigskip \nobreak } \def\CHAPFopen{% \global\let\chapmacro=\chfopen @@ -5534,6 +5826,8 @@ end % \def\sectionheading#1#2#3#4{% {% + \checkenv{}% should not be in an environment. + % % Switch to the right set of fonts. \csname #2fonts\endcsname \rmisbold % @@ -5645,15 +5939,15 @@ end % % We'll almost certainly start a paragraph next, so don't let that % glue accumulate. (Not a breakpoint because it's preceded by a - % discardable item.) + % discardable item.) However, when a paragraph is not started next + % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out + % or the negative glue will cause weirdly wrong output, typically + % obscuring the section heading with something else. \vskip-\parskip % - % This is purely so the last item on the list is a known \penalty > - % 10000. This is so \startdefun can avoid allowing breakpoints after - % section headings. Otherwise, it would insert a valid breakpoint between: - % - % @section sec-whatever - % @deffn def-whatever + % This is so the last item on the main vertical list is a known + % \penalty > 10000, so \startdefun, etc., can recognize the situation + % and do the needful. \penalty 10001 } @@ -5785,6 +6079,7 @@ end \def\summarycontents{% \startcontents{\putwordShortTOC}% % + \let\partentry = \shortpartentry \let\numchapentry = \shortchapentry \let\appentry = \shortchapentry \let\unnchapentry = \shortunnchapentry @@ -5840,6 +6135,19 @@ end % The last argument is the page number. % The arguments in between are the chapter number, section number, ... +% Parts, in the main contents. Replace the part number, which doesn't +% exist, with an empty box. Let's hope all the numbers have the same width. +% Also ignore the page number, which is conventionally not printed. +\def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}} +\def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}} +% +% Parts, in the short toc. +\def\shortpartentry#1#2#3#4{% + \penalty-300 + \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip + \shortchapentry{{\bf #1}}{\numeralbox}{}{}% +} + % Chapters, in the main contents. \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} % @@ -5929,9 +6237,9 @@ end \message{environments,} % @foo ... @end foo. -% @tex ... @end tex escapes into raw Tex temporarily. +% @tex ... @end tex escapes into raw TeX temporarily. % One exception: @ is still an escape character, so that @end tex works. -% But \@ or @@ will get a plain tex @ character. +% But \@ or @@ will get a plain @ character. \envdef\tex{% \setupmarkupstyle{tex}% @@ -5948,6 +6256,10 @@ end \catcode`\'=\other \escapechar=`\\ % + % ' is active in math mode (mathcode"8000). So reset it, and all our + % other math active characters (just in case), to plain's definitions. + \mathactive + % \let\b=\ptexb \let\bullet=\ptexbullet \let\c=\ptexc @@ -6051,6 +6363,12 @@ end \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip % Flag to tell @lisp, etc., not to narrow margin. \let\nonarrowing = t% + % + % If this cartouche directly follows a sectioning command, we need the + % \parskip glue (backspaced over by default) or the cartouche can + % collide with the section heading. + \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi + % \vbox\bgroup \baselineskip=0pt\parskip=0pt\lineskip=0pt \carttop @@ -6064,7 +6382,7 @@ end \lineskip=\normlskip \parskip=\normpskip \vskip -\parskip - \comment % For explanation, see the end of \def\group. + \comment % For explanation, see the end of def\group. } \def\Ecartouche{% \ifhmode\par\fi @@ -6150,41 +6468,42 @@ end } % We often define two environments, @foo and @smallfoo. -% Let's do it by one command: -\def\makedispenv #1#2{ - \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2} - \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2} +% Let's do it in one command. #1 is the env name, #2 the definition. +\def\makedispenvdef#1#2{% + \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}% + \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}% \expandafter\let\csname E#1\endcsname \afterenvbreak \expandafter\let\csname Esmall#1\endcsname \afterenvbreak } -% Define two synonyms: -\def\maketwodispenvs #1#2#3{ - \makedispenv{#1}{#3} - \makedispenv{#2}{#3} +% Define two environment synonyms (#1 and #2) for an environment. +\def\maketwodispenvdef#1#2#3{% + \makedispenvdef{#1}{#3}% + \makedispenvdef{#2}{#3}% } - -% @lisp: indented, narrowed, typewriter font; @example: same as @lisp. +% +% @lisp: indented, narrowed, typewriter font; +% @example: same as @lisp. % % @smallexample and @smalllisp: use smaller fonts. % Originally contributed by Pavel@xerox. % -\maketwodispenvs {lisp}{example}{% +\maketwodispenvdef{lisp}{example}{% \nonfillstart \tt\setupmarkupstyle{example}% \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. - \gobble % eat return + \gobble % eat return } % @display/@smalldisplay: same as @lisp except keep current font. % -\makedispenv {display}{% +\makedispenvdef{display}{% \nonfillstart \gobble } % @format/@smallformat: same as @display except don't narrow margins. % -\makedispenv{format}{% +\makedispenvdef{format}{% \let\nonarrowing = t% \nonfillstart \gobble @@ -6203,7 +6522,7 @@ end \envdef\flushright{% \let\nonarrowing = t% \nonfillstart - \advance\leftskip by 0pt plus 1fill + \advance\leftskip by 0pt plus 1fill\relax \gobble } \let\Eflushright = \afterenvbreak @@ -6238,43 +6557,28 @@ end % we're doing normal filling. So, when using \aboveenvbreak and % \afterenvbreak, temporarily make \parskip 0. % +\makedispenvdef{quotation}{\quotationstart} +% \def\quotationstart{% - {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip - \parindent=0pt - % - % @cartouche defines \nonarrowing to inhibit narrowing at next level down. + \indentedblockstart % same as \indentedblock, but increase right margin too. \ifx\nonarrowing\relax - \advance\leftskip by \lispnarrowing \advance\rightskip by \lispnarrowing - \exdentamount = \lispnarrowing - \else - \let\nonarrowing = \relax \fi \parsearg\quotationlabel } -\envdef\quotation{% - \setnormaldispenv - \quotationstart -} - -\envdef\smallquotation{% - \setsmalldispenv - \quotationstart -} -\let\Esmallquotation = \Equotation - % We have retained a nonzero parskip for the environment, since we're % doing normal filling. % \def\Equotation{% \par - \ifx\quotationauthor\undefined\else + \ifx\quotationauthor\thisisundefined\else % indent a bit. \leftline{\kern 2\leftskip \sl ---\quotationauthor}% \fi {\parskip=0pt \afterenvbreak}% } +\def\Esmallquotation{\Equotation} % If we're given an argument, typeset it in bold with a colon after. \def\quotationlabel#1{% @@ -6284,6 +6588,32 @@ end \fi } +% @indentedblock is like @quotation, but indents only on the left and +% has no optional argument. +% +\makedispenvdef{indentedblock}{\indentedblockstart} +% +\def\indentedblockstart{% + {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip + \parindent=0pt + % + % @cartouche defines \nonarrowing to inhibit narrowing at next level down. + \ifx\nonarrowing\relax + \advance\leftskip by \lispnarrowing + \exdentamount = \lispnarrowing + \else + \let\nonarrowing = \relax + \fi +} + +% Keep a nonzero parskip for the environment, since we're doing normal filling. +% +\def\Eindentedblock{% + \par + {\parskip=0pt \afterenvbreak}% +} +\def\Esmallindentedblock{\Eindentedblock} + % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} % If we want to allow any <char> as delimiter, @@ -6331,21 +6661,28 @@ end % Setup for the @verbatim environment % -% Real tab expansion +% Real tab expansion. \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount % -\def\starttabbox{\setbox0=\hbox\bgroup} +% We typeset each line of the verbatim in an \hbox, so we can handle +% tabs. The \global is in case the verbatim line starts with an accent, +% or some other command that starts with a begin-group. Otherwise, the +% entire \verbbox would disappear at the corresponding end-group, before +% it is typeset. Meanwhile, we can't have nested verbatim commands +% (can we?), so the \global won't be overwriting itself. +\newbox\verbbox +\def\starttabbox{\global\setbox\verbbox=\hbox\bgroup} % \begingroup \catcode`\^^I=\active \gdef\tabexpand{% \catcode`\^^I=\active \def^^I{\leavevmode\egroup - \dimen0=\wd0 % the width so far, or since the previous tab - \divide\dimen0 by\tabw - \multiply\dimen0 by\tabw % compute previous multiple of \tabw - \advance\dimen0 by\tabw % advance to next multiple of \tabw - \wd0=\dimen0 \box0 \starttabbox + \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab + \divide\dimen\verbbox by\tabw + \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw + \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw + \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox }% } \endgroup @@ -6354,15 +6691,16 @@ end \def\setupverbatim{% \let\nonarrowing = t% \nonfillstart - % Easiest (and conventionally used) font for verbatim - \tt - \def\par{\leavevmode\egroup\box0\endgraf}% + \tt % easiest (and conventionally used) font for verbatim + % The \leavevmode here is for blank lines. Otherwise, we would + % never \starttabox and the \egroup would end verbatim mode. + \def\par{\leavevmode\egroup\box\verbbox\endgraf}% \tabexpand \setupmarkupstyle{verbatim}% % Respect line breaks, % print special symbols as themselves, and - % make each space count - % must do in this order: + % make each space count. + % Must do in this order: \obeylines \uncatcodespecials \sepspaces \everypar{\starttabbox}% } @@ -6419,6 +6757,7 @@ end \makevalueexpandable \setupverbatim \indexnofonts % Allow `@@' and other weird things in file names. + \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}% \input #1 \afterenvbreak }% @@ -6468,7 +6807,7 @@ end % commands also insert a nobreak penalty, and we don't want to allow % a break between a section heading and a defun. % - % As a minor refinement, we avoid "club" headers by signalling + % As a further refinement, we avoid "club" headers by signalling % with penalty of 10003 after the very first @deffn in the % sequence (see above), and penalty of 10002 after any following % @def command. @@ -6505,7 +6844,7 @@ end #1#2 \endheader % common ending: \interlinepenalty = 10000 - \advance\rightskip by 0pt plus 1fil + \advance\rightskip by 0pt plus 1fil\relax \endgraf \nobreak\vskip -\parskip \penalty\defunpenalty % signal to \startdefun and \dodefunx @@ -6535,13 +6874,36 @@ end \def\domakedefun#1#2#3{% \envdef#1{% \startdefun + \doingtypefnfalse % distinguish typed functions from all else \parseargusing\activeparens{\printdefunline#3}% }% \def#2{\dodefunx#1}% \def#3% } -%%% Untyped functions: +\newif\ifdoingtypefn % doing typed function? +\newif\ifrettypeownline % typeset return type on its own line? + +% @deftypefnnewline on|off says whether the return type of typed functions +% are printed on their own line. This affects @deftypefn, @deftypefun, +% @deftypeop, and @deftypemethod. +% +\parseargdef\deftypefnnewline{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETtxideftypefnnl\endcsname + = \empty + \else\ifx\temp\offword + \expandafter\let\csname SETtxideftypefnnl\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @txideftypefnnl value `\temp', + must be on|off}% + \fi\fi +} + +% Untyped functions: % @deffn category name args \makedefun{deffn}{\deffngeneral{}} @@ -6560,7 +6922,7 @@ end \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% } -%%% Typed functions: +% Typed functions: % @deftypefn category type name args \makedefun{deftypefn}{\deftypefngeneral{}} @@ -6575,10 +6937,11 @@ end % \def\deftypefngeneral#1#2 #3 #4 #5\endheader{% \dosubind{fn}{\code{#4}}{#1}% + \doingtypefntrue \defname{#2}{#3}{#4}\defunargs{#5\unskip}% } -%%% Typed variables: +% Typed variables: % @deftypevr category type var args \makedefun{deftypevr}{\deftypecvgeneral{}} @@ -6596,7 +6959,7 @@ end \defname{#2}{#3}{#4}\defunargs{#5\unskip}% } -%%% Untyped variables: +% Untyped variables: % @defvr category var args \makedefun{defvr}#1 {\deftypevrheader{#1} {} } @@ -6607,7 +6970,8 @@ end % \defcvof {category of}class var args \def\defcvof#1#2 {\deftypecvof{#1}#2 {} } -%%% Type: +% Types: + % @deftp category name args \makedefun{deftp}#1 #2 #3\endheader{% \doind{tp}{\code{#2}}% @@ -6635,25 +6999,49 @@ end % We are followed by (but not passed) the arguments, if any. % \def\defname#1#2#3{% + \par % Get the values of \leftskip and \rightskip as they were outside the @def... \advance\leftskip by -\defbodyindent % - % How we'll format the type name. Putting it in brackets helps + % Determine if we are typesetting the return type of a typed function + % on a line by itself. + \rettypeownlinefalse + \ifdoingtypefn % doing a typed function specifically? + % then check user option for putting return type on its own line: + \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else + \rettypeownlinetrue + \fi + \fi + % + % How we'll format the category name. Putting it in brackets helps % distinguish it from the body text that may end up on the next line % just below it. \def\temp{#1}% \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} % - % Figure out line sizes for the paragraph shape. + % Figure out line sizes for the paragraph shape. We'll always have at + % least two. + \tempnum = 2 + % % The first line needs space for \box0; but if \rightskip is nonzero, % we need only space for the part of \box0 which exceeds it: \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip + % + % If doing a return type on its own line, we'll have another line. + \ifrettypeownline + \advance\tempnum by 1 + \def\maybeshapeline{0in \hsize}% + \else + \def\maybeshapeline{}% + \fi + % % The continuations: \dimen2=\hsize \advance\dimen2 by -\defargsindent - % (plain.tex says that \dimen1 should be used only as global.) - \parshape 2 0in \dimen0 \defargsindent \dimen2 % - % Put the type name to the right margin. + % The final paragraph shape: + \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2 + % + % Put the category name at the right margin. \noindent \hbox to 0pt{% \hfil\box0 \kern-\hsize @@ -6675,8 +7063,16 @@ end % . this still does not fix the ?` and !` ligatures, but so far no % one has made identifiers using them :). \df \tt - \def\temp{#2}% return value type - \ifx\temp\empty\else \tclose{\temp} \fi + \def\temp{#2}% text of the return type + \ifx\temp\empty\else + \tclose{\temp}% typeset the return type + \ifrettypeownline + % put return type on its own line; prohibit line break following: + \hfil\vadjust{\nobreak}\break + \else + \space % type on same line, so just followed by a space + \fi + \fi % no return type #3% output function name }% {\rm\enskip}% hskip 0.5 em of \tenrm @@ -6696,7 +7092,10 @@ end \df \sl \hyphenchar\font=0 % % On the other hand, if an argument has two dashes (for instance), we - % want a way to get ttsl. Let's try @var for that. + % want a way to get ttsl. We used to recommend @var for that, so + % leave the code in, but it's strange for @var to lead to typewriter. + % Nowadays we recommend @code, since the difference between a ttsl hyphen + % and a tt hyphen is pretty tiny. @code also disables ?` !`. \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}% #1% \sl\hyphenchar\font=45 @@ -6794,7 +7193,7 @@ end % To do this right we need a feature of e-TeX, \scantokens, % which we arrange to emulate with a temporary file in ordinary TeX. -\ifx\eTeXversion\undefined +\ifx\eTeXversion\thisisundefined \newwrite\macscribble \def\scantokens#1{% \toks0={#1}% @@ -6805,25 +7204,30 @@ end } \fi -\def\scanmacro#1{% - \begingroup - \newlinechar`\^^M - \let\xeatspaces\eatspaces - % Undo catcode changes of \startcontents and \doprintindex - % When called from @insertcopying or (short)caption, we need active - % backslash to get it printed correctly. Previously, we had - % \catcode`\\=\other instead. We'll see whether a problem appears - % with macro expansion. --kasal, 19aug04 - \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ - % ... and \example - \spaceisspace - % - % Append \endinput to make sure that TeX does not see the ending newline. - % I've verified that it is necessary both for e-TeX and for ordinary TeX - % --kasal, 29nov03 - \scantokens{#1\endinput}% - \endgroup -} +\def\scanmacro#1{\begingroup + \newlinechar`\^^M + \let\xeatspaces\eatspaces + % + % Undo catcode changes of \startcontents and \doprintindex + % When called from @insertcopying or (short)caption, we need active + % backslash to get it printed correctly. Previously, we had + % \catcode`\\=\other instead. We'll see whether a problem appears + % with macro expansion. --kasal, 19aug04 + \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ + % + % ... and for \example: + \spaceisspace + % + % The \empty here causes a following catcode 5 newline to be eaten as + % part of reading whitespace after a control sequence. It does not + % eat a catcode 13 newline. There's no good way to handle the two + % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX + % would then have different behavior). See the Macro Details node in + % the manual for the workaround we recommend for macros and + % line-oriented commands. + % + \scantokens{#1\empty}% +\endgroup} \def\scanexp#1{% \edef\temp{\noexpand\scanmacro{#1}}% @@ -6877,17 +7281,18 @@ end % Macro bodies are absorbed as an argument in a context where % all characters are catcode 10, 11 or 12, except \ which is active -% (as in normal texinfo). It is necessary to change the definition of \. - +% (as in normal texinfo). It is necessary to change the definition of \ +% to recognize macro arguments; this is the job of \mbodybackslash. +% % Non-ASCII encodings make 8-bit characters active, so un-activate % them to avoid their expansion. Must do this non-globally, to % confine the change to the current group. - +% % It's necessary to have hard CRs when the macro is executed. This is -% done by making ^^M (\endlinechar) catcode 12 when reading the macro +% done by making ^^M (\endlinechar) catcode 12 when reading the macro % body, and then making it the \newlinechar in \scanmacro. - -\def\scanctxt{% +% +\def\scanctxt{% used as subroutine \catcode`\"=\other \catcode`\+=\other \catcode`\<=\other @@ -6900,13 +7305,13 @@ end \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi } -\def\scanargctxt{% +\def\scanargctxt{% used for copying and captions, not macros. \scanctxt \catcode`\\=\other \catcode`\^^M=\other } -\def\macrobodyctxt{% +\def\macrobodyctxt{% used for @macro definitions \scanctxt \catcode`\{=\other \catcode`\}=\other @@ -6914,32 +7319,56 @@ end \usembodybackslash } -\def\macroargctxt{% +\def\macroargctxt{% used when scanning invocations \scanctxt - \catcode`\\=\other + \catcode`\\=0 } +% why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes" +% for the single characters \ { }. Thus, we end up with the "commands" +% that would be written @\ @{ @} in a Texinfo document. +% +% We already have @{ and @}. For @\, we define it here, and only for +% this purpose, to produce a typewriter backslash (so, the @\ that we +% define for @math can't be used with @macro calls): +% +\def\\{\normalbackslash}% +% +% We would like to do this for \, too, since that is what makeinfo does. +% But it is not possible, because Texinfo already has a command @, for a +% cedilla accent. Documents must use @comma{} instead. +% +% \anythingelse will almost certainly be an error of some kind. + % \mbodybackslash is the definition of \ in @macro bodies. % It maps \foo\ => \csname macarg.foo\endcsname => #N % where N is the macro parameter number. % We define \csname macarg.\endcsname to be \realbackslash, so % \\ in macro replacement text gets you a backslash. - +% {\catcode`@=0 @catcode`@\=@active @gdef@usembodybackslash{@let\=@mbodybackslash} @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} } \expandafter\def\csname macarg.\endcsname{\realbackslash} +\def\margbackslash#1{\char`\#1 } + \def\macro{\recursivefalse\parsearg\macroxxx} \def\rmacro{\recursivetrue\parsearg\macroxxx} \def\macroxxx#1{% - \getargs{#1}% now \macname is the macname and \argl the arglist + \getargs{#1}% now \macname is the macname and \argl the arglist \ifx\argl\empty % no arguments - \paramno=0% + \paramno=0\relax \else \expandafter\parsemargdef \argl;% + \if\paramno>256\relax + \ifx\eTeXversion\thisisundefined + \errhelp = \EMsimple + \errmessage{You need eTeX to compile a file with macros with more than 256 arguments} + \fi + \fi \fi \if1\csname ismacro.\the\macname\endcsname \message{Warning: redefining \the\macname}% @@ -6986,46 +7415,269 @@ end % an opening brace, and that opening brace is not consumed. \def\getargs#1{\getargsxxx#1{}} \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} -\def\getmacname #1 #2\relax{\macname={#1}} +\def\getmacname#1 #2\relax{\macname={#1}} \def\getmacargs#1{\def\argl{#1}} +% For macro processing make @ a letter so that we can make Texinfo private macro names. +\edef\texiatcatcode{\the\catcode`\@} +\catcode `@=11\relax + % Parse the optional {params} list. Set up \paramno and \paramlist -% so \defmacro knows what to do. Define \macarg.blah for each blah -% in the params list, to be ##N where N is the position in that list. +% so \defmacro knows what to do. Define \macarg.BLAH for each BLAH +% in the params list to some hook where the argument si to be expanded. If +% there are less than 10 arguments that hook is to be replaced by ##N where N +% is the position in that list, that is to say the macro arguments are to be +% defined `a la TeX in the macro body. +% % That gets used by \mbodybackslash (above). - +% % We need to get `macro parameter char #' into several definitions. -% The technique used is stolen from LaTeX: let \hash be something +% The technique used is stolen from LaTeX: let \hash be something % unexpandable, insert that wherever you need a #, and then redefine % it to # just before using the token list produced. % % The same technique is used to protect \eatspaces till just before % the macro is used. - -\def\parsemargdef#1;{\paramno=0\def\paramlist{}% - \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} +% +% If there are 10 or more arguments, a different technique is used, where the +% hook remains in the body, and when macro is to be expanded the body is +% processed again to replace the arguments. +% +% In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the +% argument N value and then \edef the body (nothing else will expand because of +% the catcode regime underwhich the body was input). +% +% If you compile with TeX (not eTeX), and you have macros with 10 or more +% arguments, you need that no macro has more than 256 arguments, otherwise an +% error is produced. +\def\parsemargdef#1;{% + \paramno=0\def\paramlist{}% + \let\hash\relax + \let\xeatspaces\relax + \parsemargdefxxx#1,;,% + % In case that there are 10 or more arguments we parse again the arguments + % list to set new definitions for the \macarg.BLAH macros corresponding to + % each BLAH argument. It was anyhow needed to parse already once this list + % in order to count the arguments, and as macros with at most 9 arguments + % are by far more frequent than macro with 10 or more arguments, defining + % twice the \macarg.BLAH macros does not cost too much processing power. + \ifnum\paramno<10\relax\else + \paramno0\relax + \parsemmanyargdef@@#1,;,% 10 or more arguments + \fi +} \def\parsemargdefxxx#1,{% \if#1;\let\next=\relax \else \let\next=\parsemargdefxxx - \advance\paramno by 1% + \advance\paramno by 1 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname {\xeatspaces{\hash\the\paramno}}% \edef\paramlist{\paramlist\hash\the\paramno,}% \fi\next} +\def\parsemmanyargdef@@#1,{% + \if#1;\let\next=\relax + \else + \let\next=\parsemmanyargdef@@ + \edef\tempb{\eatspaces{#1}}% + \expandafter\def\expandafter\tempa + \expandafter{\csname macarg.\tempb\endcsname}% + % Note that we need some extra \noexpand\noexpand, this is because we + % don't want \the to be expanded in the \parsermacbody as it uses an + % \xdef . + \expandafter\edef\tempa + {\noexpand\noexpand\noexpand\the\toks\the\paramno}% + \advance\paramno by 1\relax + \fi\next} + % These two commands read recursive and nonrecursive macro bodies. % (They're different since rec and nonrec macros end differently.) +% +\catcode `\@\texiatcatcode \long\def\parsemacbody#1@end macro% {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% \long\def\parsermacbody#1@end rmacro% {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% +\catcode `\@=11\relax + +\let\endargs@\relax +\let\nil@\relax +\def\nilm@{\nil@}% +\long\def\nillm@{\nil@}% + +% This macro is expanded during the Texinfo macro expansion, not during its +% definition. It gets all the arguments values and assigns them to macros +% macarg.ARGNAME +% +% #1 is the macro name +% #2 is the list of argument names +% #3 is the list of argument values +\def\getargvals@#1#2#3{% + \def\macargdeflist@{}% + \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion. + \def\paramlist{#2,\nil@}% + \def\macroname{#1}% + \begingroup + \macroargctxt + \def\argvaluelist{#3,\nil@}% + \def\@tempa{#3}% + \ifx\@tempa\empty + \setemptyargvalues@ + \else + \getargvals@@ + \fi +} -% This defines the macro itself. There are six cases: recursive and -% nonrecursive macros of zero, one, and many arguments. +% +\def\getargvals@@{% + \ifx\paramlist\nilm@ + % Some sanity check needed here that \argvaluelist is also empty. + \ifx\argvaluelist\nillm@ + \else + \errhelp = \EMsimple + \errmessage{Too many arguments in macro `\macroname'!}% + \fi + \let\next\macargexpandinbody@ + \else + \ifx\argvaluelist\nillm@ + % No more arguments values passed to macro. Set remaining named-arg + % macros to empty. + \let\next\setemptyargvalues@ + \else + % pop current arg name into \@tempb + \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}% + \expandafter\@tempa\expandafter{\paramlist}% + % pop current argument value into \@tempc + \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}% + \expandafter\@tempa\expandafter{\argvaluelist}% + % Here \@tempb is the current arg name and \@tempc is the current arg value. + % First place the new argument macro definition into \@tempd + \expandafter\macname\expandafter{\@tempc}% + \expandafter\let\csname macarg.\@tempb\endcsname\relax + \expandafter\def\expandafter\@tempe\expandafter{% + \csname macarg.\@tempb\endcsname}% + \edef\@tempd{\long\def\@tempe{\the\macname}}% + \push@\@tempd\macargdeflist@ + \let\next\getargvals@@ + \fi + \fi + \next +} + +\def\push@#1#2{% + \expandafter\expandafter\expandafter\def + \expandafter\expandafter\expandafter#2% + \expandafter\expandafter\expandafter{% + \expandafter#1#2}% +} + +% Replace arguments by their values in the macro body, and place the result +% in macro \@tempa +\def\macvalstoargs@{% + % To do this we use the property that token registers that are \the'ed + % within an \edef expand only once. So we are going to place all argument + % values into respective token registers. + % + % First we save the token context, and initialize argument numbering. + \begingroup + \paramno0\relax + % Then, for each argument number #N, we place the corresponding argument + % value into a new token list register \toks#N + \expandafter\putargsintokens@\saveparamlist@,;,% + % Then, we expand the body so that argument are replaced by their + % values. The trick for values not to be expanded themselves is that they + % are within tokens and that tokens expand only once in an \edef . + \edef\@tempc{\csname mac.\macroname .body\endcsname}% + % Now we restore the token stack pointer to free the token list registers + % which we have used, but we make sure that expanded body is saved after + % group. + \expandafter + \endgroup + \expandafter\def\expandafter\@tempa\expandafter{\@tempc}% + } + +\def\macargexpandinbody@{% + %% Define the named-macro outside of this group and then close this group. + \expandafter + \endgroup + \macargdeflist@ + % First the replace in body the macro arguments by their values, the result + % is in \@tempa . + \macvalstoargs@ + % Then we point at the \norecurse or \gobble (for recursive) macro value + % with \@tempb . + \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname + % Depending on whether it is recursive or not, we need some tailing + % \egroup . + \ifx\@tempb\gobble + \let\@tempc\relax + \else + \let\@tempc\egroup + \fi + % And now we do the real job: + \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}% + \@tempd +} + +\def\putargsintokens@#1,{% + \if#1;\let\next\relax + \else + \let\next\putargsintokens@ + % First we allocate the new token list register, and give it a temporary + % alias \@tempb . + \toksdef\@tempb\the\paramno + % Then we place the argument value into that token list register. + \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname + \expandafter\@tempb\expandafter{\@tempa}% + \advance\paramno by 1\relax + \fi + \next +} + +% Save the token stack pointer into macro #1 +\def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}} +% Restore the token stack pointer from number in macro #1 +\def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax} +% newtoks that can be used non \outer . +\def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi} + +% Tailing missing arguments are set to empty +\def\setemptyargvalues@{% + \ifx\paramlist\nilm@ + \let\next\macargexpandinbody@ + \else + \expandafter\setemptyargvaluesparser@\paramlist\endargs@ + \let\next\setemptyargvalues@ + \fi + \next +} + +\def\setemptyargvaluesparser@#1,#2\endargs@{% + \expandafter\def\expandafter\@tempa\expandafter{% + \expandafter\def\csname macarg.#1\endcsname{}}% + \push@\@tempa\macargdeflist@ + \def\paramlist{#2}% +} + +% #1 is the element target macro +% #2 is the list macro +% #3,#4\endargs@ is the list value +\def\pop@#1#2#3,#4\endargs@{% + \def#1{#3}% + \def#2{#4}% +} +\long\def\longpop@#1#2#3,#4\endargs@{% + \long\def#1{#3}% + \long\def#2{#4}% +} + +% This defines a Texinfo @macro. There are eight cases: recursive and +% nonrecursive macros of zero, one, up to nine, and many arguments. % Much magic with \expandafter here. % \xdef is used so that macro definitions will survive the file % they're defined in; @include reads the file inside a group. +% \def\defmacro{% \let\hash=##% convert placeholders to macro parameter chars \ifrecursive @@ -7040,17 +7692,25 @@ end \expandafter\noexpand\csname\the\macname xxx\endcsname}% \expandafter\xdef\csname\the\macname xxx\endcsname##1{% \egroup\noexpand\scanmacro{\temp}}% - \else % many - \expandafter\xdef\csname\the\macname\endcsname{% - \bgroup\noexpand\macroargctxt - \noexpand\csname\the\macname xx\endcsname}% - \expandafter\xdef\csname\the\macname xx\endcsname##1{% - \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% - \expandafter\expandafter - \expandafter\xdef - \expandafter\expandafter - \csname\the\macname xxx\endcsname - \paramlist{\egroup\noexpand\scanmacro{\temp}}% + \else + \ifnum\paramno<10\relax % at most 9 + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \noexpand\csname\the\macname xx\endcsname}% + \expandafter\xdef\csname\the\macname xx\endcsname##1{% + \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% + \expandafter\expandafter + \expandafter\xdef + \expandafter\expandafter + \csname\the\macname xxx\endcsname + \paramlist{\egroup\noexpand\scanmacro{\temp}}% + \else % 10 or more + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\getargvals@{\the\macname}{\argl}% + }% + \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp + \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble + \fi \fi \else \ifcase\paramno @@ -7067,29 +7727,40 @@ end \egroup \noexpand\norecurse{\the\macname}% \noexpand\scanmacro{\temp}\egroup}% - \else % many - \expandafter\xdef\csname\the\macname\endcsname{% - \bgroup\noexpand\macroargctxt - \expandafter\noexpand\csname\the\macname xx\endcsname}% - \expandafter\xdef\csname\the\macname xx\endcsname##1{% - \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% - \expandafter\expandafter - \expandafter\xdef - \expandafter\expandafter - \csname\the\macname xxx\endcsname - \paramlist{% - \egroup - \noexpand\norecurse{\the\macname}% - \noexpand\scanmacro{\temp}\egroup}% + \else % at most 9 + \ifnum\paramno<10\relax + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \expandafter\noexpand\csname\the\macname xx\endcsname}% + \expandafter\xdef\csname\the\macname xx\endcsname##1{% + \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% + \expandafter\expandafter + \expandafter\xdef + \expandafter\expandafter + \csname\the\macname xxx\endcsname + \paramlist{% + \egroup + \noexpand\norecurse{\the\macname}% + \noexpand\scanmacro{\temp}\egroup}% + \else % 10 or more: + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\getargvals@{\the\macname}{\argl}% + }% + \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp + \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse + \fi \fi \fi} +\catcode `\@\texiatcatcode\relax + \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} % \braceorline decides whether the next nonwhitespace character is a % {. If so it reads up to the closing }, if not, it reads the whole % line. Whatever was read is then fed to the next control sequence -% as an argument (by \parsebrace or \parsearg) +% as an argument (by \parsebrace or \parsearg). +% \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} \def\braceorlinexxx{% \ifx\nchar\bgroup\else @@ -7099,7 +7770,8 @@ end % @alias. % We need some trickery to remove the optional spaces around the equal -% sign. Just make them active and then expand them all to nothing. +% sign. Make them active and then expand them all to nothing. +% \def\alias{\parseargusing\obeyspaces\aliasxxx} \def\aliasxxx #1{\aliasyyy#1\relax} \def\aliasyyy #1=#2\relax{% @@ -7120,7 +7792,8 @@ end % @inforef is relatively simple. \def\inforef #1{\inforefzzz #1,,,,**} -\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, +\def\inforefzzz #1,#2,#3,#4**{% + \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, node \samp{\ignorespaces#1{}}} % @node's only job in TeX is to define \lastnode, which is used in @@ -7181,11 +7854,32 @@ end \toks0 = \expandafter{\lastsection}% \immediate \writexrdef{title}{\the\toks0 }% \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. - \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout + \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout }% \fi } +% @xrefautosectiontitle on|off says whether @section(ing) names are used +% automatically in xrefs, if the third arg is not explicitly specified. +% This was provided as a "secret" @set xref-automatic-section-title +% variable, now it's official. +% +\parseargdef\xrefautomaticsectiontitle{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETxref-automatic-section-title\endcsname + = \empty + \else\ifx\temp\offword + \expandafter\let\csname SETxref-automatic-section-title\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @xrefautomaticsectiontitle value `\temp', + must be on|off}% + \fi\fi +} + +% % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is % the node name, #2 the name of the Info cross-reference, #3 the printed % node name, #4 the name of the Info file, #5 the name of the printed @@ -7194,26 +7888,41 @@ end \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} \def\ref#1{\xrefX[#1,,,,,,,]} +% +\newbox\toprefbox +\newbox\printedrefnamebox +\newbox\infofilenamebox +\newbox\printedmanualbox +% \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup \unsepspaces - \def\printedmanual{\ignorespaces #5}% + % + % Get args without leading/trailing spaces. \def\printedrefname{\ignorespaces #3}% - \setbox1=\hbox{\printedmanual\unskip}% - \setbox0=\hbox{\printedrefname\unskip}% - \ifdim \wd0 = 0pt + \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}% + % + \def\infofilename{\ignorespaces #4}% + \setbox\infofilenamebox = \hbox{\infofilename\unskip}% + % + \def\printedmanual{\ignorespaces #5}% + \setbox\printedmanualbox = \hbox{\printedmanual\unskip}% + % + % If the printed reference name (arg #3) was not explicitly given in + % the @xref, figure out what we want to use. + \ifdim \wd\printedrefnamebox = 0pt % No printed node name was explicitly given. - \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax - % Use the node name inside the square brackets. + \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax + % Not auto section-title: use node name inside the square brackets. \def\printedrefname{\ignorespaces #1}% \else - % Use the actual chapter/section title appear inside - % the square brackets. Use the real section title if we have it. - \ifdim \wd1 > 0pt - % It is in another manual, so we don't have it. + % Auto section-title: use chapter/section title inside + % the square brackets if we have it. + \ifdim \wd\printedmanualbox > 0pt + % It is in another manual, so we don't have it; use node name. \def\printedrefname{\ignorespaces #1}% \else \ifhavexrefs - % We know the real title if we have the xref values. + % We (should) know the real title if we have the xref values. \def\printedrefname{\refx{#1-title}{}}% \else % Otherwise just copy the Info node name. @@ -7227,13 +7936,20 @@ end \ifpdf {\indexnofonts \turnoffactive + \makevalueexpandable % This expands tokens, so do it after making catcode changes, so _ - % etc. don't get their TeX definitions. + % etc. don't get their TeX definitions. This ignores all spaces in + % #4, including (wrongly) those in the middle of the filename. \getfilename{#4}% % - % See comments at \activebackslashdouble. - {\activebackslashdouble \xdef\pdfxrefdest{#1}% - \backslashparens\pdfxrefdest}% + % This (wrongly) does not take account of leading or trailing + % spaces in #1, which should be ignored. + \edef\pdfxrefdest{#1}% + \ifx\pdfxrefdest\empty + \def\pdfxrefdest{Top}% no empty targets + \else + \txiescapepdf\pdfxrefdest % escape PDF special chars + \fi % \leavevmode \startlink attr{/Border [0 0 0]}% @@ -7260,29 +7976,42 @@ end \iffloat\Xthisreftitle % If the user specified the print name (third arg) to the ref, % print it instead of our usual "Figure 1.2". - \ifdim\wd0 = 0pt + \ifdim\wd\printedrefnamebox = 0pt \refx{#1-snt}{}% \else \printedrefname \fi % - % if the user also gave the printed manual name (fifth arg), append + % If the user also gave the printed manual name (fifth arg), append % "in MANUALNAME". - \ifdim \wd1 > 0pt + \ifdim \wd\printedmanualbox > 0pt \space \putwordin{} \cite{\printedmanual}% \fi \else % node/anchor (non-float) references. + % + % If we use \unhbox to print the node names, TeX does not insert + % empty discretionaries after hyphens, which means that it will not + % find a line break at a hyphen in a node names. Since some manuals + % are best written with fairly long node names, containing hyphens, + % this is a loss. Therefore, we give the text of the node name + % again, so it is as if TeX is seeing it for the first time. + % + \ifdim \wd\printedmanualbox > 0pt + % Cross-manual reference with a printed manual name. + % + \crossmanualxref{\cite{\printedmanual\unskip}}% + % + \else\ifdim \wd\infofilenamebox > 0pt + % Cross-manual reference with only an info filename (arg 4), no + % printed manual name (arg 5). This is essentially the same as + % the case above; we output the filename, since we have nothing else. + % + \crossmanualxref{\code{\infofilename\unskip}}% % - % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not - % insert empty discretionaries after hyphens, which means that it will - % not find a line break at a hyphen in a node names. Since some manuals - % are best written with fairly long node names, containing hyphens, this - % is a loss. Therefore, we give the text of the node name again, so it - % is as if TeX is seeing it for the first time. - \ifdim \wd1 > 0pt - \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}% \else + % Reference within this manual. + % % _ (for example) has to be the character _ for the purposes of the % control sequence corresponding to the node, but it has to expand % into the usual \leavevmode...\vrule stuff for purposes of @@ -7294,7 +8023,7 @@ end \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi }% - % output the `[mynode]' via a macro so it can be overridden. + % output the `[mynode]' via the macro below so it can be overridden. \xrefprintnodename\printedrefname % % But we always want a comma and a space: @@ -7302,11 +8031,37 @@ end % % output the `page 3'. \turnoffactive \putwordpage\tie\refx{#1-pg}{}% - \fi + \fi\fi \fi \endlink \endgroup} +% Output a cross-manual xref to #1. Used just above (twice). +% +% Only include the text "Section ``foo'' in" if the foo is neither +% missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply +% "see The Foo Manual", the idea being to refer to the whole manual. +% +% But, this being TeX, we can't easily compare our node name against the +% string "Top" while ignoring the possible spaces before and after in +% the input. By adding the arbitrary 7sp below, we make it much less +% likely that a real node name would have the same width as "Top" (e.g., +% in a monospaced font). Hopefully it will never happen in practice. +% +% For the same basic reason, we retypeset the "Top" at every +% reference, since the current font is indeterminate. +% +\def\crossmanualxref#1{% + \setbox\toprefbox = \hbox{Top\kern7sp}% + \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}% + \ifdim \wd2 > 7sp % nonempty? + \ifdim \wd2 = \wd\toprefbox \else % same as Top? + \putwordSection{} ``\printedrefname'' \putwordin{}\space + \fi + \fi + #1% +} + % This macro is called from \xrefX for the `[nodename]' part of xref % output. It's a separate macro only so it can be changed more easily, % since square brackets don't work well in some documents. Particularly @@ -7357,7 +8112,8 @@ end \angleleft un\-de\-fined\angleright \iflinks \ifhavexrefs - \message{\linenumber Undefined cross reference `#1'.}% + {\toks0 = {#1}% avoid expansion of possibly-complex value + \message{\linenumber Undefined cross reference `\the\toks0'.}}% \else \ifwarnedxrefs\else \global\warnedxrefstrue @@ -7521,7 +8277,7 @@ end % space to prevent strange expansion errors.) \def\supereject{\par\penalty -20000\footnoteno =0 } -% @footnotestyle is meaningful for info output only. +% @footnotestyle is meaningful for Info output only. \let\footnotestyle=\comment {\catcode `\@=11 @@ -7584,6 +8340,8 @@ end % expands into a box, it must come within the paragraph, lest it % provide a place where TeX can split the footnote. \footstrut + % + % Invoke rest of plain TeX footnote routine. \futurelet\next\fo@t } }%end \catcode `\@=11 @@ -7671,7 +8429,7 @@ end it from ftp://tug.org/tex/epsf.tex.} % \def\image#1{% - \ifx\epsfbox\undefined + \ifx\epsfbox\thisisundefined \ifwarnednoepsf \else \errhelp = \noepsfhelp \errmessage{epsf.tex not found, images will be ignored}% @@ -7687,7 +8445,7 @@ end % #2 is (optional) width, #3 is (optional) height. % #4 is (ignored optional) html alt text. % #5 is (ignored optional) extension. -% #6 is just the usual extra ignored arg for parsing this stuff. +% #6 is just the usual extra ignored arg for parsing stuff. \newif\ifimagevmode \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup \catcode`\^^M = 5 % in case we're inside an example @@ -7695,6 +8453,13 @@ end % If the image is by itself, center it. \ifvmode \imagevmodetrue + \else \ifx\centersub\centerV + % for @center @image, we need a vbox so we can have our vertical space + \imagevmodetrue + \vbox\bgroup % vbox has better behavior than vtop herev + \fi\fi + % + \ifimagevmode \nobreak\medskip % Usually we'll have text after the image which will insert % \parskip glue, so insert it here too to equalize the space @@ -7704,9 +8469,13 @@ end \fi % % Leave vertical mode so that indentation from an enclosing - % environment such as @quotation is respected. On the other hand, if - % it's at the top level, we don't want the normal paragraph indentation. - \noindent + % environment such as @quotation is respected. + % However, if we're at the top level, we don't want the + % normal paragraph indentation. + % On the other hand, if we are in the case of @center @image, we don't + % want to start a paragraph, which will create a hsize-width box and + % eradicate the centering. + \ifx\centersub\centerV\else \noindent \fi % % Output the image. \ifpdf @@ -7718,7 +8487,10 @@ end \epsfbox{#1.eps}% \fi % - \ifimagevmode \medskip \fi % space after the standalone image + \ifimagevmode + \medskip % space after a standalone image + \fi + \ifx\centersub\centerV \egroup \fi \endgroup} @@ -8136,7 +8908,7 @@ directory should work if nowhere else does.} % % Latin1 (ISO-8859-1) character definitions. \def\latonechardefs{% - \gdef^^a0{~} + \gdef^^a0{\tie} \gdef^^a1{\exclamdown} \gdef^^a2{\missingcharmsg{CENT SIGN}} \gdef^^a3{{\pounds}} @@ -8166,7 +8938,7 @@ directory should work if nowhere else does.} \gdef^^b9{$^1$} \gdef^^ba{\ordm} % - \gdef^^bb{\guilletright} + \gdef^^bb{\guillemetright} \gdef^^bc{$1\over4$} \gdef^^bd{$1\over2$} \gdef^^be{$3\over4$} @@ -8258,7 +9030,7 @@ directory should work if nowhere else does.} % Latin2 (ISO-8859-2) character definitions. \def\lattwochardefs{% - \gdef^^a0{~} + \gdef^^a0{\tie} \gdef^^a1{\ogonek{A}} \gdef^^a2{\u{}} \gdef^^a3{\L} @@ -8339,8 +9111,8 @@ directory should work if nowhere else does.} \gdef^^ea{\ogonek{e}} \gdef^^eb{\"e} \gdef^^ec{\v e} - \gdef^^ed{\'\i} - \gdef^^ee{\^\i} + \gdef^^ed{\'{\dotless{i}}} + \gdef^^ee{\^{\dotless{i}}} \gdef^^ef{\v d} % \gdef^^f0{\dh} @@ -8431,7 +9203,7 @@ directory should work if nowhere else does.} \gdef\DeclareUnicodeCharacter#1#2{% \countUTFz = "#1\relax - \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% + %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% \begingroup \parseXMLCharref \def\UTFviiiTwoOctets##1##2{% @@ -8899,8 +9671,8 @@ directory should work if nowhere else does.} % Prevent underfull vbox error messages. \vbadness = 10000 -% Don't be so finicky about underfull hboxes, either. -\hbadness = 2000 +% Don't be very finicky about underfull hboxes, either. +\hbadness = 6666 % Following George Bush, get rid of widows and orphans. \widowpenalty=10000 @@ -9107,28 +9879,21 @@ directory should work if nowhere else does.} \message{and turning on texinfo input format.} +\def^^L{\par} % remove \outer, so ^L can appear in an @comment + % DEL is a comment character, in case @c does not suffice. \catcode`\^^? = 14 % Define macros to output various characters with catcode for normal text. -\catcode`\"=\other -\catcode`\~=\other -\catcode`\^=\other -\catcode`\_=\other -\catcode`\|=\other -\catcode`\<=\other -\catcode`\>=\other -\catcode`\+=\other -\catcode`\$=\other -\def\normaldoublequote{"} -\def\normaltilde{~} -\def\normalcaret{^} -\def\normalunderscore{_} -\def\normalverticalbar{|} -\def\normalless{<} -\def\normalgreater{>} -\def\normalplus{+} -\def\normaldollar{$}%$ font-lock fix +\catcode`\"=\other \def\normaldoublequote{"} +\catcode`\$=\other \def\normaldollar{$}%$ font-lock fix +\catcode`\+=\other \def\normalplus{+} +\catcode`\<=\other \def\normalless{<} +\catcode`\>=\other \def\normalgreater{>} +\catcode`\^=\other \def\normalcaret{^} +\catcode`\_=\other \def\normalunderscore{_} +\catcode`\|=\other \def\normalverticalbar{|} +\catcode`\~=\other \def\normaltilde{~} % This macro is used to make a character print one way in \tt % (where it can probably be output as-is), and another way in other fonts, @@ -9206,34 +9971,48 @@ directory should work if nowhere else does.} % In texinfo, backslash is an active character; it prints the backslash % in fixed width font. -\catcode`\\=\active -@def@normalbackslash{{@tt@backslashcurfont}} +\catcode`\\=\active % @ for escape char from now on. + +% The story here is that in math mode, the \char of \backslashcurfont +% ends up printing the roman \ from the math symbol font (because \char +% in math mode uses the \mathcode, and plain.tex sets +% \mathcode`\\="026E). It seems better for @backslashchar{} to always +% print a typewriter backslash, hence we use an explicit \mathchar, +% which is the decimal equivalent of "715c (class 7, e.g., use \fam; +% ignored family value; char position "5C). We can't use " for the +% usual hex value because it has already been made active. +@def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}} +@let@backslashchar = @normalbackslash % @backslashchar{} is for user documents. + % On startup, @fixbackslash assigns: % @let \ = @normalbackslash - % \rawbackslash defines an active \ to do \backslashcurfont. % \otherbackslash defines an active \ to be a literal `\' character with -% catcode other. +% catcode other. We switch back and forth between these. @gdef@rawbackslash{@let\=@backslashcurfont} @gdef@otherbackslash{@let\=@realbackslash} % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of -% the literal character `\'. -% -@def@normalturnoffactive{% - @let\=@normalbackslash - @let"=@normaldoublequote - @let~=@normaltilde - @let^=@normalcaret - @let_=@normalunderscore - @let|=@normalverticalbar - @let<=@normalless - @let>=@normalgreater - @let+=@normalplus - @let$=@normaldollar %$ font-lock fix - @markupsetuplqdefault - @markupsetuprqdefault - @unsepspaces +% the literal character `\'. Also revert - to its normal character, in +% case the active - from code has slipped in. +% +{@catcode`- = @active + @gdef@normalturnoffactive{% + @let-=@normaldash + @let"=@normaldoublequote + @let$=@normaldollar %$ font-lock fix + @let+=@normalplus + @let<=@normalless + @let>=@normalgreater + @let\=@normalbackslash + @let^=@normalcaret + @let_=@normalunderscore + @let|=@normalverticalbar + @let~=@normaltilde + @markupsetuplqdefault + @markupsetuprqdefault + @unsepspaces + } } % Make _ and + \other characters, temporarily. @@ -9262,10 +10041,19 @@ directory should work if nowhere else does.} % Say @foo, not \foo, in error messages. @escapechar = `@@ +% These (along with & and #) are made active for url-breaking, so need +% active definitions as the normal characters. +@def@normaldot{.} +@def@normalquest{?} +@def@normalslash{/} + % These look ok in all fonts, so just make them not special. -@catcode`@& = @other -@catcode`@# = @other -@catcode`@% = @other +% @hashchar{} gets its own user-level command, because of #line. +@catcode`@& = @other @def@normalamp{&} +@catcode`@# = @other @def@normalhash{#} +@catcode`@% = @other @def@normalpercent{%} + +@let @hashchar = @normalhash @c Finally, make ` and ' active, so that txicodequoteundirected and @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we |