diff options
Diffstat (limited to 'doc')
56 files changed, 20950 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..15f35ee --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,7 @@ +if USE_COLOR +SUBDIRS = man syntax texinfo +else +SUBDIRS = man texinfo +endif + +EXTRA_DIST = faq.html diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..b30918f --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,562 @@ +# Makefile.in generated by automake 1.11.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. +# 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. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +target_triplet = @target@ +subdir = doc +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(srcdir)/nanorc.sample.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.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 \ + $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/progtest.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = nanorc.sample +CONFIG_CLEAN_VPATH_FILES = +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_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 \ + distdir +ETAGS = etags +CTAGS = ctags +DIST_SUBDIRS = man texinfo syntax +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +am__relativize = \ + dir0=`pwd`; \ + sed_first='s,^\([^/]*\)/.*$$,\1,'; \ + sed_rest='s,^[^/]*/*,,'; \ + sed_last='s,^.*/\([^/]*\)$$,\1,'; \ + sed_butlast='s,/*[^/]*$$,,'; \ + while test -n "$$dir1"; do \ + first=`echo "$$dir1" | sed -e "$$sed_first"`; \ + if test "$$first" != "."; then \ + if test "$$first" = ".."; then \ + dir2=`echo "$$dir0" | sed -e "$$sed_last"`/"$$dir2"; \ + dir0=`echo "$$dir0" | sed -e "$$sed_butlast"`; \ + else \ + first2=`echo "$$dir2" | sed -e "$$sed_first"`; \ + if test "$$first2" = "$$first"; then \ + dir2=`echo "$$dir2" | sed -e "$$sed_rest"`; \ + else \ + dir2="../$$dir2"; \ + fi; \ + dir0="$$dir0"/"$$first"; \ + fi; \ + fi; \ + dir1=`echo "$$dir1" | sed -e "$$sed_rest"`; \ + done; \ + reldir="$$dir2" +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CURSES_LIB = @CURSES_LIB@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GMSGFMT = @GMSGFMT@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTLLIBS = @INTLLIBS@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBINTL = @LIBINTL@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LN_S = @LN_S@ +LTLIBICONV = @LTLIBICONV@ +LTLIBINTL = @LTLIBINTL@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGMERGE = @MSGMERGE@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKGDATADIR = @PKGDATADIR@ +PKG_CONFIG = @PKG_CONFIG@ +POSUB = @POSUB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +XGETTEXT = @XGETTEXT@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +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 +all: all-recursive + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +nanorc.sample: $(top_builddir)/config.status $(srcdir)/nanorc.sample.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ + +# 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; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(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: $(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) + set x; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + 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; }; }'`; \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$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; }; }'`; \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + 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 \ + dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ + $(am__relativize); \ + new_distdir=$$reldir; \ + dir1=$$subdir; dir2="$(top_distdir)"; \ + $(am__relativize); \ + new_top_distdir=$$reldir; \ + echo " (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) top_distdir="$$new_top_distdir" distdir="$$new_distdir" \\"; \ + echo " am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)"; \ + ($(am__cd) $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$new_top_distdir" \ + distdir="$$new_distdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + am__skip_mode_fix=: \ + distdir) \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-recursive +all-am: Makefile +installdirs: installdirs-recursive +installdirs-am: +install: install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-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 +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-recursive + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-recursive + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-recursive + +dvi-am: + +html: html-recursive + +html-am: + +info: info-recursive + +info-am: + +install-data-am: + +install-dvi: install-dvi-recursive + +install-dvi-am: + +install-exec-am: + +install-html: install-html-recursive + +install-html-am: + +install-info: install-info-recursive + +install-info-am: + +install-man: + +install-pdf: install-pdf-recursive + +install-pdf-am: + +install-ps: install-ps-recursive + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-recursive + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-recursive + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-recursive + +pdf-am: + +ps: ps-recursive + +ps-am: + +uninstall-am: + +.MAKE: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) ctags-recursive \ + install-am install-strip tags-recursive + +.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 \ + 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 + + +# 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. +.NOEXPORT: diff --git a/doc/faq.html b/doc/faq.html new file mode 100644 index 0000000..70baba5 --- /dev/null +++ b/doc/faq.html @@ -0,0 +1,331 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <title>The GNU nano editor FAQ</title> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +</head> +<body text="#330000" bgcolor="#ffffff" link="#0000ef" vlink="#51188e" alink="#ff0000"> +<h1>The GNU nano editor FAQ</h1> +<h2>Table of Contents</h2> +<h2><a href="#1">1. General</a></h2> +<blockquote><p><a href="#1.1">1.1 About this FAQ</a><br> + <a href="#1.2">1.2. How do I contribute to it?</a><br> + <a href="#1.3">1.3. What is GNU nano?</a><br> + <a href="#1.4">1.4. What is the history behind nano?</a><br> + <a href="#1.5">1.5. Why the name change from TIP?</a><br> + <a href="#1.6">1.6. What is the current version of nano?</a><br> + <a href="#1.7">1.7. I want to read the manpage without having to download the program!</a></p></blockquote> +<h2><a href="#2">2. Where to get GNU nano.</a></h2> +<blockquote><p><a href="#2.1">2.1. FTP and WWW sites that carry nano.</a><br> + <a href="#2.2">2.2. RedHat and derivatives (.rpm) packages.</a><br> + <a href="#2.3">2.3. Debian (.deb) packages.</a><br> + <a href="#2.4">2.4. By subversion (for the brave).</a></p></blockquote> +<h2><a href="#3">3. Installation and Configuration</a></h2> +<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> + <a href="#3.8">3.8. Tell me more about this verbatim input stuff!</a><br> + <a href="#3.9">3.9. How do I make a .nanorc file that nano will read when I start it?</a></br> + <a href="#3.9.1">3.9.1. How about in Win32?</a></p></blockquote> +<h2><a href="#4">4. Running</a></h2> +<blockquote><p><a href="#4.1">4.1. How do I open a file with a name beginning with '+' from the command line?</a><br> + <a href="#4.2">4.2. Ack! My Backspace/Delete/Enter/Meta/double bucky key doesn't seem to work! What can I do?</a><br> + <a href="#4.3">4.3. Ack! My numeric keypad's keys don't work properly when NumLock is off! What can I do?</a><br> + <a href="#4.4">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?</a><br> + <a href="#4.5">4.5. How do I type the F13-F16 keys shown in the help browser? My keyboard only has F1-F12!</a><br> + <a href="#4.6">4.6. nano crashes when I type <insert keystroke here>!</a><br> + <a href="#4.7">4.7. nano crashes when I resize my window. How can I fix that?</a><br> + <a href="#4.8">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?</a><br> + <a href="#4.9">4.9. [version 1.1.12 and earlier] Why does nano show ^\ in the shortcut list instead of ^J?</a><br> + <a href="#4.10a">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?!</a><br> + <a href="#4.10b">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?</a><br> + <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> +<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> + <a href="#5.3">5.3. What is the status of Unicode support?</a></p></blockquote> +<h2><a href="#6">6. Advocacy and Licensing</a></h2> +<blockquote><p><a href="#6.1">6.1. Why should I use nano instead of Pico?</a><br> + <a href="#6.2">6.2. Why should I use Pico instead of nano?</a><br> + <a href="#6.3">6.3. What is so bad about the older Pine license?</a><br> + <a href="#6.4">6.4. Okay, well, what mail program should I use then?</a></p></blockquote> +<h2><a href="#7">7. Miscellaneous</a></h2> +<blockquote><p><a href="#7.1">7.1. nano-related mailing lists.</a><br> + <a href="#7.2">7.2. I want to send the development team a big load of cash (or just a thank you).</a><br> + <a href="#7.3">7.3. How do I submit a bug report or patch?</a><br> + <a href="#7.4">7.4. How do I join the development team?</a><br> + <a href="#7.5">7.5. Can I have write access to the subversion tree?</a></p></blockquote> +<h2><a href="#8">8. ChangeLog</a></h2> +<hr width="100%"> +<h1><a name="1"></a>1. General</h1> +<h2><a name="1.1"></a>1.1 About this FAQ</h2> +<blockquote><p>This FAQ was originally written and maintained by Chris Allegretta <<a href="mailto:chrisa@asty.org">chrisa@asty.org</a>>, who also happens to be the creator of nano. It was then maintained by David Lawrence Ramsey <<a href="mailto:pooka109@gmail.com">pooka109@gmail.com</a>>. Maybe someone else will volunteer to maintain this FAQ someday, who knows...</p></blockquote> +<h2><a name="1.2"></a>1.2. How do I contribute to it?</h2> +<blockquote><p>Your best bet is to send it to the nano email address, <a href="mailto:nano@nano-editor.org">nano@nano-editor.org</a> and if it is useful enough it will be included in future versions.</p></blockquote> +<h2><a name="1.3"></a>1.3. What is GNU nano?</h2> +<blockquote><p>GNU nano is designed to be a free replacement for the Pico text editor, part of the Pine email suite from <a href="http://www.washington.edu/pine/">The University of Washington</a>. It aims to "emulate Pico as closely as possible and perhaps include extra functionality".</p></blockquote> +<h2><a name="1.4"></a>1.4. What is the history behind nano?</h2> +<blockquote><p>Funny you should ask!</p> + <p><b>In the beginning...</b></p> + <p>For years Pine was THE program used to read email on a Unix system. The Pico text editor is the portion of the program one would use to compose his or her mail messages. Many beginners to Unix flocked to Pico and Pine because of their well organized, easy to use interfaces. With the proliferation of GNU/Linux in the mid to late 90's, many University students became intimately familiar with the strengths (and weaknesses) of Pine and Pico.</p> + <p><b>Then came Debian...</b></p> + <p>The <a href="http://www.debian.org/">Debian GNU/Linux</a> distribution, known for its strict standards in distributing truly "free" software (i.e. software with no restrictions on redistribution), would not include a binary package for Pine or Pico. Many people had a serious dilemma: they loved these programs, but the versions available at the time were not truly free software in the <a href="http://www.gnu.org/philosophy/free-sw.html">GNU</a> sense of the word.</p> + <p><b>The event...</b></p> + <p>It was in late 1999 when Chris Allegretta (our hero) was yet again complaining to himself about the less-than-perfect license Pico was distributed under, the 1000 makefiles that came with it and how just a few small improvements could make it the Best Editor in the World (TM). Having been a convert from Slackware to Debian, he missed having a simple binary package that included Pine and Pico, and had grown tired of downloading them himself.</p> + <p>Finally something snapped inside and Chris coded and hacked like a madman for many hours straight one weekend to make a (barely usable) Pico clone, at the time called TIP (Tip Isn't Pico). The program could not be invoked without a filename, could not save files, had no help text display, spell checker, and so forth. But over time it improved, and with the help of a few great coders it matured to the (hopefully) stable state it is today.</p> + <p>In February 2001, nano was declared an official GNU program by Richard Stallman. nano also reached its first production release on March 22, 2001.</p></blockquote> +<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> +<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%"> +<h1><a name="2"></a>2. Where to get GNU nano.</h1> +<h2><a name="2.1"></a>2.1. FTP and WWW sites that carry nano.</h2> +<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> +<h2><a name="2.2"></a>2.2. RedHat and derivatives (.rpm) packages.</h2> +<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> + </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> +<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%"> +<h1><a name="3"></a>3. Installation and Configuration</h1> +<h2><a name="3.1"></a>3.1. How do I install the RPM or DEB package?</h2> +<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>The average case is this:</p> + <p><b>cd nano-x.y.z/</b><br> + <b>./configure</b><br> + <b>make</b><br> + <b>make install</b> (as root, of course)</p></blockquote> +<h2><a name="3.3"></a>3.3. Why does everything go into /usr/local?</h2> +<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-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> +<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> + <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> +<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> +<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> +<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> + <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> +<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> +<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> +<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> +<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> +<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> +<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> +<blockquote><p>You need to make nano your $EDITOR. If you want this to be saved, you should put a line like this in your <b>.bashrc</b> if you use bash (or <b>.zshrc</b> if you believe in zsh):</p> + <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>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> + <p>Then exit (<b>E</b>) and select Yes (<b>Y</b>).</p> + <p>If you're a mutt user, you should see an effect immediately the next time you log in. No further configuration is needed. However, if you want to let people know you use nano to compose your email messages, you can put a line like this in your <b>.muttrc</b>:</p> + <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> +<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> +<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> +<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> +<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%"> +<h1><a name="6"></a>6. Advocacy and Licensing</h1> +<h2><a name="6.1"></a>6.1. Why should I use nano instead of Pico?</h2> +<blockquote><p>There are many reasons to use nano instead of Pico. A more complete list can be found at the <a href="http://www.nano-editor.org/">nano homepage</a>.</p></blockquote> +<h2><a name="6.2"></a>6.2. Why should I use Pico instead of nano?</h2> +<blockquote><p>Again, check out the <a href="http://www.nano-editor.org/">nano homepage</a> for a good summary of reasons. It really is a matter of personal preference as to which editor you should use. If you're the type of person who likes using the original version of a program, then Pico is the editor for you. If you don't mind sacrificing mailer integration with Pine, and are looking for a few more features, as well as a 'better' license in terms of adding your own changes, nano is the way to go.</p><p>Note that the last of these no longer applies to the new version of Pine, <a href="http://www.washington.edu/alpine/">Alpine</a>, which is under the Apache License, version 2.0.</p></blockquote> +<h2><a name="6.3"></a>6.3. What is so bad about the older Pine license?</h2> +<blockquote><p>The U of W license for older versions of Pine and Pico is not considered truly Free Software according to both the Free Software Foundation and the <a href="http://www.debian.org/social_contract#guidelines">Debian Free Software Guidelines</a>. The main problem regards the limitations on distributing derived works: according to UW, you can distribute their software, and you can modify it, but you can not do both, i.e. distribute modified binaries.</p></blockquote> +<h2><a name="6.4"></a>6.4. Okay, well, what mail program should I use then?</h2> +<blockquote><p>If you are looking to use a Free Software program similar to Pine, and Emacs is not your thing, you should definitely take a look at <a href="http://www.mutt.org/">mutt</a>. It is a full-screen, console based mail program that actually has a lot more flexibility than Pine, but has a keymap included in the distribution that allows you to use the same keystrokes as Pine would to send and receive mail. It's also under the GNU General Public License, version 2.0.<P> +Of course, due to the license change you can now use the <A HREF="http://www.washington.edu/alpine/">Alpine distribution</A> of PINE as it is now considered Free Software, but you would be sacrificing many of nano's features to do so.</p></blockquote> +<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> + <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> +<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>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> +<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> +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> +2007/12/09 - Add minor punctuation and wording fixes, and update various sections to account for Alpine. (DLR)<br> +2007/08/26 - Update links to the Free Translation Project. (DLR)<br> +2007/07/29 - Update RPM links for nano 2.0.x. (DLR)<br> +2007/04/18 - Add a new section 4.14 to explain how autoindent affects pasted text. (John M. Gabriele, minor tweaks by DLR)<br> +2007/04/04 - Update email address. (DLR)<br> +2007/01/01 - Update section 4.1 to describe how to open files with names beginning with '+' at specified columns as well as lines. (DLR)<br> +2006/11/25 - Add miscellaneous wording and capitalization fixes. (DLR)<br> +2006/10/28 - Update various links for the 2.0 branch of nano. (DLR)<br> +2006/10/06 - Update the question in section 4.13 to match the version of it in the answer section. (DLR)<br> +2006/07/25 - Update section 5.3 again to not state "the latest development version" before 1.3.12, as it's no longer accurate. Also add some minor spacing fixes. (DLR)<br> +2006/06/12 - Update section 5.3, due to the display fix for two-column Unicode characters. (DLR)<br> +2006/06/05 - Add a new section 4.8, and move all section 4 entries after it down one number, to explain how to deal with glibc 2.2.3's crashes involving extended regular expressions. (DLR)<br> +2006/06/04 - Add minor punctuation, wording, and typo fixes. (DLR)<br> +2006/05/27 - Update section 3.8 to mention the new "Unicode Input" prompt, and how Unicode input only works when Unicode support is enabled. (DLR)<br> +2006/05/12 - Remove section 4.4, and move all section 4 entries after it up one number, since it no longer applies. Meta-] and Meta-[ are no longer used to indent and unindent marked text, since they require that the bracket matching key change to Ctrl-], which is used as the telnet escape key (found by Chris). Also, make the link to the nano CVS page a bit more readable. (DLR)<br> +2006/05/08 - Add a new section 4.5, and move all section 4 entries after it down one number, to explain a problem that can occur when holding down keys to generate Meta sequences. Also add a few more capitalization and wording fixes. (Benno Schulenberg, minor tweaks by DLR)<br> +2006/05/01 - Add a new section 4.4, and move all section 4 entries after it down one number, to explain how to deal with problems typing Meta-[. Also add a few capitalization and wording fixes. (DLR)<br> +2006/04/14 - Clarify section 1.4: help menu -> help text display. (DLR, suggested by Benno Schulenberg)<br> +2006/03/16 - Update the Free Translation Project's address, change the character set to UTF-8, and remove broken links to contributed RedHat nano packages. (DLR)<br> +2005/11/21 - Clarify section 5.3 to better explain how to enable Unicode support, and remove the mention of quirks, since they turned out to not be a nano problem. (Mike Frysinger and DLR)<br> +2005/11/19 - Add a new section 5.3 to explain the status of nano's Unicode support. (Mike Frysinger, minor tweaks by DLR)<br> +2005/08/27 - Update email address. (DLR)<br> +2005/08/10 - Add a new section 4.3, and move all section 4 entries after it down one number, to explain how to deal with numeric keypad problems. (DLR)<br> +2005/08/08 - Update section 3.8 to mention that verbatim input mode now takes a six-digit hexadecimal number. (DLR)<br> +2005/07/04 - Update section 4.10 to mention that pasting from the X clipboard via the middle mouse button also works when the Shift key is used. (DLR)<br> +2005/06/15 - Update description of --enable-extra, and add missing line breaks. (DLR)<br> +2005/06/13 - Minor capitalization and wording fixes. (DLR)<br> +2005/06/08 - Updated section 1.1 to mention the current maintainer. (DLR)<br> +2005/03/09 - Added question about opening files with names beginning with '+'s, and added a few more miscellaneous cosmetic fixes. (DLR)<br> +2005/01/03 - Removed now-inaccurate note about verbatim input's not working at prompts, and update its description to mention that it handles hexadecimal values now. (DLR)<br> +2004/11/21 - Listed sh as an example of a Bourne shell. (DLR)<br> +2004/11/05 - Fixed inaccuracy: Pico compatibility mode was made the default in nano 1.1.99pre1, not 1.2.2. Also added question about how to type F13-F16 on terminals lacking keys past F12 (suggested by Chris), question about how to select text for the clipboard in X terminals with nano's mouse support turned on (answer found by Joseph Birthisel), and misc. fixes and link updates. (DLR)<br> +2004/04/07 - Removed NumLock glitch question, as it's no longer needed. (DLR)<br> +2004/01/30 - Fixed inaccuracy: multibuffer mode was first in nano 1.1.0, not 1.1.12. (DLR)<br> +2003/12/31 - Added question about the new verbatim input function, and a few minor fixes. Removed reference to "set pico" (DLR).<br> +2003/07/02 - Added question about nano's not showing color when it's compiled with color support (DLR; suggested by Jordi).<br> +2003/02/23 - Updated RPM links for nano 1.2.x (DLR).<br> +2003/01/16 - Split section 4.5 into 4.5a and 4.5b for search string behavior. Added --enable-all docs.<br> +2002/12/28 - More misc. fixes (David Benbennick, DLR).<br> +2002/10/25 - Misc. fixes and link updates (DLR).<br> +2002/09/10 - Another typo fix (DLR).<br> +2002/05/15 - Typo fix (DLR).<br> +2001/12/26 - Misc. fixes (Aaron S. Hawley, DLR).<br> +2001/10/02 - Update for Free Translation Project.<br> +2001/10/02 - Assorted fixes, Debian additions.<br> +2001/06/30 - Silly typo fix.<br> +2001/05/05 - Spelling fixes by David Lawrence Ramsey.<br> +2001/05/02 - Misc fixes.<br> +2001/03/26 - Typo fix in an URL.<br> +2001/02/17 - Advocacy updates.<br> +2001/02/15 - Added GNU notes for 0.9.99pre3.<br> +2001/02/06 - Typo fixes.<br> +2001/01/14 - Added note about NumLock glitch.<br> +2001/01/10 - Linux -> GNU/Linux.<br> +2001/01/09 - Added "making exe smaller" section.<br> +2000/12/19 - Typo and assorted error fixes.<br> +2000/11/28 - Added blurb about make install-strip.<br> +2000/11/19 - Changed Debian frozen to stable.<br> +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> +</body> +</html> diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 0000000..fbcdce8 --- /dev/null +++ b/doc/man/Makefile.am @@ -0,0 +1,35 @@ +if USE_NLS +SUBDIRS = fr +else +SUBDIRS = +endif + +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 + +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 + groff -t -mandoc -Thtml < $? > $@ +rnano.1.html: rnano.1 + groff -t -mandoc -Thtml < $? > $@ + +EXTRA_DIST = $(nano_man_mans) $(nano_built_sources) +else +EXTRA_DIST = $(nano_man_mans) +endif diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in new file mode 100644 index 0000000..a48d914 --- /dev/null +++ b/doc/man/Makefile.in @@ -0,0 +1,725 @@ +# Makefile.in generated by automake 1.11.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. +# 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. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +target_triplet = @target@ +subdir = doc/man +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.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 \ + $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/progtest.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +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 +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' +man1dir = $(mandir)/man1 +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" \ + "$(DESTDIR)$(htmlmandir)" +man5dir = $(mandir)/man5 +NROFF = nroff +MANS = $(man_MANS) +DATA = $(htmlman_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 \ + distdir +ETAGS = etags +CTAGS = ctags +DIST_SUBDIRS = fr +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +am__relativize = \ + dir0=`pwd`; \ + sed_first='s,^\([^/]*\)/.*$$,\1,'; \ + sed_rest='s,^[^/]*/*,,'; \ + sed_last='s,^.*/\([^/]*\)$$,\1,'; \ + sed_butlast='s,/*[^/]*$$,,'; \ + while test -n "$$dir1"; do \ + first=`echo "$$dir1" | sed -e "$$sed_first"`; \ + if test "$$first" != "."; then \ + if test "$$first" = ".."; then \ + dir2=`echo "$$dir0" | sed -e "$$sed_last"`/"$$dir2"; \ + dir0=`echo "$$dir0" | sed -e "$$sed_butlast"`; \ + else \ + first2=`echo "$$dir2" | sed -e "$$sed_first"`; \ + if test "$$first2" = "$$first"; then \ + dir2=`echo "$$dir2" | sed -e "$$sed_rest"`; \ + else \ + dir2="../$$dir2"; \ + fi; \ + dir0="$$dir0"/"$$first"; \ + fi; \ + fi; \ + dir1=`echo "$$dir1" | sed -e "$$sed_rest"`; \ + done; \ + reldir="$$dir2" +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CURSES_LIB = @CURSES_LIB@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GMSGFMT = @GMSGFMT@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTLLIBS = @INTLLIBS@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBINTL = @LIBINTL@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LN_S = @LN_S@ +LTLIBICONV = @LTLIBICONV@ +LTLIBINTL = @LTLIBINTL@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGMERGE = @MSGMERGE@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKGDATADIR = @PKGDATADIR@ +PKG_CONFIG = @PKG_CONFIG@ +POSUB = @POSUB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +XGETTEXT = @XGETTEXT@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +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) +all: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) all-recursive + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/man/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/man/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +install-man1: $(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'; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man1dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man1dir)" || exit $$?; }; \ + done; } + +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 | \ + 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) + @$(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'; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man5dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man5dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man5dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man5dir)" || exit $$?; }; \ + done; } + +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 | \ + 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) + @$(NORMAL_INSTALL) + test -z "$(htmlmandir)" || $(MKDIR_P) "$(DESTDIR)$(htmlmandir)" + @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || list=; \ + 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 $$?; \ + done + +uninstall-htmlmanDATA: + @$(NORMAL_UNINSTALL) + @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || 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 + +# 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; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(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: $(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) + set x; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + 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; }; }'`; \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$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; }; }'`; \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" + +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)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + 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 \ + dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ + $(am__relativize); \ + new_distdir=$$reldir; \ + dir1=$$subdir; dir2="$(top_distdir)"; \ + $(am__relativize); \ + new_top_distdir=$$reldir; \ + echo " (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) top_distdir="$$new_top_distdir" distdir="$$new_distdir" \\"; \ + echo " am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)"; \ + ($(am__cd) $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$new_top_distdir" \ + distdir="$$new_distdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + am__skip_mode_fix=: \ + distdir) \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) check-recursive +all-am: Makefile $(MANS) $(DATA) +installdirs: installdirs-recursive +installdirs-am: + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(htmlmandir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-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 +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -test -z "$(BUILT_SOURCES)" || rm -f $(BUILT_SOURCES) +clean: clean-recursive + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-recursive + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-recursive + +dvi-am: + +html: html-recursive + +html-am: + +info: info-recursive + +info-am: + +install-data-am: install-htmlmanDATA install-man + +install-dvi: install-dvi-recursive + +install-dvi-am: + +install-exec-am: + +install-html: install-html-recursive + +install-html-am: + +install-info: install-info-recursive + +install-info-am: + +install-man: install-man1 install-man5 + +install-pdf: install-pdf-recursive + +install-pdf-am: + +install-ps: install-ps-recursive + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-recursive + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-recursive + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-recursive + +pdf-am: + +ps: ps-recursive + +ps-am: + +uninstall-am: uninstall-htmlmanDATA 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 + +.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 \ + 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 < $? > $@ + +# 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. +.NOEXPORT: diff --git a/doc/man/fr/Makefile.am b/doc/man/fr/Makefile.am new file mode 100644 index 0000000..7a43052 --- /dev/null +++ b/doc/man/fr/Makefile.am @@ -0,0 +1,33 @@ +mandir = @mandir@/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 + +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 + +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 + groff -t -mandoc -Thtml < $? > $@ +rnano.1.html: rnano.1 + groff -t -mandoc -Thtml < $? > $@ + +EXTRA_DIST = $(nano_man_mans) $(nano_built_sources) +else +EXTRA_DIST = $(nano_man_mans) +endif + diff --git a/doc/man/fr/Makefile.in b/doc/man/fr/Makefile.in new file mode 100644 index 0000000..79d5987 --- /dev/null +++ b/doc/man/fr/Makefile.in @@ -0,0 +1,521 @@ +# Makefile.in generated by automake 1.11.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. +# 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. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +target_triplet = @target@ +subdir = doc/man/fr +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.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 \ + $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/progtest.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +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' +man1dir = $(mandir)/man1 +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" \ + "$(DESTDIR)$(htmlmandir)" +man5dir = $(mandir)/man5 +NROFF = nroff +MANS = $(man_MANS) +DATA = $(htmlman_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CURSES_LIB = @CURSES_LIB@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GMSGFMT = @GMSGFMT@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTLLIBS = @INTLLIBS@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBINTL = @LIBINTL@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LN_S = @LN_S@ +LTLIBICONV = @LTLIBICONV@ +LTLIBINTL = @LTLIBINTL@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGMERGE = @MSGMERGE@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKGDATADIR = @PKGDATADIR@ +PKG_CONFIG = @PKG_CONFIG@ +POSUB = @POSUB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +XGETTEXT = @XGETTEXT@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@/fr +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +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) +all: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/man/fr/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/man/fr/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +install-man1: $(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'; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man1dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man1dir)" || exit $$?; }; \ + done; } + +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 | \ + 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) + @$(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'; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man5dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man5dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man5dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man5dir)" || exit $$?; }; \ + done; } + +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 | \ + 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) + @$(NORMAL_INSTALL) + test -z "$(htmlmandir)" || $(MKDIR_P) "$(DESTDIR)$(htmlmandir)" + @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || list=; \ + 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 $$?; \ + done + +uninstall-htmlmanDATA: + @$(NORMAL_UNINSTALL) + @list='$(htmlman_DATA)'; test -n "$(htmlmandir)" || 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: + +ctags: CTAGS +CTAGS: + + +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)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) check-am +all-am: Makefile $(MANS) $(DATA) +installdirs: + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(htmlmandir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-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 +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -test -z "$(BUILT_SOURCES)" || rm -f $(BUILT_SOURCES) +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-htmlmanDATA install-man + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: install-man1 install-man5 + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-htmlmanDATA 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 \ + 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 \ + 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 < $? > $@ + +# 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. +.NOEXPORT: diff --git a/doc/man/fr/nano.1 b/doc/man/fr/nano.1 new file mode 100644 index 0000000..f840374 --- /dev/null +++ b/doc/man/fr/nano.1 @@ -0,0 +1,326 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" 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. +.\" 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, +.\" 2005, 2006 and 2007. The translated man page in itself is still +.\" subject to the copyright of its original authors. +.\" +.\" This document is dual-licensed. You may distribute and/or modify it +.\" under the terms of either of the following licenses: +.\" +.\" * The GNU General Public License, as published by the Free Software +.\" Foundation, version 3 or (at your option) any later version. You +.\" should have received a copy of the GNU General Public License +.\" along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and no +.\" Back-Cover Texts. You should have received a copy of the GNU Free +.\" Documentation License along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" 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 : +.\" +.\" * 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 +.\" Software Foundation, sans section invariante, ni texte de +.\" 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 $ +.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. +.\" + +.SH NOM +nano \- NAno un NOuvel éditeur, un clone libre et amélioré de Pico + +.SH SYNOPSIS +.B nano +.I [OPTIONS]\ [[\+LIGNE,COLONNE]\ FICHIER]... +.br + +.SH DESCRIPTION +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 +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. + +.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. +.TP +.B \-? +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 +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. +.TP +.B \-D (\-\-boldtext) +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. +.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 +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 +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 +utiliser les fichiers nanorc. +.TP +.B \-I (\-\-ignorercfiles) +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 +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. +.TP +.B \-L (\-\-nonewlines) +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 +DOS. +.TP +.B \-O (\-\-morespace) +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 +sera "\fI^([\ \\t]*[#:>\\|}])+\fP", sinon, ce sera "\fI>\ \fP". Dans +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 +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\ »). +.TP +.B \-S (\-\-smooth) +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 +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 +l'option \fB-c\fP prend le pas sur cette option. +.TP +.B \-V (\-\-version) +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. +.TP +.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 +disponible. +.TP +.B \-c (\-\-const) +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\ ». +.TP +.B \-h (\-\-help) +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. +.TP +.B \-k (\-\-cut) +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 +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 +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 +(\fIchroot\fR). +.TP +.B \-p (\-\-preserve) +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. +.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. +.TP +.B \-v (\-\-view) +Mode visualisation (lecture seule). +.TP +.B \-w (\-\-nowrap) +Désactive le passage automatique à la ligne. +.TP +.B \-x (\-\-nohelp) +Désactive la barre d'aide affichée en bas de l'écran. +.TP +.B \-z (\-\-suspend) +Autorise à suspendre l'éditeur. +.TP +.B \-a, \-b, \-e, \-f, \-g, \-j +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 +manuel de \fBnanorc(5)\fR et au fichier d'exemple \fInanorc.sample\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 +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. + +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 +nom du fichier en cours afin de le rendre unique (par exemple, +«\ .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. + +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\ ». + +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 "VOIR AUSSI" +.PD 0 +.TP +\fBnanorc\fR(5) +.PP +\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). + +.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 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. + +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 +consultable via la commande\ : + +LANGUAGE=en man nano diff --git a/doc/man/fr/nano.1.html b/doc/man/fr/nano.1.html new file mode 100644 index 0000000..e8f9548 --- /dev/null +++ b/doc/man/fr/nano.1.html @@ -0,0 +1,560 @@ +<!-- Creator : groff version 1.20.1 --> +<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>NANO</title> + +</head> +<body> + +<h1 align="center">NANO</h1> + +<a href="#NOM">NOM</a><br> +<a href="#SYNOPSIS">SYNOPSIS</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#OPTIONS">OPTIONS</a><br> +<a href="#FICHIERS D’INITIALISATION">FICHIERS D’INITIALISATION</a><br> +<a href="#NOTES">NOTES</a><br> +<a href="#BOGUES">BOGUES</a><br> +<a href="#SITE INTERNET">SITE INTERNET</a><br> +<a href="#VOIR AUSSI">VOIR AUSSI</a><br> +<a href="#AUTEUR">AUTEUR</a><br> +<a href="#TRADUCTION">TRADUCTION</a><br> + +<hr> + + +<h2>NOM +<a name="NOM"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">nano − +NAno un NOuvel éditeur, un clone libre et +amélioré de Pico</p> + +<h2>SYNOPSIS +<a name="SYNOPSIS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em"><b>nano</b> +<i>[OPTIONS] [[+LIGNE,COLONNE] FICHIER]...</i></p> + +<h2>DESCRIPTION +<a name="DESCRIPTION"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Cette page de +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> + +<h2>OPTIONS +<a name="OPTIONS"></a> +</h2> + + + +<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, +ligne 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="36%"> + + +<p>Identique à <b>-h (−−help)</b>.</p></td> +<td width="42%"> +</td></tr> +</table> + +<p style="margin-left:11%;"><b>−A +(−−smarthome)</b></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> + +<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: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:11%;"><b>−C</b> +<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:11%;"><b>−E +(−−tabstospaces)</b></p> + +<p style="margin-left:22%;">Convertit les tabulations +clavier en espaces.</p> + +<p style="margin-left:11%;"><b>−F +(−−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> + +<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:11%;"><b>−I +(−−ignorercfiles)</b></p> + +<p style="margin-left:22%;">Ne pas utiliser pas les +fichiers <i>SYSCONFDIR/nanorc</i> et <i>~/.nanorc</i> (si +<b>nano</b> est capable de les utiliser).</p> + +<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:11%;"><b>−L +(−−nonewlines)</b></p> + +<p style="margin-left:22%;">Ne pas ajouter de passage +à 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: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> + +<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>^([ \t]*[#:>\|}])+</i>", sinon, ce +sera "<i>> </i>". Dans l’expression +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> + +<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: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 +(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> + +<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> + +<p style="margin-left:11%;"><b>−V +(−−version)</b></p> + +<p style="margin-left:22%;">Affiche la version, puis +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:11%;"><b>−Y</b> +<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> + +<p style="margin-left:11%;"><b>−c +(−−const)</b></p> + +<p style="margin-left:22%;">Affiche en permanence la +position du curseur. Notez que cette option prend le pas sur +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 +l’effet de la touche +« 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: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> + +<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> + +<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> + +<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 +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>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: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:11%;"><b>−s</b> +<i>programme</i> +<b>(−−speller=</b><i>programme</i><b>)</b></p> + +<p style="margin-left:22%;">Choix d’un correcteur +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:11%;"><b>−v +(−−view)</b></p> + +<p style="margin-left:22%;">Mode visualisation (lecture +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: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:11%;"><b>−z +(−−suspend)</b></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> + +<h2>FICHIERS D’INITIALISATION +<a name="FICHIERS D’INITIALISATION"></a> +</h2> + + +<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> + +<h2>NOTES +<a name="NOTES"></a> +</h2> + + +<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> + +<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 +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> + +<h2>BOGUES +<a name="BOGUES"></a> +</h2> + + +<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, à +<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> + +<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> + + +<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 +<a name="SITE INTERNET"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em">http://www.nano-editor.org/</p> + +<h2>VOIR AUSSI +<a name="VOIR AUSSI"></a> +</h2> + + + +<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> + +<h2>AUTEUR +<a name="AUTEUR"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Chris +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 +d’autres).</p> + +<h2>TRADUCTION +<a name="TRADUCTION"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">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.</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> + +<p style="margin-left:11%; margin-top: 1em">La version +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> +<hr> +</body> +</html> diff --git a/doc/man/fr/nanorc.5 b/doc/man/fr/nanorc.5 new file mode 100644 index 0000000..0607045 --- /dev/null +++ b/doc/man/fr/nanorc.5 @@ -0,0 +1,376 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" 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. +.\" 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, +.\" 2005, 2006 and 2007. The translated man page in itself is still +.\" subject to the copyright of its original authors. +.\" +.\" This document is dual-licensed. You may distribute and/or modify it +.\" under the terms of either of the following licenses: +.\" +.\" * The GNU General Public License, as published by the Free Software +.\" Foundation, version 3 or (at your option) any later version. You +.\" should have received a copy of the GNU General Public License +.\" along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and no +.\" Back-Cover Texts. You should have received a copy of the GNU Free +.\" Documentation License along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" 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 : +.\" +.\" * 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 +.\" Software Foundation, sans section invariante, ni texte de +.\" 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 $ +.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. + +.SH NOM +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. +.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 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. +.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 +\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 +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 +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 +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. + +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. + +Les commandes et arguments reconnus sont\ : + +.TP 3 +.B set/unset autoindent +Active l'indentation automatique. +.TP +.B set/unset backup +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é. +.TP +.B set/unset backwards +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. +.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 +de crochets fermants, peuvent terminer une phrase. + +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. +.TP +.B set/unset const +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. +.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. +.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 +recherche ou d'un remplacement. +.TP +.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". +.TP +.B set/unset morespace +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 +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 set/unset multibuffer +Mode multi-espace\ : permet de charger les fichiers dans leur propre +espace. +.TP +.B set/unset noconvert +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. +.TP +.B set/unset nohelp +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. +.TP +.B set/unset nowrap +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. +.TP +.B set/unset preserve +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 +suivies de crochets fermants, peuvent terminer une phrase. La valeur par +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 +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. +.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 +"\fI^([\ \\t]*[#:>\\|}])+\fP", sinon, ce sera ">\ ". Notez que le +«\ \\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\ ». +.TP +.B set/unset rebindkeypad +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. +.TP +.B set/unset regexp +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 +ligne. +.TP +.B set/unset smooth +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. +.TP +.B set/unset suspend +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. +.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 +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. +.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. +.TP +.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. + +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 +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 +(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 +\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 +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 +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 +\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. +.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 +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 +que des commandes \fBsyntax\fP, \fBcolor\fP et \fBicolor\fP. + +.SH FICHIERS +.TP +.I $SYSCONFDIR/nanorc +Fichier de configuration général +.TP +.I ~/.nanorc +Fichier de configuration personnel + +.SH VOIR AUSSI +.PD 0 +.TP +\fBnano\fP(1) +.PP +\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). + +.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 +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. + +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 +consultable via la commande\ : + +LANGUAGE=en man nano diff --git a/doc/man/fr/nanorc.5.html b/doc/man/fr/nanorc.5.html new file mode 100644 index 0000000..e438be8 --- /dev/null +++ b/doc/man/fr/nanorc.5.html @@ -0,0 +1,590 @@ +<!-- Creator : groff version 1.20.1 --> +<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>NANORC</title> + +</head> +<body> + +<h1 align="center">NANORC</h1> + +<a href="#NOM">NOM</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#OPTIONS">OPTIONS</a><br> +<a href="#FICHIERS">FICHIERS</a><br> +<a href="#VOIR AUSSI">VOIR AUSSI</a><br> +<a href="#AUTEUR">AUTEUR</a><br> +<a href="#TRADUCTION">TRADUCTION</a><br> + +<hr> + + +<h2>NOM +<a name="NOM"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">nanorc − +fichier de configuration de l’éditeur nano du +projet GNU</p> + +<h2>DESCRIPTION +<a name="DESCRIPTION"></a> +</h2> + + +<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> + +<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> + +<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>.</p> + +<h2>OPTIONS +<a name="OPTIONS"></a> +</h2> + + +<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 +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> + +<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> + +<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> + +<p style="margin-left:11%; margin-top: 1em">Les commandes +et arguments reconnus sont : <b><br> +set/unset autoindent</b></p> + +<p style="margin-left:15%;">Active l’indentation +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 +<i>nom_du_fichier~</i>.</p> + +<p style="margin-left:11%;"><b>set backupdir</b> +<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: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: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:11%;"><b>set brackets</b> +<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%; margin-top: 1em">La valeur par +défaut de cette option est : +"<i>"’)>]}</i>".</p> + +<p style="margin-left:15%; margin-top: 1em">N.D.T. : +reportez-vous au paragraphe sur l’option <b>punct</b> +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 +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> + +<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: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: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> + +<p style="margin-left:11%;"><b>set matchbrackets</b> +<i>chaîne</i></p> + +<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 +"<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> + +<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 +d’utiliser la souris sous X Window ou en mode +console avec gpm.</p> + +<p style="margin-left:11%;"><b>set/unset +multibuffer</b></p> + +<p style="margin-left:15%;">Mode multi-espace : permet +de charger les fichiers dans leur propre espace.</p> + +<p style="margin-left:11%;"><b>set/unset noconvert</b></p> + +<p style="margin-left:15%;">Pas de conversion depuis les +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 +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:11%;"><b>set/unset nonewlines</b></p> + +<p style="margin-left:15%;">Ne pas ajouter de passage +à 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:11%;"><b>set operatingdir</b> +<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> + +<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: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> + +<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> + +<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> + +<p style="margin-left:11%;"><b>set quotestr</b> +<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 +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> + +<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: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:11%;"><b>set/unset regexp</b></p> + +<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> + +<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: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 +<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: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> + +<p style="margin-left:11%;"><b>set/unset +tabstospaces</b></p> + +<p style="margin-left:15%;">Convertit les tabulations +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:11%;"><b>set/unset view</b></p> + +<p style="margin-left:15%;">Interdit de modifier les +fichiers.</p> + +<p style="margin-left:11%;"><b>set whitespace</b> +<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: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:11%;"><b>syntax</b> +<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%; 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> + +<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> + +<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> + +<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>" +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 +<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> + +<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>" +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> + +<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>, +<b>color</b> et <b>icolor</b>.</p> + +<h2>FICHIERS +<a name="FICHIERS"></a> +</h2> + + + +<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> + +<p style="margin-left:11%;"><i>~/.nanorc</i></p> + +<p style="margin-left:22%;">Fichier de configuration +personnel</p> + +<h2>VOIR AUSSI +<a name="VOIR AUSSI"></a> +</h2> + + +<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> + +<h2>AUTEUR +<a name="AUTEUR"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Chris +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 +d’autres).</p> + +<h2>TRADUCTION +<a name="TRADUCTION"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">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 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> + +<p style="margin-left:11%; margin-top: 1em">La version +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> +<hr> +</body> +</html> diff --git a/doc/man/fr/rnano.1 b/doc/man/fr/rnano.1 new file mode 100644 index 0000000..2f64367 --- /dev/null +++ b/doc/man/fr/rnano.1 @@ -0,0 +1,154 @@ +.\" 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. +.\" +.\" 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 +.\" 2007. The translated man page in itself is still subject to the +.\" copyright of its original authors. +.\" +.\" This document is dual-licensed. You may distribute and/or modify it +.\" under the terms of either of the following licenses: +.\" +.\" * The GNU General Public License, as published by the Free Software +.\" Foundation, version 3 or (at your option) any later version. You +.\" should have received a copy of the GNU General Public License +.\" along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and no +.\" Back-Cover Texts. You should have received a copy of the GNU Free +.\" Documentation License along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" 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 : +.\" +.\" * 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 +.\" Software Foundation, sans section invariante, ni texte de +.\" 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 $ +.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. +.\" +.SH NOM +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]... +.br + +.SH DESCRIPTION +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 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.. +.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. +.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 +ligne de commande\ ; +.IP \[bu] +de lire un fichier nanorc\ ; +.IP \[bu] +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\ ; +.IP \[bu] +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. +.TP +.B \-? +Identique à \fB-h (\-\-help)\fP. +.TP +.B \-h (\-\-help) +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. +.PP +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. + +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\ ». + +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). + +.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 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 +traducteur. + +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 new file mode 100644 index 0000000..26c2d1b --- /dev/null +++ b/doc/man/fr/rnano.1.html @@ -0,0 +1,278 @@ +<!-- Creator : groff version 1.20.1 --> +<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>RNANO</title> + +</head> +<body> + +<h1 align="center">RNANO</h1> + +<a href="#NOM">NOM</a><br> +<a href="#SYNOPSIS">SYNOPSIS</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#OPTIONS">OPTIONS</a><br> +<a href="#BOGUES">BOGUES</a><br> +<a href="#SITE INTERNET">SITE INTERNET</a><br> +<a href="#AUTEUR">AUTEUR</a><br> +<a href="#TRADUCTION">TRADUCTION</a><br> + +<hr> + + +<h2>NOM +<a name="NOM"></a> +</h2> + + +<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> + +<h2>SYNOPSIS +<a name="SYNOPSIS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em"><b>rnano</b> +<i>[OPTIONS] [[+LIGNE,COLONNE] FICHIER]...</i></p> + +<h2>DESCRIPTION +<a name="DESCRIPTION"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Cette page de +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> + +<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> + +<p style="margin-left:11%; margin-top: 1em">En mode +restreint, <b>nano</b> refusera :</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="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<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> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>de lire un fichier nanorc ;</p></td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>de permettre de suspendre +l’édition ;</p> </td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<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> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>l’utilisation de copies de sécurité +ou de la correction orthographique.</p></td></tr> +</table> + +<h2>OPTIONS +<a name="OPTIONS"></a> +</h2> + + + +<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, +ligne 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="36%"> + + +<p>Identique à <b>-h (−−help)</b>.</p></td> +<td width="42%"> +</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:11%;"><b>−V +(−−version)</b></p> + +<p style="margin-left:22%;">Affiche la version, puis +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 +<b>nano</b>.</p> + +<h2>BOGUES +<a name="BOGUES"></a> +</h2> + + +<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, à +<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> + +<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> + + +<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 +<a name="SITE INTERNET"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em">http://www.nano-editor.org/</p> + +<h2>AUTEUR +<a name="AUTEUR"></a> +</h2> + + +<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> + +<h2>TRADUCTION +<a name="TRADUCTION"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">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).</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> + +<p style="margin-left:11%; margin-top: 1em">La version +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> +<hr> +</body> +</html> diff --git a/doc/man/nano.1 b/doc/man/nano.1 new file mode 100644 index 0000000..6921431 --- /dev/null +++ b/doc/man/nano.1 @@ -0,0 +1,262 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, +.\" 2008, 2009 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: +.\" +.\" * The GNU General Public License, as published by the Free Software +.\" Foundation, version 3 or (at your option) any later version. You +.\" should have received a copy of the GNU General Public License +.\" along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and no +.\" Back-Cover Texts. You should have received a copy of the GNU Free +.\" 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" +.\" Please adjust this date whenever revising the manpage. +.\" + +.SH NAME +nano \- Nano's ANOther editor, an enhanced free Pico clone + +.SH SYNOPSIS +.B nano +.I [OPTIONS]\ [[\+LINE,COLUMN]\ FILE]... +.br + +.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 +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 +(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 \-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) +When saving a file, back up the previous version of it to the current +filename suffixed with a ~. +.TP +.B \-C \fIdir\fP (\-\-backupdir=\fIdir\fP) +Set the directory where \fBnano\fP puts unique backup files if file +backups are enabled. +.TP +.B \-D (\-\-boldtext) +Use bold text instead of reverse video text. +.TP +.B \-E (\-\-tabstospaces) +Convert typed tabs to spaces. +.TP +.B \-F (\-\-multibuffer) +Enable multiple file buffers, if available. +.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. +.TP +.B \-I (\-\-ignorercfiles) +Don't look at \fISYSCONFDIR/nanorc\fP or \fI~/.nanorc\fP, if +\fInanorc\fP support is available. +.TP +.B \-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) +Don't add newlines to the ends of files. +.TP +.B \-N (\-\-noconvert) +Disable automatic conversion of files from DOS/Mac format. +.TP +.B \-O (\-\-morespace) +Use the blank line below the titlebar as extra editing space. +.TP +.B \-Q \fIstr\fP (\-\-quotestr=\fIstr\fP) +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 +Tab. +.TP +.B \-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) +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. +.TP +.B \-U (\-\-quickblank) +Do quick statusbar blanking. Statusbar messages will disappear after 1 +keystroke instead of 25. Note that \fB-c\fP overrides this. +.TP +.B \-V (\-\-version) +Show the current version number and exit. +.TP +.B \-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. +.TP +.B \-c (\-\-const) +Constantly show the cursor position. Note that this overrides \fB-U\fP. +.TP +.B \-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. +.TP +.B \-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. +.TP +.B \-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) +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. +.TP +.B \-o \fIdir\fP (\-\-operatingdir=\fIdir\fP) +Set operating directory. Makes \fBnano\fP set up something similar to a +chroot. +.TP +.B \-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 +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 +the wrap point to vary along with the width of the screen if the screen +is resized. The default value is \-8. +.TP +.B \-s \fIprog\fP (\-\-speller=\fIprog\fP) +Enable alternative spell checker command. +.TP +.B \-t (\-\-tempfile) +Always save 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. +.TP +.B \-w (\-\-nowrap) +Disable wrapping of long lines. +.TP +.B \-x (\-\-nohelp) +Disable help screen at bottom of editor. +.TP +.B \-z (\-\-suspend) +Enable 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 +\&'$' 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 \-$'). +.TP +.B \-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. + +.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 +\fBSPELL\fP environment variable for one. + +In some cases \fBnano\fP will try to dump the buffer into an emergency +file. This will happen mainly if \fBnano\fP receives a SIGHUP or +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 +it unique. In multibuffer mode, \fBnano\fP will write all the open +buffers to their respective emergency files. + +.SH BUGS +Please send any comments or bug reports to \fBnano@nano-editor.org\fP. + +The \fBnano\fP mailing list is available from \fBnano-devel@gnu.org\fP. + +To subscribe, email to \fBnano-devel-request@gnu.org\fP with a subject +of "subscribe". + +.SH HOMEPAGE +http://www.nano-editor.org/ + +.SH SEE ALSO +.PD 0 +.TP +\fBnanorc\fP(5) +.PP +\fI/usr/share/doc/nano/\fP (or equivalent on your system) + +.SH AUTHOR +Chris Allegretta <chrisa@asty.org>, et al (see \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 new file mode 100644 index 0000000..cb1101e --- /dev/null +++ b/doc/man/nano.1.html @@ -0,0 +1,468 @@ +<!-- Creator : groff version 1.20.1 --> +<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>NANO</title> + +</head> +<body> + +<h1 align="center">NANO</h1> + +<a href="#NAME">NAME</a><br> +<a href="#SYNOPSIS">SYNOPSIS</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#OPTIONS">OPTIONS</a><br> +<a href="#INITIALIZATION FILE">INITIALIZATION FILE</a><br> +<a href="#NOTES">NOTES</a><br> +<a href="#BUGS">BUGS</a><br> +<a href="#HOMEPAGE">HOMEPAGE</a><br> +<a href="#SEE ALSO">SEE ALSO</a><br> +<a href="#AUTHOR">AUTHOR</a><br> + +<hr> + + +<h2>NAME +<a name="NAME"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">nano − +Nano’s ANOther editor, an enhanced free Pico clone</p> + +<h2>SYNOPSIS +<a name="SYNOPSIS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em"><b>nano</b> +<i>[OPTIONS] [[+LINE,COLUMN] 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 +replace" and "go to line and column +number".</p> + +<h2>OPTIONS +<a name="OPTIONS"></a> +</h2> + + + +<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>−A +(−−smarthome)</b></p> + +<p style="margin-left:22%;">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.</p> + +<p style="margin-left:11%;"><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> + +<p style="margin-left:11%;"><b>−C</b> <i>dir</i> +<b>(−−backupdir=</b><i>dir</i><b>)</b></p> + +<p style="margin-left:22%;">Set the directory where +<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:22%;">Use bold text instead of +reverse video text.</p> + +<p style="margin-left:11%;"><b>−E +(−−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:22%;">Enable multiple file buffers, +if available.</p> + +<p style="margin-left:11%;"><b>−H +(−−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> + +<p style="margin-left:11%;"><b>−I +(−−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:11%;"><b>−K +(−−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: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: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: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:22%;">Set the quoting string for +justifying. The default is +"<i>^([ \t]*[#:>\|}])+</i>" if extended +regular expression support is available, or +"<i>> </i>" otherwise. Note that <i>\t</i> +stands for a Tab.</p> + +<p style="margin-left:11%;"><b>−R +(−−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> + +<p style="margin-left:11%;"><b>−S +(−−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:22%;">Set the size (width) of a tab +to <i>cols</i> columns. The value of <i>cols</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:22%;">Do quick statusbar blanking. +Statusbar messages will disappear after 1 keystroke instead +of 25. Note that <b>-c</b> overrides this.</p> + +<p style="margin-left:11%;"><b>−V +(−−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: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>−c +(−−const)</b></p> + +<p style="margin-left:22%;">Constantly show the cursor +position. Note that this overrides <b>-U</b>.</p> + +<p style="margin-left:11%;"><b>−d +(−−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:22%;">Show a summary of command line +options and exit.</p> + +<p style="margin-left:11%;"><b>−i +(−−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:22%;">Enable cut from cursor to end +of line.</p> + +<p style="margin-left:11%;"><b>−l +(−−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: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> + +<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>−p +(−−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:22%;">Do not report errors in the +<i>nanorc</i> file and 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, +allowing the wrap point to vary along with the width of the +screen if the screen is resized. The default value is +−8.</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:22%;">Enable alternative spell +checker command.</p> + +<p style="margin-left:11%;"><b>−t +(−−tempfile)</b></p> + +<p style="margin-left:22%;">Always save 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:22%;">View file (read only) mode.</p> + +<p style="margin-left:11%;"><b>−w +(−−nowrap)</b></p> + +<p style="margin-left:22%;">Disable wrapping of long +lines.</p> + +<p style="margin-left:11%;"><b>−x +(−−nohelp)</b></p> + +<p style="margin-left:22%;">Disable help screen at bottom +of editor.</p> + +<p style="margin-left:11%;"><b>−z +(−−suspend)</b></p> + +<p style="margin-left:22%;">Enable suspend ability.</p> + +<p style="margin-left:11%;"><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 +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:22%;">Ignored, for compatibility with +Pico.</p> + +<h2>INITIALIZATION FILE +<a name="INITIALIZATION FILE"></a> +</h2> + + +<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> + +<h2>NOTES +<a name="NOTES"></a> +</h2> + + +<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, +<b>nano</b> will check the <b>SPELL</b> environment variable +for one.</p> + +<p style="margin-left:11%; margin-top: 1em">In some cases +<b>nano</b> will try to dump the buffer into an emergency +file. This will happen mainly if <b>nano</b> receives a +SIGHUP or SIGTERM or runs out of memory. It will write the +buffer into a file named <i>nano.save</i> 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 it unique. In multibuffer mode, <b>nano</b> will write +all the open buffers to their respective emergency +files.</p> + +<h2>BUGS +<a name="BUGS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Please send any +comments or bug reports to <b>nano@nano-editor.org</b>.</p> + +<p style="margin-left:11%; margin-top: 1em">The <b>nano</b> +mailing list is available from +<b>nano-devel@gnu.org</b>.</p> + +<p style="margin-left:11%; margin-top: 1em">To subscribe, +email to <b>nano-devel-request@gnu.org</b> with a subject of +"subscribe".</p> + +<h2>HOMEPAGE +<a name="HOMEPAGE"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em">http://www.nano-editor.org/</p> + +<h2>SEE ALSO +<a name="SEE ALSO"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>nanorc</b>(5) +<i><br> +/usr/share/doc/nano/</i> (or equivalent on your system)</p> + +<h2>AUTHOR +<a name="AUTHOR"></a> +</h2> + + +<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/nanorc.5 b/doc/man/nanorc.5 new file mode 100644 index 0000000..3c69209 --- /dev/null +++ b/doc/man/nanorc.5 @@ -0,0 +1,567 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 +.\" 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: +.\" +.\" * The GNU General Public License, as published by the Free Software +.\" Foundation, version 3 or (at your option) any later version. You +.\" should have received a copy of the GNU General Public License +.\" along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and no +.\" Back-Cover Texts. You should have received a copy of the GNU Free +.\" 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" +.\" 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. + +.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. + +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 +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. + +The supported commands and arguments are: + +.TP 3 +.B set/unset 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. +.TP +.B set/unset autoindent +Use auto-indentation. +.TP +.B set/unset backup +Create backup files in \fIfilename~\fP. +.TP +.B set backupdir "\fIdirectory\fP" +Set the directory where \fBnano\fP puts unique backup files if file +backups are enabled. +.TP +.B set/unset backwards +Do backwards searches by default. +.TP +.B set/unset boldtext +Use bold text instead of reverse video text. +.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". +.TP +.B set/unset casesensitive +Do case sensitive searches by default. +.TP +.B set/unset const +Constantly display the cursor position in the status bar. +.TP +.B set/unset cut +Use cut to end of line by default. +.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. +.TP +.B set/unset historylog +Enable \fI~/.nano_history\fP for saving and reading search/replace +strings. +.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". +.TP +.B set/unset morespace +Use the blank line below the titlebar as extra editing space. +.TP +.B set/unset 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. +.TP +.B set/unset multibuffer +Allow inserting files into their own buffers. +.TP +.B set/unset noconvert +Don't convert files from DOS/Mac format. +.TP +.B set/unset 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. +.TP +.B set/unset nonewlines +Don't add newlines to the ends of files. +.TP +.B set/unset nowrap +Don't 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 +directory feature is turned off. +.TP +.B set/unset 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". +.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 +Do quick statusbar blanking. Statusbar messages will disappear after 1 +keystroke instead of 25. +.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 +Tab character. +.TP +.B set/unset 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 +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 +Do extended regular expression searches by default. +.TP +.B set/unset 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 +Use smooth scrolling by default. +.TP +.B set/unset softwrap +Enable soft line wrapping for easier viewing of very long lones. +.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 +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. +.TP +.B set/unset tabstospaces +Convert typed tabs to spaces. +.TP +.B set/unset tempfile +Save automatically on exit, don't prompt. +.TP +.B set/unset undo +Enable experimental generic-purpose undo code. +.TP +.B set/unset 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 +spaces. They must be single-column characters. +.TP +.B set/unset wordbounds +Detect word boundaries more accurately by treating punctuation +characters as parts of words. +.TP +.B syntax "\fIstr\fP" ["\fIfileregex\fP" ... ] +Defines a syntax named \fIstr\fP 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 +\fIfileregex\fP. All following \fBcolor\fP and \fBicolor\fP statements +will apply to \fIsyntax\fP 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 +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" ... +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 +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 +\fIbgcolor\fP tells \fBnano\fP to attempt to use a transparent +background. +.TP +.B icolor \fIfgcolor\fP,\fIbgcolor\fP "\fIregex\fP" ... +Same as above, except that the expression matching is case insensitive. +.TP +.B color \fIfgcolor\fP,\fIbgcolor\fP start="\fIsr\fP" end="\fIer\fP" +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, +at least one of which must be specified. This allows syntax +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" +Same as above, except that the expression matching is case insensitive. +.TP +.B include "\fIsyntaxfile\fP" +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 +Key bindings may be reassigned via the following commands: +.TP +.B bind \fIkey\fP \fIfunction\fP \fImenu\fP +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: +.TP +.B ^ +followed by an alpha character or the word "Space". +Example: ^C +.TP +.B M- +followed by a printable character or the word "Space". +Example: M-C +.TP +.B F +followed by a numeric value from 1 to 16. +Example: F10 +.TP +Valid function names to be bound include: +.TP 3 +.B help +Invoke the help menu. +.TP +.B cancel +Cancel the current command. +.TP +.B exit +Exit from the program. +.TP +.B writeout +Write the current buffer to disk. +.TP +.B justify +Justify the current text. +.TP +.B insert +Insert 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. +.TP +.B searchagain +Repeat 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. +.TP +.B cut +Cut the current line of text and store it. +.TP +.B uncut +Copy the currently stored text into the current buffer position. +.TP +.B curpos +Show the current line, column, word positions in the file. +.TP +.B firstline +Move to the first line of the file. +.TP +.B lastline +Move to the last line of the file. +.TP +.B gotoline +Move to a specific line (and column if specified). +.TP +.B replace +Interactively replace text within the current buffer. +.TP +.B mark +Begin selecting text for cutting or pasting at the current position. +.TP +.B copytext +Copy the currently marked text without deleting it. +.TP +.B indent +Indent the currently marked text (shift to the right). +.TP +.B unindent +Un-indent the currently marked text (shift to the left). +.TP +.B nextword +Move the cursor to the beginning of the next word. +.TP +.B prevword +Move the cursor to the beginning of the previous word. +.TP +.B home +Move the cursor to the beginning of the current line. +.TP +.B end +Move the cursor to the end of the current line. +.TP +.B beginpara +Move the cursor to the beginning of the current paragraph. +.TP +.B endpara +Move 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. +.TP +.B scrollup +Scroll up one line of text from the current position. +.TP +.B scrolldown +Scroll down one line of text from the current position. +.TP +.B prevbuf +Switch to editing/viewing the previous buffer when using multibuffer mode. +.TP +.B nextbuf +Switch to editing/viewing the next buffer when using multibuffer mode. +.TP +.B verbatim +Insert the next character verbatim into the file. +.TP +.B tab +Insert a tab at the current cursor location. +.TP +.B enter +Insert a new line below the current one. +.TP +.B delete +Delete 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. +.TP +.B undo +Undo the text action peformed (add text, delete text, etc). +.TP +.B redo +Redo the last undone action (i.e., undo an undo). +.TP +.B suspend +Suspend the editor (if the suspend function is enabled, see the +"suspendenable" entry below). +.TP +.B casesens +Toggle case sensitivity in searching (search/replace menus only). +.TP +.B regexp +Toggle whether searching/replacing is based on literal strings or regular expressions. +.TP +.B prevhistory +Show 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). +.TP +.B dontreplace +Switch back to searching instead of replacing. +.TP +.B gototext +Search for files matching a string in the file browser (reading or writing files). +.TP +.B dosformat +When writing a file, switch to writing a DOS format (CR/LF). +.TP +.B macformat +When writing a file, switch to writing a Mac format. +.TP +.B append +When writing a file, append to the end instead of overwriting. +.TP +.B prepend +When writing a file, 'prepend' (write at the beginning) instead of overwriting. +.TP +.B backup +When writing a file, create a backup of the current file. +.TP +.B firstfile +Move 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). +.TP +.B nohelp +Toggle showing/hiding the two-line list of key bindings at the bottom of the screen. +.TP +.B constupdate +Constantly display the current line, column, word positions. +.TP +.B morespace +Toggle showing/hiding the blank line which 'separates' the 'title' from the file text. +.TP +.B smoothscroll +Toggle smooth scrolling when moving via the arrow keys. +.TP +.B whitespacedisplay +Toggle whether whitespace is shown. +.TP +.B smarthome +Toggle whether the smart home key function is enabled. +.TP +.B autoindent +Toggle whether new lines will contain the same amount of whitespace as the line above. +.TP +.B cuttoend +Toggle 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. +.TP +.B suspendenable +Toggle whether the suspend sequence (normally ^Z) will suspend the editor window. +.TP + +Valid menu sections are: +.TP +.B main +The main editor window where text is entered. +.TP +.B search +The search menu (AKA whereis). +.TP +.B replace +The 'search to replace' menu. +.TP +.B replacewith +The 'replace with' menu, which comes up after 'search to replace'. +.TP +.B gotoline +The 'goto line (and column)' menu. +.TP +.B writeout +The 'write file' menu. +.TP +.B insert +The 'insert file' menu. +.TP +.B extcmd +The menu for inserting output from an external comman, reached from the insert menu. +.TP +.B help +The help menu. +.TP +.B spell +The interactive spell checker Yes/no menu. +.TP +.B browser +The file browser for inserting or writing a file. +.TP +.B whereisfile +The 'search for a file' menu in the file browser. +.TP +.B gotodir +The 'go to directory' menu. +.TP +.B all +A special name meaning: apply to all menus where this function exists. + +.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 +.TP +.I ~/.nanorc +Per-user configuration file +.SH SEE ALSO +.PD 0 +.TP +\fBnano\fP(1) +.PP +\fI/usr/share/doc/nano/examples/nanorc.sample\fP (or equivalent on your +system) +.SH AUTHOR +Chris Allegretta <chrisa@asty.org>, et al (see \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/nanorc.5.html b/doc/man/nanorc.5.html new file mode 100644 index 0000000..94e2b6d --- /dev/null +++ b/doc/man/nanorc.5.html @@ -0,0 +1,959 @@ +<!-- Creator : groff version 1.20.1 --> +<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>NANORC</title> + +</head> +<body> + +<h1 align="center">NANORC</h1> + +<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="#FILES">FILES</a><br> +<a href="#SEE ALSO">SEE ALSO</a><br> +<a href="#AUTHOR">AUTHOR</a><br> + +<hr> + + +<h2>NAME +<a name="NAME"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">nanorc − +GNU nano’s rcfile</p> + +<h2>DESCRIPTION +<a name="DESCRIPTION"></a> +</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> + +<h2>OPTIONS +<a name="OPTIONS"></a> +</h2> + + +<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> + +<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> + +<p style="margin-left:11%; margin-top: 1em">The supported +commands and arguments are: <b><br> +set/unset 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:15%;">Use auto-indentation.</p> + +<p style="margin-left:11%;"><b>set/unset backup</b></p> + +<p style="margin-left:15%;">Create backup files in +<i>filename~</i>.</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 +enabled.</p> + +<p style="margin-left:11%;"><b>set/unset 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:15%;">Use bold text instead of +reverse video text.</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> + +<p style="margin-left:11%;"><b>set/unset +casesensitive</b></p> + +<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: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:15%;">Use cut to end of line by +default.</p> + +<p style="margin-left:11%;"><b>set fill</b> <i>n</i></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/unset historylog</b></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 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> + +<p style="margin-left:11%;"><b>set/unset 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: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> + +<p style="margin-left:11%;"><b>set/unset +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: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:15%;">Don’t follow symlinks +when writing files.</p> + +<p style="margin-left:11%;"><b>set/unset 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:11%;"><b>set/unset nonewlines</b></p> + +<p style="margin-left:15%;">Don’t add newlines to the +ends of files.</p> + +<p style="margin-left:11%;"><b>set/unset nowrap</b></p> + +<p style="margin-left:15%;">Don’t wrap text at +all.</p> + +<p style="margin-left:11%;"><b>set operatingdir</b> +<i>directory</i></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 +directory feature is turned off.</p> + +<p style="margin-left:11%;"><b>set/unset preserve</b></p> + +<p style="margin-left:15%;">Preserve the XON and XOFF keys +(^Q and ^S).</p> + +<p style="margin-left:11%;"><b>set punct</b> +<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> + +<p style="margin-left:11%;"><b>set/unset 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 quotestr</b> +<i>string</i></p> + +<p style="margin-left:15%;">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 +"<i>^([ \t]*[#:>\|}])+</i>" if you have +extended regular expression support, or +"<i>> </i>" 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: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: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:15%;">Do extended regular expression +searches by default.</p> + +<p style="margin-left:11%;"><b>set/unset smarthome</b></p> + +<p style="margin-left:15%;">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.</p> + +<p style="margin-left:11%;"><b>set/unset 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:15%;">Enable soft line wrapping for +easier viewing of very long lones.</p> + +<p style="margin-left:11%;"><b>set speller</b> +<i>spellprog</i></p> + +<p style="margin-left:15%;">Use spelling checker +<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: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: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:11%;"><b>set/unset +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:15%;">Save automatically on exit, +don’t prompt.</p> + +<p style="margin-left:11%;"><b>set/unset undo</b></p> + +<p style="margin-left:15%;">Enable experimental +generic-purpose undo code.</p> + +<p style="margin-left:11%;"><b>set/unset 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> + +<p style="margin-left:11%;"><b>set/unset 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> + +<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> +syntax is reserved; specifying it on the command line is the +same as not having a syntax at all. The <i>default</i> +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>color</b> +<i>fgcolor</i><b>,</b><i>bgcolor regex</i> <b>...</b></p> + +<p style="margin-left:15%;">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> + +<p style="margin-left:11%;"><b>icolor</b> +<i>fgcolor</i><b>,</b><i>bgcolor regex</i> <b>...</b></p> + +<p style="margin-left:15%;">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> + +<p style="margin-left:15%;">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 +least one of which must be specified. This allows syntax +highlighting to span multiple lines. Note that all +subsequent instances of <i>sr</i> after an initial <i>sr</i> +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> + +<p style="margin-left:15%;">Same as above, except that the +expression matching is case insensitive.</p> + +<p style="margin-left:11%;"><b>include</b> +<i>syntaxfile</i></p> + +<p style="margin-left:15%;">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> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Key bindings +may be reassigned via the following commands: <b><br> +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> + +<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="78%"> + + +<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="3%"> + + +<p><b>M-</b></p></td> +<td width="8%"></td> +<td width="78%"> + + +<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="3%"> + + +<p><b>F</b></p></td> +<td width="8%"></td> +<td width="78%"> + + +<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%;"><b>cancel</b></p> + +<p style="margin-left:15%;">Cancel the current command.</p> + +<p style="margin-left:11%;"><b>exit</b></p> + +<p style="margin-left:15%;">Exit from the program.</p> + +<p style="margin-left:11%;"><b>writeout</b></p> + +<p style="margin-left:15%;">Write the current buffer to +disk.</p> + +<p style="margin-left:11%;"><b>justify</b></p> + +<p style="margin-left:15%;">Justify the current text.</p> + +<p style="margin-left:11%;"><b>insert</b></p> + +<p style="margin-left:15%;">Insert 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%;">Search for text in the current +buffer.</p> + +<p style="margin-left:11%;"><b>searchagain</b></p> + +<p style="margin-left:15%;">Repeat 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><b>up</b></p></td> +<td width="1%"></td> +<td width="51%"> + + +<p>Move up in the editor or browser.</p></td> +<td width="34%"> +</td></tr> +</table> + +<p style="margin-left:11%;"><b>down</b></p> + +<p style="margin-left:15%;">Move down in the editor or +browser.</p> + +<p style="margin-left:11%;"><b>left</b></p> + +<p style="margin-left:15%;">Move left in the editor or +browser.</p> + +<p style="margin-left:11%;"><b>right</b></p> + +<p style="margin-left:15%;">Move right in the editor or +browser.</p> + +<p style="margin-left:11%;"><b>cut</b></p> + +<p style="margin-left:15%;">Cut the current line of text +and store it.</p> + +<p style="margin-left:11%;"><b>uncut</b></p> + +<p style="margin-left:15%;">Copy the currently stored text +into the current buffer position.</p> + +<p style="margin-left:11%;"><b>curpos</b></p> + +<p style="margin-left:15%;">Show the current line, column, +word positions in the file.</p> + +<p style="margin-left:11%;"><b>firstline</b></p> + +<p style="margin-left:15%;">Move to the first line of the +file.</p> + +<p style="margin-left:11%;"><b>lastline</b></p> + +<p style="margin-left:15%;">Move to the last line of the +file.</p> + +<p style="margin-left:11%;"><b>gotoline</b></p> + +<p style="margin-left:15%;">Move to a specific line (and +column if specified).</p> + +<p style="margin-left:11%;"><b>replace</b></p> + +<p style="margin-left:15%;">Interactively replace text +within the current buffer.</p> + +<p style="margin-left:11%;"><b>mark</b></p> + +<p style="margin-left:15%;">Begin selecting text for +cutting or pasting at the current position.</p> + +<p style="margin-left:11%;"><b>copytext</b></p> + +<p style="margin-left:15%;">Copy the currently marked text +without deleting it.</p> + +<p style="margin-left:11%;"><b>indent</b></p> + +<p style="margin-left:15%;">Indent the currently marked +text (shift to the right).</p> + +<p style="margin-left:11%;"><b>unindent</b></p> + +<p style="margin-left:15%;">Un-indent the currently marked +text (shift to the left).</p> + +<p style="margin-left:11%;"><b>nextword</b></p> + +<p style="margin-left:15%;">Move the cursor to the +beginning of the next word.</p> + +<p style="margin-left:11%;"><b>prevword</b></p> + +<p style="margin-left:15%;">Move the cursor to the +beginning of the previous word.</p> + +<p style="margin-left:11%;"><b>home</b></p> + +<p style="margin-left:15%;">Move the cursor to the +beginning of the current line.</p> + +<p style="margin-left:11%;"><b>end</b></p> + +<p style="margin-left:15%;">Move the cursor to the end of +the current line.</p> + +<p style="margin-left:11%;"><b>beginpara</b></p> + +<p style="margin-left:15%;">Move the cursor to the +beginning of the current paragraph.</p> + +<p style="margin-left:11%;"><b>endpara</b></p> + +<p style="margin-left:15%;">Move the cursor to the end of +the current paragraph.</p> + +<p style="margin-left:11%;"><b>findbracket</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:11%;"><b>scrollup</b></p> + +<p style="margin-left:15%;">Scroll up one line of text from +the current position.</p> + +<p style="margin-left:11%;"><b>scrolldown</b></p> + +<p style="margin-left:15%;">Scroll down one line of text +from the current position.</p> + +<p style="margin-left:11%;"><b>prevbuf</b></p> + +<p style="margin-left:15%;">Switch 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%;">Switch 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%;">Insert the next character +verbatim into the file.</p> + +<p style="margin-left:11%;"><b>tab</b></p> + +<p style="margin-left:15%;">Insert a tab at the current +cursor location.</p> + +<p style="margin-left:11%;"><b>enter</b></p> + +<p style="margin-left:15%;">Insert a new line below the +current one.</p> + +<p style="margin-left:11%;"><b>delete</b></p> + +<p style="margin-left:15%;">Delete the character under the +cursor.</p> + +<p style="margin-left:11%;"><b>fulljustify</b></p> + +<p style="margin-left:15%;">Justify the entire current +file.</p> + +<p style="margin-left:11%;"><b>wordcount</b></p> + +<p style="margin-left:15%;">Count the number of words in +the current buffer.</p> + +<p style="margin-left:11%;"><b>refresh</b></p> + +<p style="margin-left:15%;">Refresh the screen.</p> + +<p style="margin-left:11%;"><b>undo</b></p> + +<p style="margin-left:15%;">Undo the text action peformed +(add text, delete text, etc).</p> + +<p style="margin-left:11%;"><b>redo</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 +"suspendenable" entry below).</p> + +<p style="margin-left:11%;"><b>casesens</b></p> + +<p style="margin-left:15%;">Toggle case sensitivity in +searching (search/replace menus only).</p> + +<p style="margin-left:11%;"><b>regexp</b></p> + +<p style="margin-left:15%;">Toggle 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%;">Show 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%;">Show 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%;">Switch back to searching +instead of replacing.</p> + +<p style="margin-left:11%;"><b>gototext</b></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:11%;"><b>dosformat</b></p> + +<p style="margin-left:15%;">When writing a file, switch to +writing a DOS format (CR/LF).</p> + +<p style="margin-left:11%;"><b>macformat</b></p> + +<p style="margin-left:15%;">When writing a file, switch to +writing a Mac format.</p> + +<p style="margin-left:11%;"><b>append</b></p> + +<p style="margin-left:15%;">When writing a file, append to +the end instead of overwriting.</p> + +<p style="margin-left:11%;"><b>prepend</b></p> + +<p style="margin-left:15%;">When writing a file, +’prepend’ (write at the beginning) instead of +overwriting.</p> + +<p style="margin-left:11%;"><b>backup</b></p> + +<p style="margin-left:15%;">When writing a file, create a +backup of the current file.</p> + +<p style="margin-left:11%;"><b>firstfile</b></p> + +<p style="margin-left:15%;">Move 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%;">Move 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%;">Toggle showing/hiding 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%;">Constantly display the current +line, column, word positions.</p> + +<p style="margin-left:11%;"><b>morespace</b></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:11%;"><b>smoothscroll</b></p> + +<p style="margin-left:15%;">Toggle smooth scrolling when +moving via the arrow keys.</p> + +<p style="margin-left:11%;"><b>whitespacedisplay</b></p> + +<p style="margin-left:15%;">Toggle whether whitespace is +shown.</p> + +<p style="margin-left:11%;"><b>smarthome</b></p> + +<p style="margin-left:15%;">Toggle whether the smart home +key function is enabled.</p> + +<p style="margin-left:11%;"><b>autoindent</b></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:11%;"><b>cuttoend</b></p> + +<p style="margin-left:15%;">Toggle 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%;">Toggle whether long lines will +be wrapped to the next line.</p> + +<p style="margin-left:11%;"><b>suspendenable</b></p> + +<p style="margin-left:15%;">Toggle 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:15%;">The main editor window where +text is entered.</p> + +<p style="margin-left:11%;"><b>search</b></p> + +<p style="margin-left:15%;">The search menu (AKA +whereis).</p> + +<p style="margin-left:11%;"><b>replace</b></p> + +<p style="margin-left:15%;">The ’search to +replace’ menu.</p> + +<p style="margin-left:11%;"><b>replacewith</b></p> + +<p style="margin-left:15%;">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%;">The ’goto line (and +column)’ menu.</p> + +<p style="margin-left:11%;"><b>writeout</b></p> + +<p style="margin-left:15%;">The ’write file’ +menu.</p> + +<p style="margin-left:11%;"><b>insert</b></p> + +<p style="margin-left:15%;">The ’insert file’ +menu.</p> + +<p style="margin-left:11%;"><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:11%;"><b>help</b></p> + +<p style="margin-left:15%;">The help menu.</p> + +<p style="margin-left:11%;"><b>spell</b></p> + +<p style="margin-left:15%;">The interactive spell checker +Yes/no menu.</p> + +<p style="margin-left:11%;"><b>browser</b></p> + +<p style="margin-left:15%;">The file browser for inserting +or writing a file.</p> + +<p style="margin-left:11%;"><b>whereisfile</b></p> + +<p style="margin-left:15%;">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:11%;"><b>all</b></p> + +<p style="margin-left:15%;">A special name meaning: apply +to all menus where this function exists.</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> + +<h2>FILES +<a name="FILES"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><i>SYSCONFDIR/nanorc</i></p> + +<p style="margin-left:22%;">System-wide configuration +file</p> + +<p style="margin-left:11%;"><i>~/.nanorc</i></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> + +<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> +<hr> +</body> +</html> diff --git a/doc/man/rnano.1 b/doc/man/rnano.1 new file mode 100644 index 0000000..6b8a9b8 --- /dev/null +++ b/doc/man/rnano.1 @@ -0,0 +1,98 @@ +.\" 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. +.\" +.\" This document is dual-licensed. You may distribute and/or modify it +.\" under the terms of either of the following licenses: +.\" +.\" * The GNU General Public License, as published by the Free Software +.\" Foundation, version 3 or (at your option) any later version. You +.\" should have received a copy of the GNU General Public License +.\" along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and no +.\" Back-Cover Texts. You should have received a copy of the GNU Free +.\" 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" +.\" Please adjust this date whenever revising the manpage. +.\" +.SH NAME +rnano \- Restricted mode for Nano's ANOther editor, an enhanced free +Pico clone + +.SH SYNOPSIS +.B rnano +.I [OPTIONS]\ [[\+LINE,COLUMN]\ FILE]... +.br + +.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 +missing (or disabled by default) features in Pico, such as "search and +replace" and "go to line and column number". +.PP +\fBrnano\fP is a restricted version of \fBnano\fP, which only edits +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: +.IP \[bu] 2 +read or write to any file not specified on the command line; +.IP \[bu] +read any nanorc files; +.IP \[bu] +allow suspending; +.IP \[bu] +allow a file to be appended to, prepended to, or saved under a different +name; +.IP \[bu] +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. +.TP +.B \-V (\-\-version) +Show the current version number and exit. +.PP +See the \fBnano\fP(1) manpage for the complete documentation of +\fBnano\fP. + +.SH BUGS +Please send any comments or bug reports to \fBnano@nano-editor.org\fP. + +The \fBnano\fP mailing list is available from \fBnano-devel@gnu.org\fP. + +To subscribe, email to \fBnano-devel-request@gnu.org\fP with a subject +of "subscribe". + +.SH HOMEPAGE +http://www.nano-editor.org/ + +.SH AUTHOR +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). diff --git a/doc/man/rnano.1.html b/doc/man/rnano.1.html new file mode 100644 index 0000000..5fc5991 --- /dev/null +++ b/doc/man/rnano.1.html @@ -0,0 +1,219 @@ +<!-- Creator : groff version 1.20.1 --> +<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>RNANO</title> + +</head> +<body> + +<h1 align="center">RNANO</h1> + +<a href="#NAME">NAME</a><br> +<a href="#SYNOPSIS">SYNOPSIS</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#OPTIONS">OPTIONS</a><br> +<a href="#BUGS">BUGS</a><br> +<a href="#HOMEPAGE">HOMEPAGE</a><br> +<a href="#AUTHOR">AUTHOR</a><br> + +<hr> + + +<h2>NAME +<a name="NAME"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">rnano − +Restricted mode for Nano’s ANOther editor, an enhanced +free Pico clone</p> + +<h2>SYNOPSIS +<a name="SYNOPSIS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em"><b>rnano</b> +<i>[OPTIONS] [[+LINE,COLUMN] 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 +replace" and "go to line and column +number".</p> + +<p style="margin-left:11%; margin-top: 1em"><b>rnano</b> is +a restricted version of <b>nano</b>, which only edits +specific files and doesn’t allow the user access to +the filesystem or a command shell.</p> + +<p style="margin-left:11%; margin-top: 1em">In restricted +mode, <b>nano</b> will <i>not</i>:</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="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>read or write to any file not specified on the command +line;</p> </td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>read any nanorc files;</p></td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>allow suspending;</p></td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>allow a file to be appended to, prepended to, or saved +under a different name;</p></td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="2%"></td> +<td width="86%"> + + +<p>use backup files or spell checking.</p></td></tr> +</table> + +<h2>OPTIONS +<a name="OPTIONS"></a> +</h2> + + + +<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: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: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> + +<h2>BUGS +<a name="BUGS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Please send any +comments or bug reports to <b>nano@nano-editor.org</b>.</p> + +<p style="margin-left:11%; margin-top: 1em">The <b>nano</b> +mailing list is available from +<b>nano-devel@gnu.org</b>.</p> + +<p style="margin-left:11%; margin-top: 1em">To subscribe, +email to <b>nano-devel-request@gnu.org</b> with a subject of +"subscribe".</p> + +<h2>HOMEPAGE +<a name="HOMEPAGE"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em">http://www.nano-editor.org/</p> + +<h2>AUTHOR +<a name="AUTHOR"></a> +</h2> + + +<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> +<hr> +</body> +</html> diff --git a/doc/nanorc.sample.in b/doc/nanorc.sample.in new file mode 100644 index 0000000..f164c26 --- /dev/null +++ b/doc/nanorc.sample.in @@ -0,0 +1,312 @@ +## Sample initialization file for GNU nano. +## +## Please note that you must have configured nano with --enable-nanorc +## for this file to be read! Also note that this file should not be in +## 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>". +## +## For the options that take parameters, the default value is given. +## Other options are unset by default. +## +## 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, ""')>]}" will match +## ", ', ), >, ], and }. + +## Use auto-indentation. +# set autoindent + +## Backup files to filename~. +# set backup + +## The directory to put unique backup files in. +# set backupdir "" + +## Do backwards searches by default. +# set backwards + +## Use bold text instead of reverse video text. +# set boldtext + +## 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. +## +# set brackets ""')>]}" + +## 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. +# 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. +## +# set fill -8 + +## Enable ~/.nano_history for saving and reading search/replace strings. +# set historylog + +## 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. +# set morespace + +## 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. +## +# 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. +## +# set multibuffer + +## Don't convert files from DOS/Mac format. +# set noconvert + +## Don't follow symlinks when writing files. +# set nofollow + +## Don't display the helpful shortcut lists at the bottom of the screen. +# set nohelp + +## Don't add newlines to the ends of files. +# set nonewlines + +## Don't wrap text at all. +# set nowrap + +## 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. +## +# set operatingdir "" + +## Preserve the XON and XOFF keys (^Q and ^S). +# set preserve + +## 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. +## +# 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: +# set quotestr "^([ ]*[#:>\|}])+" +## if you have extended regular expression support, otherwise: +# set quotestr "> " + +## Fix Backspace/Delete confusion problem. +# set rebinddelete + +## Fix numeric keypad key confusion problem. +# set rebindkeypad + +## Do extended regular expression searches by default. +# set regexp + +## 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. +# set smarthome + +## Use smooth scrolling as the default. +# set smooth + +## 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. +# set suspend + +## Use this tab size instead of the default; it must be greater than 0. +# set tabsize 8 + +## Convert typed tabs to spaces. +# set tabstospaces + +## 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 " " + +## Detect word boundaries more accurately by treating punctuation +## characters as parts of words. +# set wordbounds + + +## Color setup +## +## Format: +## +## syntax "short description" ["filename regex" ...] +## +## 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 filename regexes, and applies to files that +## don't match any other syntax's filename regexes. +## +## color foreground,background "regex" ["regex"...] +## or +## icolor foreground,background "regex" ["regex"...] +## +## "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 +## stronger highlight. +## +## To use multi-line regexes, use the start="regex" end="regex" +## [start="regex" end="regex"...] format. +## +## If your system supports transparency, not specifying a background +## 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: +## +## include "/path/to/syntax_file.nanorc" +## +## Unless otherwise noted, the name of the syntax file (without the +## ".nanorc" extension) should be the same as the "short description" +## 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. + +## Key bindings +## Please see nanorc(5) for more details on this +## +## Here are some 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" diff --git a/doc/syntax/Makefile.am b/doc/syntax/Makefile.am new file mode 100644 index 0000000..372ddb2 --- /dev/null +++ b/doc/syntax/Makefile.am @@ -0,0 +1,30 @@ +pkgdata_DATA = asm.nanorc \ + c.nanorc \ + cmake.nanorc \ + groff.nanorc \ + html.nanorc \ + java.nanorc \ + man.nanorc \ + mutt.nanorc \ + nanorc.nanorc \ + patch.nanorc \ + perl.nanorc \ + pov.nanorc \ + python.nanorc \ + ruby.nanorc \ + sh.nanorc \ + tex.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 + +EXTRA_DIST = $(pkgdata_DATA) diff --git a/doc/syntax/Makefile.in b/doc/syntax/Makefile.in new file mode 100644 index 0000000..90fe9eb --- /dev/null +++ b/doc/syntax/Makefile.in @@ -0,0 +1,432 @@ +# Makefile.in generated by automake 1.11.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. +# 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. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +target_triplet = @target@ +subdir = doc/syntax +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.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 \ + $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/progtest.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +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__installdirs = "$(DESTDIR)$(pkgdatadir)" +DATA = $(pkgdata_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CURSES_LIB = @CURSES_LIB@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GMSGFMT = @GMSGFMT@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTLLIBS = @INTLLIBS@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBINTL = @LIBINTL@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LN_S = @LN_S@ +LTLIBICONV = @LTLIBICONV@ +LTLIBINTL = @LTLIBINTL@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGMERGE = @MSGMERGE@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKGDATADIR = @PKGDATADIR@ +PKG_CONFIG = @PKG_CONFIG@ +POSUB = @POSUB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +XGETTEXT = @XGETTEXT@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +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 \ + cmake.nanorc \ + groff.nanorc \ + html.nanorc \ + java.nanorc \ + man.nanorc \ + mutt.nanorc \ + nanorc.nanorc \ + patch.nanorc \ + perl.nanorc \ + pov.nanorc \ + python.nanorc \ + ruby.nanorc \ + sh.nanorc \ + tex.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 + +EXTRA_DIST = $(pkgdata_DATA) +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/syntax/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/syntax/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +install-pkgdataDATA: $(pkgdata_DATA) + @$(NORMAL_INSTALL) + test -z "$(pkgdatadir)" || $(MKDIR_P) "$(DESTDIR)$(pkgdatadir)" + @list='$(pkgdata_DATA)'; test -n "$(pkgdatadir)" || list=; \ + 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)$(pkgdatadir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(pkgdatadir)" || exit $$?; \ + done + +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: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(DATA) +installdirs: + for dir in "$(DESTDIR)$(pkgdatadir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-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 +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-pkgdataDATA + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +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 + + +# 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. +.NOEXPORT: diff --git a/doc/syntax/asm.nanorc b/doc/syntax/asm.nanorc new file mode 100644 index 0000000..e94ee90 --- /dev/null +++ b/doc/syntax/asm.nanorc @@ -0,0 +1,17 @@ +## Here is an example for assembler. +## +syntax "asm" "\.(S|s|asm)$" +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) +color brightyellow "<[^= ]*>" ""(\\.|[^"])*"" +color brightyellow start=""(\\.|[^"])*\\[[:space:]]*$" end="^(\\.|[^"])*"" +## Highlight comments +color brightblue "//.*" +color brightblue start="/\*" end="\*/" +## Highlight trailing whitespace +color ,green "[[:space:]]+$" diff --git a/doc/syntax/awk.nanorc b/doc/syntax/awk.nanorc new file mode 100644 index 0000000..696ab6a --- /dev/null +++ b/doc/syntax/awk.nanorc @@ -0,0 +1,38 @@ +## Here is an example for awk. +## +syntax "awk" "\.awk$" +## records +icolor brightred "\$[0-9A-Z_!@#$*?-]+" +## 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 +color brightgreen "\<(function|extension|BEGIN|END)\>" +## operators +color green "(\{|\}|\(|\)|\;|\]|\[|\\|<|>|!|=|&|\+|-|\*|%|/|\?:|\^|\|)" +## flow control +color brightyellow "\<(for|if|while|do|else|in|delete|exit)\>" +color brightyellow "\<(break|continue|return)\>" +## I/O statements +color brightgreen "\<(close|getline|next|nextfile|print|printf)\>" +color brightgreen "\<(system|fflush)\>" +## 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)\>" +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. +color brightyellow "<[^= ]*>" ""(\\.|[^"])*"" + +## Comment highlighting +color brightblue "(^|[[:space:]])#.*$" + +## Trailing whitespace +color ,green "[[:space:]]+$" diff --git a/doc/syntax/c.nanorc b/doc/syntax/c.nanorc new file mode 100644 index 0000000..b89c9d2 --- /dev/null +++ b/doc/syntax/c.nanorc @@ -0,0 +1,30 @@ +## 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)\>" +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)\>" +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 +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. +color brightyellow "<[^= ]*>" ""(\\.|[^"])*"" +## +## This string is VERY resource intensive! +color brightyellow start=""(\\.|[^"])*\\[[:space:]]*$" end="^(\\.|[^"])*"" + +## Comment highlighting +color brightblue "//.*" +color brightblue start="/\*" end="\*/" + +## Trailing whitespace +color ,green "[[:space:]]+$" diff --git a/doc/syntax/cmake.nanorc b/doc/syntax/cmake.nanorc new file mode 100644 index 0000000..3c52f7d --- /dev/null +++ b/doc/syntax/cmake.nanorc @@ -0,0 +1,19 @@ +## CMake syntax highlighter for GNU Nano +## +syntax "cmake" "(CMakeLists\.txt|\.cmake)$" + +icolor green "^[[:space:]]*[A-Z0-9_]+" +icolor brightyellow "^[[:space:]]*(include|include_directories|include_external_msproject)\>" + +icolor brightgreen "^[[:space:]]*\<((else|end)?if|else|(end)?while|(end)?foreach|break)\>" +color brightgreen "\<(NOT|COMMAND|POLICY|TARGET|EXISTS|IS_(DIRECTORY|ABSOLUTE)|DEFINED)\>[[:space:]]" +color brightgreen "[[:space:]]\<(OR|AND|IS_NEWER_THAN|MATCHES|(STR|VERSION_)?(LESS|GREATER|EQUAL))\>[[:space:]]" + +icolor brightred "^[[:space:]]*\<((end)?(function|macro)|return)" + +icolor cyan start="\$(\{|ENV\{)" end="\}" +color magenta "\<(APPLE|UNIX|WIN32|CYGWIN|BORLAND|MINGW|MSVC(_IDE|60|71|80|90)?)\>" + +icolor brightblue "^([[:space:]]*)?#.*" +icolor brightblue "[[:space:]]#.*" +color ,green "[[:space:]]+$" diff --git a/doc/syntax/css.nanorc b/doc/syntax/css.nanorc new file mode 100644 index 0000000..98eea18 --- /dev/null +++ b/doc/syntax/css.nanorc @@ -0,0 +1,9 @@ +## Here is an example for css files. +## +syntax "css" "\.css$" +color brightred "." +color brightyellow start="\{" end="\}" +color brightwhite start=":" end="([;^\{]|$)" +color brightblue ":active|:focus|:hover|:link|:visited|:link|:after|:before|$" +color brightblue start="\/\*" end="\\*/" +color green ";|:|\{|\}" diff --git a/doc/syntax/debian.nanorc b/doc/syntax/debian.nanorc new file mode 100644 index 0000000..a945dee --- /dev/null +++ b/doc/syntax/debian.nanorc @@ -0,0 +1,20 @@ +## 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... +color brightgreen "cdrom:\[[-a-zA-Z0-9\._\(\) ]+\]/" +# deb / deb-src +color yellow "^deb" +color yellow "^deb-src" +# comments +color brightblue "#.*" + diff --git a/doc/syntax/fortran.nanorc b/doc/syntax/fortran.nanorc new file mode 100644 index 0000000..cc0c726 --- /dev/null +++ b/doc/syntax/fortran.nanorc @@ -0,0 +1,41 @@ +## Here is an example for Fortran 90/95 + +syntax "fortran" "\.(f|f90|f95)$" + +#color red "\<[A-Z_]a[0-9A-Z_]+\>" +color red "\<[0-9]+\>" + +icolor green "\<(action|advance|all|allocatable|allocated|any|apostrophe)\>" +icolor green "\<(append|asis|assign|assignment|associated|character|common)\>" +icolor green "\<(complex|data|default|delim|dimension|double precision)\>" +icolor green "\<(elemental|epsilon|external|file|fmt|form|format|huge)\>" +icolor green "\<(implicit|include|index|inquire|integer|intent|interface)\>" +icolor green "\<(intrinsic|iostat|kind|logical|module|none|null|only)>" +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 "\<(ubound|unpack|verify|write|tiny|type|use|yes)\>" + +icolor yellow "\<(.and.|case|do|else|else?if|else?where|end|end?do|end?if)\>" +icolor yellow "\<(end?select|.eqv.|forall|if|lge|lgt|lle|llt|.neqv.|.not.)\>" +icolor yellow "\<(.or.|repeat|select case|then|where|while)\>" + +icolor magenta "\<(continue|cycle|exit|go?to|result|return)\>" + +## String highlighting. +icolor yellow "<[^= ]*>" ""(\\.|[^"])*"" + +## Comment highlighting +icolor blue "!.*" + diff --git a/doc/syntax/gentoo.nanorc b/doc/syntax/gentoo.nanorc new file mode 100644 index 0000000..2ad1597 --- /dev/null +++ b/doc/syntax/gentoo.nanorc @@ -0,0 +1,55 @@ +## 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))" +## 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)\>" +## 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\>" +## 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 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 "\<(doc|ins|exe)?into\>" "\<(f|games)(owners|perms)\>" "\<(exe|ins|dir)opts\>" +## 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)\>" +## Highlight comments (doesnt work that well) +color yellow "(^|[[:space:]])#.*$" +## Highlight strings (doesnt work that well) +color brightyellow ""(\\.|[^\"])*"" "'(\\.|[^'])*'" +## Trailing space is bad! +color ,green "[[:space:]]+$" + +## Here is an example for Portage control files +## +syntax "/etc/portage" "\.(keywords|mask|unmask|use)(/.+)?$" +## Base text: +color green "^.+$" +## Use flags: +color brightred "[[:space:]]+\+?[a-zA-Z0-9_-]+" +color brightblue "[[:space:]]+-[a-zA-Z0-9_-]+" +## Likely version and slot numbers: +color magenta "-[[:digit:]].*([[:space:]]|$)" +color magenta ":[^[:space:]]+([[:space:]]|$)" +## Accepted arches: +color white "[~-]?\<(alpha|amd64|arm|hppa|ia64|mips|ppc|ppc64|s390|sh|sparc(-fbsd)?|x86(-fbsd)?)\>" +color white "[[:space:]][*~-]?\*" +## Categories: +color cyan "^[[:space:]]*.*/" +## Masking regulators: +color brightmagenta "^[[:space:]]*(=|~|<|<=|=<|>|>=|=>)" +## Comments: +color yellow "#.*$" diff --git a/doc/syntax/groff.nanorc b/doc/syntax/groff.nanorc new file mode 100644 index 0000000..02b82b8 --- /dev/null +++ b/doc/syntax/groff.nanorc @@ -0,0 +1,24 @@ +## Here is an example for groff. +## +syntax "groff" "\.m[ems]$" "\.rof" "\.tmac$" "^tmac." +## The argument of .ds or .nr +color cyan "^\.(ds|nr) [^[[:space:]]]*" +## Single character escapes +color brightmagenta "\\." +## Highlight the argument of \f or \s in the same color +color brightmagenta "\\f." "\\f\(.." "\\s(\+|\-)?[0-9]" +## Newlines +color cyan "(\\|\\\\)n(.|\(..)" +color cyan start="(\\|\\\\)n\[" end="]" +## Requests +color brightgreen "^\.[[:space:]]*[^[[:space:]]]*" +## Comments +color yellow "^\.\\".*$" +## Strings +color green "(\\|\\\\)\*(.|\(..)" +color green start="(\\|\\\\)\*\[" end="]" +## Characters +color brightred "\\\(.." +color brightred start="\\\[" end="]" +## Macro arguments +color brightcyan "\\\\\$[1-9]" diff --git a/doc/syntax/html.nanorc b/doc/syntax/html.nanorc new file mode 100644 index 0000000..d31467d --- /dev/null +++ b/doc/syntax/html.nanorc @@ -0,0 +1,5 @@ +## Here is a short example for HTML. +## +syntax "html" "\.html$" +color blue start="<" end=">" +color red "&[^;[[:space:]]]*;" diff --git a/doc/syntax/java.nanorc b/doc/syntax/java.nanorc new file mode 100644 index 0000000..a432f81 --- /dev/null +++ b/doc/syntax/java.nanorc @@ -0,0 +1,12 @@ +## Here is an example for Java. +## +syntax "java" "\.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 red ""[^"]*"" +color yellow "\<(true|false|null)\>" +color blue "//.*" +color blue start="/\*" end="\*/" +color brightblue start="/\*\*" end="\*/" +color ,green "[[:space:]]+$" diff --git a/doc/syntax/makefile.nanorc b/doc/syntax/makefile.nanorc new file mode 100644 index 0000000..93a1e76 --- /dev/null +++ b/doc/syntax/makefile.nanorc @@ -0,0 +1,8 @@ +# unattributed syntax highlighting example from wiki.linuxhelp.net/ + +syntax "makefile" "Makefile[^/]*$" +color red "[:=]" +color magenta "\<(if|ifeq|else|endif)\>" +color blue "\$+[{(][a-zA-Z0-9_-]+[})]" +color brightblue "^[^ ]+:" +color green "#.*$" diff --git a/doc/syntax/man.nanorc b/doc/syntax/man.nanorc new file mode 100644 index 0000000..85efd26 --- /dev/null +++ b/doc/syntax/man.nanorc @@ -0,0 +1,9 @@ +## 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)" diff --git a/doc/syntax/mgp.nanorc b/doc/syntax/mgp.nanorc new file mode 100644 index 0000000..daba282 --- /dev/null +++ b/doc/syntax/mgp.nanorc @@ -0,0 +1,8 @@ +## Here is an example for Magicpoint presentations +## +syntax "mgp" "\.mgp$" +header "^%include.*" +icolor green "^%[a-z].*$" +color cyan "(^|[[:space:]])#.*$" +color cyan "(^|[[:space:]])%%.*$" +color ,green "[[:space:]]+$" diff --git a/doc/syntax/mutt.nanorc b/doc/syntax/mutt.nanorc new file mode 100644 index 0000000..2e68399 --- /dev/null +++ b/doc/syntax/mutt.nanorc @@ -0,0 +1,4 @@ +## Here is an example for quoted emails (under e.g. mutt). +## +syntax "mutt" +color green "^>.*" diff --git a/doc/syntax/nanorc.nanorc b/doc/syntax/nanorc.nanorc new file mode 100644 index 0000000..19ab533 --- /dev/null +++ b/doc/syntax/nanorc.nanorc @@ -0,0 +1,16 @@ +## 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 +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 +icolor brightblue "^[[:space:]]*#.*$" +icolor cyan "^[[:space:]]*##.*$" diff --git a/doc/syntax/objc.nanorc b/doc/syntax/objc.nanorc new file mode 100644 index 0000000..cdf6e48 --- /dev/null +++ b/doc/syntax/objc.nanorc @@ -0,0 +1,41 @@ +## Here is an example for C/C++/Obj-C. +## +syntax "m" "\.m$" + + +## 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)\>" +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 +color cyan "__attribute__[[:space:]]*\(\([^)]*\)\)" "__(aligned|asm|builtin|hidden|inline|packed|restrict|section|typeof|weak)__" + +## 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. +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! +## color brightyellow start=""(\\.|[^"])*\\[[:space:]]*$" end="^(\\.|[^"])*"" + +color brightblue "^[[:space:]]*#[[:space:]]*(define|include|import|(un|ifn?)def|endif|el(if|se)|if|warning|error)" + +## Comment highlighting +color yellow "//.*" +color yellow start="/\*" end="\*/" + diff --git a/doc/syntax/ocaml.nanorc b/doc/syntax/ocaml.nanorc new file mode 100644 index 0000000..fc71ae2 --- /dev/null +++ b/doc/syntax/ocaml.nanorc @@ -0,0 +1,27 @@ +# OCaml sample nanorc +# +syntax "ocaml" "\.mli?$" +#uid +color red "\<[A-Z][0-9a-z_]{2,}\>" +#declarations +color green "\<(let|val|method|in|and|rec|private|virtual|constraint)\>" +#structure items +color red "\<(type|open|class|module|exception|external)\>" +#patterns +color blue "\<(fun|function|functor|match|try|with)\>" +#patterns-modifiers +color yellow "\<(as|when|of)\>" +#conditions +color cyan "\<(if|then|else)\>" +#blocs +color magenta "\<(begin|end|object|struct|sig|for|while|do|done|to|downto)\>" +#constantes +color green "\<(true|false)\>" +#modules/classes +color green "\<(include|inherit|initializer)\>" +#expr modifiers +color yellow "\<(new|ref|mutable|lazy|assert|raise)\>" +#comments +color white start="\(\*" end="\*\)" +#strings (no multiline handling yet) +color brightblack ""[^\"]*"" diff --git a/doc/syntax/patch.nanorc b/doc/syntax/patch.nanorc new file mode 100644 index 0000000..a788b35 --- /dev/null +++ b/doc/syntax/patch.nanorc @@ -0,0 +1,10 @@ +## Here is an example for patch files. +## +syntax "patch" "\.(patch|diff)$" +color brightgreen "^\+.*" +color green "^\+\+\+.*" +color brightblue "^ .*" +color brightred "^-.*" +color red "^---.*" +color brightyellow "^@@.*" +color magenta "^diff.*" diff --git a/doc/syntax/perl.nanorc b/doc/syntax/perl.nanorc new file mode 100644 index 0000000..b5a5606 --- /dev/null +++ b/doc/syntax/perl.nanorc @@ -0,0 +1,12 @@ +## Here is an example for Perl. +## +syntax "perl" "\.p[lm]$" +header "^#!.*/perl[-0-9._]*" +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_]|-)" +color yellow "".*"|qq\|.*\|" +color white "[sm]/.*/" +color white start="(^use| = new)" end=";" +color green "#.*" +color yellow start="<< 'STOP'" end="STOP" diff --git a/doc/syntax/php.nanorc b/doc/syntax/php.nanorc new file mode 100644 index 0000000..8ef495f --- /dev/null +++ b/doc/syntax/php.nanorc @@ -0,0 +1,30 @@ +## Here is an example for PHP +## +syntax "php" "\.php[2345s~]?$" + +## php markings +color brightgreen "(<\?(php)?|\?>)" + +## functions +color white "\<[a-z_]*\(" + +## types +color green "\<(var|float|global|double|bool|char|int|enum|const)\>" + +## structure +color brightyellow "\<(class|new|private|public|function|for|foreach|if|while|do|else|elseif|case|default|switch)\>" + +## control flow +color magenta "\<(goto|continue|break|return)\>" + +## strings +color brightyellow "<[^= ]*>" ""(\.|[^"])*"" + +## comments +color brightblue "//.*" +color brightblue start="/\*" end="\*/" +#color blue start="<" end=">" +#color red "&[^;[[:space:]]]*;" + +## Trailing whitespace +color ,green "[[:space:]]+$" diff --git a/doc/syntax/pov.nanorc b/doc/syntax/pov.nanorc new file mode 100644 index 0000000..298b201 --- /dev/null +++ b/doc/syntax/pov.nanorc @@ -0,0 +1,15 @@ +## 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)\>" +color brightyellow "\<(fog_type|fog_offset|fog_alt|rgb|distance|transform)\>" +color brightred "^\<(texture)\>" +color brightred "\<(light_source|background)\>" +color brightred "\<(fog|object|camera)\>" +color green "(\{|\}|\(|\)|\;|\]|\[|`|\\|\$|<|>|!|=|&|\|)" +color brightmagenta "\<(union|group|subgroup)\>" +## Comment highlighting +color brightblue "//.*" +color brightblue start="/\*" end="\*/" diff --git a/doc/syntax/python.nanorc b/doc/syntax/python.nanorc new file mode 100644 index 0000000..4280274 --- /dev/null +++ b/doc/syntax/python.nanorc @@ -0,0 +1,10 @@ +## Here is an example for Python. +## +syntax "python" "\.py$" +header "^#!.*/python[-0-9._]*" +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)\>" +color brightgreen "['][^']*[^\\][']" "[']{3}.*[^\\][']{3}" +color brightgreen "["][^"]*[^\\]["]" "["]{3}.*[^\\]["]{3}" +color brightgreen start=""""[^"]" end=""""" start="'''[^']" end="'''" +color brightred "#.*$" diff --git a/doc/syntax/ruby.nanorc b/doc/syntax/ruby.nanorc new file mode 100644 index 0000000..b30b229 --- /dev/null +++ b/doc/syntax/ruby.nanorc @@ -0,0 +1,31 @@ +## 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 +color brightblue "(\$|@|@@)?\<[A-Z]+[0-9A-Z_a-z]*" +## Ruby "symbols" +icolor magenta "([ ]|^):[0-9A-Z_]+\>" +## Some unique things we want to stand out +color brightyellow "\<(__FILE__|__LINE__)\>" +## 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). +color brightblue "`[^`]*`" "%x\{[^}]*\}" +## Strings, double-quoted +color green ""([^"]|(\\"))*"" "%[QW]?\{[^}]*\}" "%[QW]?\([^)]*\)" "%[QW]?<[^>]*>" "%[QW]?\[[^]]*\]" "%[QW]?\$[^$]*\$" "%[QW]?\^[^^]*\^" "%[QW]?![^!]*!" +## Expression substitution. These go inside double-quoted strings, +## "like #{this}". +color brightgreen "#\{[^}]*\}" +## Strings, single-quoted +color green "'([^']|(\\'))*'" "%[qw]\{[^}]*\}" "%[qw]\([^)]*\)" "%[qw]<[^>]*>" "%[qw]\[[^]]*\]" "%[qw]\$[^$]*\$" "%[qw]\^[^^]*\^" "%[qw]![^!]*!" +## Comments +color cyan "#[^{].*$" "#$" +color brightcyan "##[^{].*$" "##$" +## "Here" docs +color green start="<<-?'?EOT'?" end="^EOT" +## Some common markers +color brightcyan "(XXX|TODO|FIXME|\?\?\?)" diff --git a/doc/syntax/sh.nanorc b/doc/syntax/sh.nanorc new file mode 100644 index 0000000..ecce22e --- /dev/null +++ b/doc/syntax/sh.nanorc @@ -0,0 +1,14 @@ +## Here is an example for Bourne shell scripts. +## +syntax "sh" "\.sh$" +header "^#!.*/(ba|k|pdk)?sh[-0-9_]*" +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 "-[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 cyan "(^|[[:space:]])#.*$" +color brightyellow ""(\\.|[^"])*"" "'(\\.|[^'])*'" +color ,green "[[:space:]]+$" diff --git a/doc/syntax/tcl.nanorc b/doc/syntax/tcl.nanorc new file mode 100644 index 0000000..ad3401f --- /dev/null +++ b/doc/syntax/tcl.nanorc @@ -0,0 +1,16 @@ +syntax "tcl" "\.tcl$" + +## 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. +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] +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. +color brightblue "proc[[:space:]]" "(\{|\})" +color green "(\(|\)|\;|`|\\|\$|<|>|!|=|&|\|)" +color brightyellow ""(\\.|[^"])*"" "'(\\.|[^'])*'" +icolor brightred "\$\{?[0-9A-Z_!@#$*?-]+\}?" +color ,green "[[:space:]]+$" +color ,magenta "^[[:space:]]*#.*" diff --git a/doc/syntax/tex.nanorc b/doc/syntax/tex.nanorc new file mode 100644 index 0000000..23ca3a4 --- /dev/null +++ b/doc/syntax/tex.nanorc @@ -0,0 +1,6 @@ +## Here is a short example for TeX files. +## +syntax "tex" "\.tex$" +icolor green "\\.|\\[A-Z]*" +color magenta "[{}]" +color blue "(^|[^\])%.*" diff --git a/doc/syntax/xml.nanorc b/doc/syntax/xml.nanorc new file mode 100644 index 0000000..1f68c05 --- /dev/null +++ b/doc/syntax/xml.nanorc @@ -0,0 +1,9 @@ +## Here is an example for xml files. +## +syntax "xml" "\.([jrs]html?|sgml?|xml|xslt?)$" +color green start="<" end=">" +color cyan "<[^> ]+" +color cyan ">" +color yellow start="<!DOCTYPE" end="[/]?>" +color yellow start="<!--" end="-->" +color red "&[^;]*;" diff --git a/doc/texinfo/Makefile.am b/doc/texinfo/Makefile.am new file mode 100644 index 0000000..91f0163 --- /dev/null +++ b/doc/texinfo/Makefile.am @@ -0,0 +1,10 @@ +info_TEXINFOS = nano.texi + +MAKEINFO = makeinfo --no-split + +BUILT_SOURCES = nano.html + +nano.html: nano.texi + makeinfo --no-split --html < $< > $@ + +EXTRA_DIST = $(info_TEXINFOS) $(BUILT_SOURCES) diff --git a/doc/texinfo/Makefile.in b/doc/texinfo/Makefile.in new file mode 100644 index 0000000..386be23 --- /dev/null +++ b/doc/texinfo/Makefile.in @@ -0,0 +1,632 @@ +# Makefile.in generated by automake 1.11.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. +# 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. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +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 +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/ac_define_dir.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 \ + $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/progtest.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +INFO_DEPS = $(srcdir)/nano.info +am__TEXINFO_TEX_DIR = $(srcdir) +DVIS = nano.dvi +PDFS = nano.pdf +PSS = nano.ps +HTMLS = nano.html +TEXINFOS = nano.texi +TEXI2DVI = texi2dvi +TEXI2PDF = $(TEXI2DVI) --pdf --batch +MAKEINFOHTML = $(MAKEINFO) --html +AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) +DVIPS = dvips +am__installdirs = "$(DESTDIR)$(infodir)" +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' +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CURSES_LIB = @CURSES_LIB@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GMSGFMT = @GMSGFMT@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTLLIBS = @INTLLIBS@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBINTL = @LIBINTL@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LN_S = @LN_S@ +LTLIBICONV = @LTLIBICONV@ +LTLIBINTL = @LTLIBINTL@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = makeinfo --no-split +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGMERGE = @MSGMERGE@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKGDATADIR = @PKGDATADIR@ +PKG_CONFIG = @PKG_CONFIG@ +POSUB = @POSUB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +XGETTEXT = @XGETTEXT@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +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@ +info_TEXINFOS = nano.texi +BUILT_SOURCES = nano.html +EXTRA_DIST = $(info_TEXINFOS) $(BUILT_SOURCES) +all: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) all-am + +.SUFFIXES: +.SUFFIXES: .dvi .html .info .pdf .ps .texi +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/texinfo/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/texinfo/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +.texi.info: + 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 \ + for f in $@ $@-[0-9] $@-[0-9][0-9] $(@:.info=).i[0-9] $(@:.info=).i[0-9][0-9]; do \ + if test -f $$f; then mv $$f $$backupdir; restore=mv; else :; fi; \ + done; \ + else :; fi && \ + cd "$$am__cwd"; \ + if $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + -o $@ $<; \ + then \ + rc=0; \ + $(am__cd) $(srcdir); \ + else \ + rc=$$?; \ + $(am__cd) $(srcdir) && \ + $$restore $$backupdir/* `echo "./$@" | sed 's|[^/]*$$||'`; \ + fi; \ + rm -rf $$backupdir; exit $$rc + +.texi.dvi: + TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ + MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ + $(TEXI2DVI) $< + +.texi.pdf: + TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ + MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ + $(TEXI2PDF) $< + +.texi.html: + rm -rf $(@:.html=.htp) + 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; \ + else \ + if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \ + rm -rf $(@:.html=); else rm -Rf $(@:.html=.htp) $@; fi; \ + 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 $@ $< + +uninstall-dvi-am: + @$(NORMAL_UNINSTALL) + @list='$(DVIS)'; test -n "$(dvidir)" || list=; \ + for p in $$list; do \ + $(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(dvidir)/$$f'"; \ + rm -f "$(DESTDIR)$(dvidir)/$$f"; \ + done + +uninstall-html-am: + @$(NORMAL_UNINSTALL) + @list='$(HTMLS)'; test -n "$(htmldir)" || list=; \ + for p in $$list; do \ + $(am__strip_dir) \ + echo " rm -rf '$(DESTDIR)$(htmldir)/$$f'"; \ + rm -rf "$(DESTDIR)$(htmldir)/$$f"; \ + done + +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 \ + list='$(INFO_DEPS)'; \ + for file in $$list; do \ + relfile=`echo "$$file" | sed 's|^.*/||'`; \ + echo " install-info --info-dir='$(DESTDIR)$(infodir)' --remove '$(DESTDIR)$(infodir)/$$relfile'"; \ + if install-info --info-dir="$(DESTDIR)$(infodir)" --remove "$(DESTDIR)$(infodir)/$$relfile"; \ + then :; else test ! -f "$(DESTDIR)$(infodir)/$$relfile" || exit 1; fi; \ + done; \ + else :; fi + @$(NORMAL_UNINSTALL) + @list='$(INFO_DEPS)'; \ + for file in $$list; do \ + relfile=`echo "$$file" | sed 's|^.*/||'`; \ + relfile_i=`echo "$$relfile" | sed 's|\.info$$||;s|$$|.i|'`; \ + (if test -d "$(DESTDIR)$(infodir)" && cd "$(DESTDIR)$(infodir)"; then \ + echo " cd '$(DESTDIR)$(infodir)' && rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9]"; \ + rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9]; \ + else :; fi); \ + done + +uninstall-pdf-am: + @$(NORMAL_UNINSTALL) + @list='$(PDFS)'; test -n "$(pdfdir)" || list=; \ + for p in $$list; do \ + $(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(pdfdir)/$$f'"; \ + rm -f "$(DESTDIR)$(pdfdir)/$$f"; \ + done + +uninstall-ps-am: + @$(NORMAL_UNINSTALL) + @list='$(PSS)'; test -n "$(psdir)" || list=; \ + for p in $$list; do \ + $(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(psdir)/$$f'"; \ + rm -f "$(DESTDIR)$(psdir)/$$f"; \ + done + +dist-info: $(INFO_DEPS) + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + list='$(INFO_DEPS)'; \ + for base in $$list; do \ + case $$base in \ + $(srcdir)/*) base=`echo "$$base" | sed "s|^$$srcdirstrip/||"`;; \ + esac; \ + if test -f $$base; then d=.; else d=$(srcdir); fi; \ + base_i=`echo "$$base" | sed 's|\.info$$||;s|$$|.i|'`; \ + for file in $$d/$$base $$d/$$base-[0-9] $$d/$$base-[0-9][0-9] $$d/$$base_i[0-9] $$d/$$base_i[0-9][0-9]; do \ + if test -f $$file; then \ + relfile=`expr "$$file" : "$$d/\(.*\)"`; \ + test -f "$(distdir)/$$relfile" || \ + cp -p $$file "$(distdir)/$$relfile"; \ + else :; fi; \ + done; \ + 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 + +clean-aminfo: + -test -z "nano.dvi nano.pdf nano.ps nano.html" \ + || rm -rf nano.dvi nano.pdf nano.ps nano.html + +maintainer-clean-aminfo: + @list='$(INFO_DEPS)'; for i in $$list; do \ + i_i=`echo "$$i" | sed 's|\.info$$||;s|$$|.i|'`; \ + 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: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-info +check-am: all-am +check: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) check-am +all-am: Makefile $(INFO_DEPS) +installdirs: + for dir in "$(DESTDIR)$(infodir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-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 +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -test -z "$(BUILT_SOURCES)" || rm -f $(BUILT_SOURCES) +clean: clean-am + +clean-am: clean-aminfo clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: $(DVIS) + +html: html-am + +html-am: $(HTMLS) + +info: info-am + +info-am: $(INFO_DEPS) + +install-data-am: install-info-am + +install-dvi: install-dvi-am + +install-dvi-am: $(DVIS) + @$(NORMAL_INSTALL) + test -z "$(dvidir)" || $(MKDIR_P) "$(DESTDIR)$(dvidir)" + @list='$(DVIS)'; test -n "$(dvidir)" || list=; \ + 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)$(dvidir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(dvidir)" || exit $$?; \ + done +install-exec-am: + +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=; \ + 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 \ + 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 $$?; \ + else \ + list2="$$list2 $$d$$p"; \ + fi; \ + done; \ + test -z "$$list2" || { echo "$$list2" | $(am__base_list) | \ + while read files; do \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(htmldir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(htmldir)" || exit $$?; \ + done; } +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=; \ + for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + esac; \ + if test -f $$file; then d=.; else d=$(srcdir); fi; \ + file_i=`echo "$$file" | sed 's|\.info$$||;s|$$|.i|'`; \ + for ifile in $$d/$$file $$d/$$file-[0-9] $$d/$$file-[0-9][0-9] \ + $$d/$$file_i[0-9] $$d/$$file_i[0-9][0-9] ; do \ + if test -f $$ifile; then \ + echo "$$ifile"; \ + else : ; fi; \ + done; \ + done | $(am__base_list) | \ + while read files; do \ + 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 \ + list='$(INFO_DEPS)'; test -n "$(infodir)" || list=; \ + for file in $$list; do \ + relfile=`echo "$$file" | sed 's|^.*/||'`; \ + echo " install-info --info-dir='$(DESTDIR)$(infodir)' '$(DESTDIR)$(infodir)/$$relfile'";\ + install-info --info-dir="$(DESTDIR)$(infodir)" "$(DESTDIR)$(infodir)/$$relfile" || :;\ + done; \ + else : ; fi +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: $(PDFS) + @$(NORMAL_INSTALL) + test -z "$(pdfdir)" || $(MKDIR_P) "$(DESTDIR)$(pdfdir)" + @list='$(PDFS)'; test -n "$(pdfdir)" || list=; \ + 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)$(pdfdir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(pdfdir)" || exit $$?; done +install-ps: install-ps-am + +install-ps-am: $(PSS) + @$(NORMAL_INSTALL) + test -z "$(psdir)" || $(MKDIR_P) "$(DESTDIR)$(psdir)" + @list='$(PSS)'; test -n "$(psdir)" || list=; \ + 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)$(psdir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(psdir)" || exit $$?; done +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-aminfo \ + maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-aminfo mostlyclean-generic + +pdf: pdf-am + +pdf-am: $(PDFS) + +ps: ps-am + +ps-am: $(PSS) + +uninstall-am: uninstall-dvi-am uninstall-html-am uninstall-info-am \ + uninstall-pdf-am uninstall-ps-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 \ + uninstall-info-am uninstall-pdf-am uninstall-ps-am + + +nano.html: nano.texi + makeinfo --no-split --html < $< > $@ + +# 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. +.NOEXPORT: diff --git a/doc/texinfo/nano.html b/doc/texinfo/nano.html new file mode 100644 index 0000000..b673557 --- /dev/null +++ b/doc/texinfo/nano.html @@ -0,0 +1,867 @@ +<html lang="en"> +<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> +</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> + + <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> + +</div> + +<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, +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"> +<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> + +<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 +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, +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"> +<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> + +<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 +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 +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 +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. +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 +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 +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 +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 +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 +and a new file is created. + + <br><dt><code>-m, --mouse</code><dd>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 +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 +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 +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. +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 +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. +</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> + +</div> + +<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"> +<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> + +<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"> +<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> + +<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 +the Alt key) and pressing the desired key, or by pressing the Esc key +once and 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> + +<div class="node"> +<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> + +<h3 class="section">2.3 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 +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 +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"> +<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> + +<h3 class="section">2.4 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 +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"> +<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> + +<h3 class="section">2.5 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"> +<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> + +<h3 class="section">2.6 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 +is running. + +<div class="node"> +<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> + +<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 +editor and available keystrokes. Navigation is via the ^Y (Page Up) +and ^V (Page Down) keys. ^X exits the help system. + +<div class="node"> +<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> + +<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 +key sequences. See See <a href="#Special-Functions">Special Functions</a>, for more info. The +following global toggles are available: + + <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"> +<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> + +<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 +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 +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. +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 +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 +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 +keystroke instead of 25. + + <br><dt><code>set quotestr "string"</code><dd>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 +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 +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 +characters as part of a word. + + <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" +to attempt to use a transparent background. + + <br><dt><code>icolor fgcolor,bgcolor "regex" ...</code><dd>Same as above, except that the expression matching is case insensitive. + + <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". + + <br><dt><code>icolor fgcolor,bgcolor start="sr" end="er"</code><dd>Same as above, except that the expression matching is case insensitive. + + <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. + + </dl> + +<div class="node"> +<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> + +<h2 class="chapter">6 The File Browser</h2> + +<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, +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. +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. + +<div class="node"> +<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> + +<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 +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. +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 <code>-p</code> option, but recent versions of Pico use the +<code>-p</code> 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. + + <br><dt><code>Writing, Appending, or Prepending Selected Text to Files</code><dd>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 +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 +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. +</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> + +</div> + +<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 +<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. + + <br><dt><code>--disable-help</code><dd>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 +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 +either a wide version of curses, or a UTF-8-enabled version of Slang. + + <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. + + </dl> + + <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> + diff --git a/doc/texinfo/nano.info b/doc/texinfo/nano.info new file mode 100644 index 0000000..f4cd7ed --- /dev/null +++ b/doc/texinfo/nano.info @@ -0,0 +1,884 @@ +This is nano.info, produced by makeinfo version 4.13 from nano.texi. + +INFO-DIR-SECTION Editors +START-INFO-DIR-ENTRY +* nano: (nano). Small and friendly text editor. +END-INFO-DIR-ENTRY + + +File: nano.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) + + This manual documents GNU `nano', a small and friendly text editor. + +* Menu: + +* Introduction:: +* Editor Basics:: +* Online Help:: +* Feature Toggles:: +* Nanorc Files:: +* The File Browser:: +* Pico Compatibility:: +* Building and Configure Options:: + + +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. + +* Menu: + +* Overview:: +* Command Line Options:: + + +File: nano.info, Node: Overview, Next: Command Line Options, Prev: Introduction, 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 +possible while offering a superset of Pico's functionality. See *Note +Pico Compatibility::, for more info. + + The usual way to invoke `nano' is: + + `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]... [[+,COLUMN] FILE]...' + + `nano [OPTION]... [[+LINE,COLUMN] FILE]...' + + Email bug reports to <nano@nano-editor.org>. + + +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: + +`+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' + 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. + +`-B, --backup' + When saving a file, back up the previous version of it to the + current filename suffixed with a ~. + +`-C <dir>, --backupdir=<dir>' + Set the directory where `nano' puts unique backup files if file + backups are enabled. + +`-D, --boldtext' + Use bold text instead of reverse video text. + +`-E, --tabstospaces' + Convert typed tabs to spaces. + +`-F, --multibuffer' + Enable multiple file buffers, if available. + +`-H, --historylog' + Log search and replace strings to ~/.nano_history, so they can be + retrieved in later sessions, if nanorc support is available. + +`-I, --ignorercfiles' + Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is + available. + +`-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' + Don't add newlines to the ends of files. + +`-N, --noconvert' + Don't convert files from DOS/Mac format. + +`-O, --morespace' + Use the blank line below the titlebar as extra editing space. + +`-Q <str>, --quotestr=<str>' + Set the quoting string for justifying. The default value is + + `^([ \t]*[|>:}#])+' + + if extended regular expression support is available, or "> " + otherwise. Note that `\t' above stands for a literal Tab + character. + +`-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' + Do quick statusbar blanking. Statusbar messages will disappear + after 1 keystroke instead of 25. Note that -c overrides this. + +`-V, --version' + Show the current version number and exit. + +`-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. + +`-c, --const' + Constantly display the cursor position and line number on the + statusbar. Note that this overrides -U. + +`-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. + +`-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. + +`-l, --nofollow' + When writing files, if the given file is a symbolic link, it is + removed and a new file is created. + +`-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 + 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' + 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. + +`-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. + +`-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. + +`-z, --suspend' + Enable `nano''s suspend ability 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' + Ignored, for compatibility with Pico. + + +File: nano.info, Node: Editor Basics, Next: Online Help, Prev: Introduction, Up: Top + +2 Editor Basics +*************** + +* Menu: + +* Entering Text:: +* Special Functions:: +* The Titlebar:: +* The Statusbar:: +* Shortcut Lists:: +* Using the Mouse:: + + +File: nano.info, Node: Entering Text, Next: Special Functions, Prev: Editor Basics, 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. + + +File: nano.info, Node: Special Functions, Next: The Titlebar, 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. + + * 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 Esc 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 + 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. + + +File: nano.info, Node: The Titlebar, Next: The Statusbar, Prev: Special Functions, Up: Editor Basics + +2.3 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 +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. + + 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 +================= + +The statusbar is the third line from the bottom of the screen, or the +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. + + +File: nano.info, Node: Shortcut Lists, Next: Using the Mouse, Prev: The Statusbar, Up: Editor Basics + +2.5 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. + + +File: nano.info, Node: Using the Mouse, Prev: Shortcut Lists, Up: Editor Basics + +2.6 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. + + The mouse will work in the X Window System, and on the console when +gpm is running. + + +File: nano.info, Node: Online Help, Next: Feature Toggles, Prev: Editor Basics, Up: Top + +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. + + +File: nano.info, Node: Feature Toggles, Next: Nanorc Files, Prev: Online Help, Up: Top + +4 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 +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. + +`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. + +`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. + +`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. + +`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. + +`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. + +`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. + +`Expert/No Help Toggle (Meta-X)' + toggles the -x (`--nohelp') command line option. + +`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. + +`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 + +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. + + 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. + + 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, + + `""')>]}"' + + will match `"', `'', `)', `>', `]', and `}'. + + The supported commands and arguments are: + +`set/unset autoindent' + Use auto-indentation. + +`set/unset backup' + Create backup files in "filename~". + +`set backupdir "directory"' + Set the directory where `nano' puts unique backup files if file + backups are enabled. + +`set/unset backwards' + Do backwards searches by default. + +`set/unset boldtext' + Use bold text instead of reverse video text. + +`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 + + `""')>]}"' + +`set/unset casesensitive' + Do case sensitive searches by default. + +`set/unset 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 + 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/unset historylog' + Enable ~/.nano_history for saving and reading search/replace + strings. + +`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 + + `"(<[{)>]}"' + +`set/unset morespace' + Use the blank line below the titlebar as extra editing space. + +`set/unset 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' + Allow inserting files into their own buffers. + +`set/unset noconvert' + Don't convert files from DOS/Mac format. + +`set/unset nofollow' + Don't follow symlinks when writing files. + +`set/unset nohelp' + Don't display the help lists at the bottom of the screen. + +`set/unset nonewlines' + Don't add newlines to the ends of files. + +`set/unset nowrap' + Don't wrap text at all. + +`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' + Preserve the XON and XOFF keys (^Q and ^S). + +`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 `"!.?"'. + +`set/unset quickblank' + Do quick statusbar blanking. Statusbar messages will disappear + after 1 keystroke instead of 25. + +`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]*[#:>\\|}])+"' + + if you have extended regular expression support, or "> " otherwise. + Note that '\\t' stands for a literal Tab character. + +`set/unset 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' + 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' + Do extended regular expression searches by default. + +`set/unset 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. + +`set/unset smooth' + Use smooth scrolling by default. + +`set/unset softwrap' + Use soft wrapping by default. + +`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/unset suspendenable' + If `nano' is allowed to be suspended, allow the suspend key + (usually ^Z) to actually suspend it. + +`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/unset tabstospaces' + Convert typed tabs to spaces. + +`set/unset tempfile' + Save automatically on exit, don't prompt. + +`set/unset undo' + Enable experimental generic-purpose undo code. + +`set/unset 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/unset wordbounds' + Detect word boundaries more accurately by treating punctuation + characters as part of a word. + +`syntax "str" ["fileregex" ... ]' + 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. + + 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" ...' + 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" ...' + Same as above, except that the expression matching is case + insensitive. + +`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 + 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". + +`icolor fgcolor,bgcolor start="sr" end="er"' + Same as above, except that the expression matching is case + insensitive. + +`include "syntaxfile"' + Read in self-contained color syntaxes from "syntaxfile". Note that + "syntaxfile" can only contain "syntax", "color", and "icolor" + commands. + + + +File: nano.info, Node: The File Browser, Next: Pico Compatibility, Prev: Nanorc Files, Up: Top + +6 The File Browser +****************** + +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. + + 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. +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. + + +File: nano.info, Node: Pico Compatibility, Next: Building and Configure Options, Prev: The File Browser, Up: Top + +7 Pico Compatibility +******************** + +`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 + replace strings will be stored and can be accessed with the up/down + 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 + 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 + 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' + Text selected using the marking key (^^) can be written out, + appended, or prepended to a new or existing file using the + WriteOut key (^O). + +`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. + + +File: nano.info, Node: Building and Configure Options, Prev: Pico Compatibility, Up: Top + +8 Building and Configure Options +******************************** + +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') + + * cd nano-x.y.z/ + + * ./configure + + * make + + * make install + + The possible options to `./configure' are: + +`--disable-browser' + Disable the mini file browser when reading or writing files. + +`--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-operatingdir' + Disable setting the operating directory. This also disables the -o + command line option, which sets the operating directory. + +`--disable-speller' + Disable use of the spell checker. This also disables the -s + command line option, which allows specifying an alternate spell + checker. + +`--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. + +`--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. + +`--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. + +`--enable-color' + Enable support for syntax coloring of files using the nanorc file. + This enables nanorc support as well. + +`--enable-multibuffer' + Enable support for opening multiple files at a time and switching + between them on the fly. + +`--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 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. + +`--with-slang' + Compiling `nano' with Slang is supported, and will make the binary + notably smaller than if compiled with 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 + +End Tag Table diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi new file mode 100644 index 0000000..fe12428 --- /dev/null +++ b/doc/texinfo/nano.texi @@ -0,0 +1,885 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename nano.info +@settitle nano Command Manual +@c %**end of header + +@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 + +@dircategory Editors +@direntry +* nano: (nano). Small and friendly text editor. +@end direntry + +@c tex +@c \overfullrule=0pt +@c end tex + +@titlepage +@title GNU @code{nano} +@subtitle a small and friendly text editor. +@subtitle version 2.2.0 + +@author Chris Allegretta +@page + +This manual documents GNU @code{nano}, a small and friendly text +editor. + +This manual is part of the GNU @code{nano} distribution.@* +@sp4 +Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, +2008, 2009 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: + +* The GNU General Public License, as published by the Free Software + Foundation, version 3 or (at your option) any later version. You + should have received a copy of the GNU General Public License along + with this program. If not, see <http://www.gnu.org/licenses/>. + +* The GNU Free Documentation License, as published by the Free Software + Foundation, version 1.2 or (at your option) any later version, with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + You should have received a copy of the GNU Free Documentation License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +You may contact the author by +e-mail: @email{chrisa@@asty.org}@* +@end titlepage + +@node Top, Introduction, (dir), (dir) + +This manual documents GNU @code{nano}, a small and friendly text +editor. + +@menu +* Introduction:: +* Editor Basics:: +* Online Help:: +* Feature Toggles:: +* Nanorc Files:: +* The File Browser:: +* Pico Compatibility:: +* Building and Configure Options:: +@end menu + +@node Introduction, Editor Basics, Top, Top +@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, +feature toggles, internationalization support, and filename tab +completion. + +@menu +* Overview:: +* Command Line Options:: +@end menu + +@node Overview, Command Line Options, Introduction, Introduction +@section Overview + +The original goal for @code{nano} was a complete bug-for-bug compatible +emulation of Pico, but @code{nano}'s current goal is to be as compatible +as possible while offering a superset of Pico's functionality. See +@xref{Pico Compatibility}, for more info. + +The usual way to invoke @code{nano} is: + +@quotation +@code{nano [OPTION]@dots{} [FILE]} +@end quotation + +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: + +@quotation +@code{nano [OPTION]@dots{} [[+LINE] FILE]@dots{}} + +@code{nano [OPTION]@dots{} [[+,COLUMN] FILE]@dots{}} + +@code{nano [OPTION]@dots{} [[+LINE,COLUMN] FILE]@dots{}} +@end quotation + +Email bug reports to @email{nano@@nano-editor.org}. + +@node Command Line Options, , Overview, Introduction +@section Command Line Options + +@code{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 +which must be specified) instead of the default of line 1, column 1. + +@item -? +Same as @code{-h, --help}. + +@item -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. + +@item -B, --backup +When saving a file, back up the previous version of it to the current +filename suffixed with a ~. + +@item -C <dir>, --backupdir=<dir> +Set the directory where @code{nano} puts unique backup files if file +backups are enabled. + +@item -D, --boldtext +Use bold text instead of reverse video text. + +@item -E, --tabstospaces +Convert typed tabs to spaces. + +@item -F, --multibuffer +Enable multiple file buffers, if available. + +@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 -I, --ignorercfiles +Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is +available. + +@item -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. + +@item -L, --nonewlines +Don't add newlines to the ends of files. + +@item -N, --noconvert +Don't convert files from DOS/Mac format. + +@item -O, --morespace +Use the blank line below the titlebar as extra editing space. + +@item -Q <str>, --quotestr=<str> +Set the quoting string for justifying. The default value is + +@quotation +@code{^([ \t]*[|>:@}#])+} +@end quotation + +if extended regular expression support is available, or "> " otherwise. +Note that @code{\t} above stands for a literal Tab character. + +@item -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 @code{nano} with any name beginning with 'r' (e.g. "rnano"). + +@item -S, --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 -U, --quickblank +Do quick statusbar blanking. Statusbar messages will disappear after 1 +keystroke instead of 25. Note that -c overrides this. + +@item -V, --version +Show the current version number and exit. + +@item -W, --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 -c, --const +Constantly display the cursor position and line number on the statusbar. +Note that this overrides -U. + +@item -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. + +@item -h, --help +Show a summary of command line options and exit. + +@item -i, --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 -l, --nofollow +When writing files, if the given file is a symbolic link, it is removed +and a new file is created. + +@item -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. + +@item -o <dir>, --operatingdir=<dir> +Set operating directory. Makes @code{nano} set up something similar to +a chroot. + +@item -p, --preserve +Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the +editor can be can be stopped and started. + +@item -q, --quiet +Do not report errors in the nanorc file and 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 +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 +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 +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. + +@anchor{Expert Mode} +@item -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. + +@item -z, --suspend +Enable @code{nano}'s suspend ability 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 +Ignored, for compatibility with Pico. +@end table + + +@node Editor Basics, Online Help, Introduction, Top +@chapter Editor Basics +@menu +* Entering Text:: +* Special Functions:: +* The Titlebar:: +* The Statusbar:: +* Shortcut Lists:: +* Using the Mouse:: +@end menu + +@node Entering Text, Special Functions, Editor Basics, Editor Basics +@section Entering Text + +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 +@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. + +@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. +@item +Pressing Esc 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" +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 +@section 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 @code{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. + +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 +@section The Statusbar + +The statusbar is the third line from the bottom of the screen, or the +bottom line in Expert Mode. See @xref{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. + +@node Shortcut Lists, Using the Mouse, The Statusbar, Editor Basics +@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 +@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. + +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 +@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 +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 +@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 +key sequences. See @xref{Special Functions}, for more info. The +following global toggles are available: + +@table @code + +@item Backup Files Toggle (Meta-B) +toggles the -B (@code{--backup}) command line option. + +@item Constant Cursor Position Display Toggle (Meta-C) +toggles the -c (@code{--const}) command line option. + +@item Multiple File Buffers Toggle (Meta-F) +toggles the -F (@code{--multibuffer}) command line option. + +@item Smart Home Key Toggle (Meta-H) +toggles the -A (@code{--smarthome}) command line option. + +@item Auto Indent Toggle (Meta-I) +toggles the -i (@code{--autoindent}) command line option. + +@item Cut To End Toggle (Meta-K) +toggles the -k (@code{--cut}) command line option. + +@item Long Line Wrapping Toggle (Meta-L) +toggles the -w (@code{--nowrap}) command line option. + +@item Mouse Support Toggle (Meta-M) +toggles the -m (@code{--mouse}) command line option. + +@item No Conversion From DOS/Mac Format Toggle (Meta-N) +toggles the -N (@code{--noconvert}) command line option. + +@item More Space For Editing Toggle (Meta-O) +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. + +@item Tabs to Spaces Toggle (Meta-Q) +toggles the -E (@code{--tabstospaces}) command line option. + +@item Smooth Scrolling Toggle (Meta-S) +toggles the -S (@code{--smooth}) command line option. + +@item Expert/No Help Toggle (Meta-X) +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. + +@item Suspend Toggle (Meta-Z) +toggles the -z (@code{--suspend}) command line option. + +@item Soft Wrapping Toggle (Meta-$) +toggles the -$ (@code{--softwrap}) command line option. + +@end table + + +@node Nanorc Files, The File Browser, Feature Toggles, Top +@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. + +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. + +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. + +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, + +@quotation +@code{""')>]@}"} +@end quotation + +will match @code{"}, @code{'}, @code{)}, @code{>}, @code{]}, and +@code{@}}. + +The supported commands and arguments are: + +@table @code + +@item set/unset autoindent +Use auto-indentation. + +@item set/unset backup +Create backup files in "filename~". + +@item set backupdir "directory" +Set the directory where @code{nano} puts unique backup files if file +backups are enabled. + +@item set/unset backwards +Do backwards searches by default. + +@item set/unset boldtext +Use bold text instead of reverse video text. + +@item 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 + +@quotation +@code{""')>]@}"} +@end quotation + +@item set/unset casesensitive +Do case sensitive searches by default. + +@item set/unset 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 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/unset historylog +Enable ~/.nano_history for saving and reading search/replace strings. + +@item 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 + +@quotation +@code{"(<[@{)>]@}"} +@end quotation + +@item set/unset morespace +Use the blank line below the titlebar as extra editing space. + +@item set/unset 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 +Allow inserting files into their own buffers. + +@item set/unset noconvert +Don't convert files from DOS/Mac format. + +@item set/unset nofollow +Don't follow symlinks when writing files. + +@item set/unset nohelp +Don't display the help lists at the bottom of the screen. + +@item set/unset nonewlines +Don't add newlines to the ends of files. + +@item set/unset nowrap +Don't wrap text at all. + +@item set operatingdir "directory" +@code{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. + +@item set/unset preserve +Preserve the XON and XOFF keys (^Q and ^S). + +@item 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 @code{"!.?"}. + +@item set/unset quickblank +Do quick statusbar blanking. Statusbar messages will disappear after 1 +keystroke instead of 25. + +@item 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 + +@quotation +@code{"^([ \\t]*[#:>\\|@}])+"} +@end quotation + +if you have extended regular expression support, or "> " otherwise. +Note that '\\t' stands for a literal Tab character. + +@item set/unset 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 +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 +Do extended regular expression searches by default. + +@item set/unset 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 +Use smooth scrolling by default. + +@item set/unset softwrap +Use soft wrapping by default. + +@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/unset suspendenable +If @code{nano} is allowed to be suspended, allow the suspend key +(usually ^Z) to actually suspend it. + +@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/unset tabstospaces +Convert typed tabs to spaces. + +@item set/unset tempfile +Save automatically on exit, don't prompt. + +@item set/unset undo +Enable experimental generic-purpose undo code. + +@item set/unset 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. + +@item set/unset wordbounds +Detect word boundaries more accurately by treating punctuation +characters as part of a word. + +@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 +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". + +@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, +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. + +@item icolor fgcolor,bgcolor "regex" @dots{} +Same as above, except that the expression matching is case insensitive. + +@item 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 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". + +@item icolor fgcolor,bgcolor start="sr" end="er" +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. + +@end table + + +@node The File Browser, Pico Compatibility, Nanorc Files, Top +@chapter The File Browser + +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. + +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. +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. + +@node Pico Compatibility, Building and Configure Options, The File Browser, Top +@chapter Pico Compatibility + +@code{nano} attempts to emulate Pico as closely as possible, but there +are certain differences between the editors: + +@table @code +@item Search and Replace History +As of version 1.1.99pre1 of @code{nano}, text entered as search or +replace strings will be stored and can be accessed with the up/down +arrow keys. Previously, @code{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 being bracketed and +uneditable as it is in Pico. The old behavior could be made compatible +with Pico via the @code{-p} option, but recent versions of Pico use the +@code{-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. + + +@item 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). + +@item 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 @code{nano}. See +@xref{Feature Toggles}, for more info. + +@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. + +@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 +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. +@end table + +@node Building and Configure Options, , Pico Compatibility, Top +@chapter Building and Configure Options + +Building @code{nano} from source is fairly straightforward if you are +familiar with compiling programs with autoconf support: + +@itemize @bullet +@item tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of +@code{nano}) +@item cd nano-x.y.z/ +@item ./configure +@item make +@item make install +@end itemize + +The possible options to @code{./configure} are: + +@table @code + +@item --disable-browser +Disable the mini file browser when reading or writing files. + +@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-justify +Disable the justify and unjustify functions. + +@item --disable-mouse +Disable all mouse functionality. This also disables the -m command line +option, which enables the mouse functionality. + +@item --disable-operatingdir +Disable setting the operating directory. This also disables 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. + +@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. + +@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. + +@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). + +@item --disable-nls +Disables Native Language support. This will disable use of the +available GNU @code{nano} translations. + +@item --disable-wrapping-as-root +Disable long line wrapping by default when 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. + +@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. + +@end table + +@contents +@bye diff --git a/doc/texinfo/texinfo.tex b/doc/texinfo/texinfo.tex new file mode 100644 index 0000000..9140826 --- /dev/null +++ b/doc/texinfo/texinfo.tex @@ -0,0 +1,9291 @@ +% texinfo.tex -- TeX macros to handle Texinfo files. +% +% 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} +% +% 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. +% +% 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 +% published by the Free Software Foundation, either version 3 of the +% License, or (at your option) any later version. +% +% This texinfo.tex file is distributed in the hope that it will be +% useful, but WITHOUT ANY WARRANTY; without even the implied warranty +% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +% General Public License for more details. +% +% You should have received a copy of the GNU General Public License +% along with this program. If not, see <http://www.gnu.org/licenses/>. +% +% 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.) +% +% 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). +% The texinfo.tex in any given distribution could well be out +% of date, so if that's what you're using, please check. +% +% Send bug reports to bug-texinfo@gnu.org. Please include including a +% complete document in each bug report with which we can reproduce the +% problem. Patches are, of course, greatly appreciated. +% +% To process a Texinfo manual with TeX, it's most reliable to use the +% texi2dvi shell script that comes with the distribution. For a simple +% manual foo.texi, however, you can get away with this: +% tex foo.texi +% texindex foo.?? +% tex foo.texi +% tex foo.texi +% dvips foo.dvi -o # or whatever; this makes foo.ps. +% The extra TeX runs get the cross-reference information correct. +% Sometimes one run after texindex suffices, and sometimes you need more +% than two; texi2dvi does it as many times as necessary. +% +% It is possible to adapt texinfo.tex for other languages, to some +% extent. You can get the existing language-specific files from the +% full Texinfo distribution. +% +% The GNU Texinfo home page is http://www.gnu.org/software/texinfo. + + +\message{Loading texinfo [version \texinfoversion]:} + +% If in a .fmt file, print the version number +% and turn on active characters that we couldn't do earlier because +% they might have appeared in the input file name. +\everyjob{\message{[Texinfo version \texinfoversion]}% + \catcode`+=\active \catcode`\_=\active} + + +\chardef\other=12 + +% We never want plain's \outer definition of \+ in Texinfo. +% For @tex, we can use \tabalign. +\let\+ = \relax + +% Save some plain tex macros whose names we will redefine. +\let\ptexb=\b +\let\ptexbullet=\bullet +\let\ptexc=\c +\let\ptexcomma=\, +\let\ptexdot=\. +\let\ptexdots=\dots +\let\ptexend=\end +\let\ptexequiv=\equiv +\let\ptexexclam=\! +\let\ptexfootnote=\footnote +\let\ptexgtr=> +\let\ptexhat=^ +\let\ptexi=\i +\let\ptexindent=\indent +\let\ptexinsert=\insert +\let\ptexlbrace=\{ +\let\ptexless=< +\let\ptexnewwrite\newwrite +\let\ptexnoindent=\noindent +\let\ptexplus=+ +\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 + +% If this character appears in an error message or help string, it +% starts a new line in the output. +\newlinechar = `^^J + +% Use TeX 3.0's \inputlineno to get the line number, for better error +% messages, but if we're using an old version of TeX, don't do anything. +% +\ifx\inputlineno\thisisundefined + \let\linenumber = \empty % Pre-3.0. +\else + \def\linenumber{l.\the\inputlineno:\space} +\fi + +% 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\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\putwordInfo\undefined \gdef\putwordInfo{Info}\fi +\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi +\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi +\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi +\ifx\putwordof\undefined \gdef\putwordof{of}\fi +\ifx\putwordon\undefined \gdef\putwordon{on}\fi +\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi +\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi +\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi +\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi +\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi +\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi +\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi +% +\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi +\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi +\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi +\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi +\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi +\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi +\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi +\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi +\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi +\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi +\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi +\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi +% +\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi +\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi +\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi +\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi +\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi + +% Since the category of space is not known, we have to be careful. +\chardef\spacecat = 10 +\def\spaceisspace{\catcode`\ =\spacecat} + +% sometimes characters are active, so we need control sequences. +\chardef\colonChar = `\: +\chardef\commaChar = `\, +\chardef\dashChar = `\- +\chardef\dotChar = `\. +\chardef\exclamChar= `\! +\chardef\lquoteChar= `\` +\chardef\questChar = `\? +\chardef\rquoteChar= `\' +\chardef\semiChar = `\; +\chardef\underChar = `\_ + +% Ignore a token. +% +\def\gobble#1{} + +% The following is used inside several \edef's. +\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} + +% Hyphenation fixes. +\hyphenation{ + Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script + ap-pen-dix bit-map bit-maps + data-base data-bases eshell fall-ing half-way long-est man-u-script + man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm + par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces + spell-ing spell-ings + stand-alone strong-est time-stamp time-stamps which-ever white-space + wide-spread wrap-around +} + +% Margin to add to right of even pages, to left of odd pages. +\newdimen\bindingoffset +\newdimen\normaloffset +\newdimen\pagewidth \newdimen\pageheight + +% For a final copy, take out the rectangles +% 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 + }% + }% +} + +% Sometimes it is convenient to have everything in the transcript file +% and nothing on the terminal. We don't just call \tracingall here, +% since that produces some useless output on the terminal. We also make +% some effort to order the tracing commands to reduce output in the log +% file; cf. trace.sty in LaTeX. +% +\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% +\def\loggingall{% + \tracingstats2 + \tracingpages1 + \tracinglostchars2 % 2 gives us more in etex + \tracingparagraphs1 + \tracingoutput1 + \tracingmacros2 + \tracingrestores1 + \showboxbreadth\maxdimen \showboxdepth\maxdimen + \ifx\eTeXversion\undefined\else % etex gives us more logging + \tracingscantokens1 + \tracingifs1 + \tracinggroups1 + \tracingnesting2 + \tracingassigns1 + \fi + \tracingcommands3 % 3 gives us more in etex + \errorcontextlines16 +}% + +% 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. +% +\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount + \removelastskip\penalty-50\smallskip\fi\fi} +\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount + \removelastskip\penalty-100\medskip\fi\fi} +\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 +\let\cropmarks = \cropmarkstrue +% +% Dimensions to add cropmarks at corners. +% Added by P. A. MacKay, 12 Nov. 1986 +% +\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines +\newdimen\cornerlong \cornerlong=1pc +\newdimen\cornerthick \cornerthick=.3pt +\newdimen\topandbottommargin \topandbottommargin=.75in + +% Output a mark which sets \thischapter, \thissection and \thiscolor. +% We dump everything together because we only have one kind of mark. +% This works because we only use \botmark / \topmark, not \firstmark. +% +% A mark contains a subexpression of the \ifcase ... \fi construct. +% \get*marks macros below extract the needed part using \ifcase. +% +% Another complication is to let the user choose whether \thischapter +% (\thissection) refers to the chapter (section) in effect at the top +% of a page, or that at the bottom of a page. The solution is +% described on page 260 of The TeXbook. It involves outputting two +% marks for the sectioning macros, one before the section break, and +% one after. I won't pretend I can describe this better than DEK... +\def\domark{% + \toks0=\expandafter{\lastchapterdefs}% + \toks2=\expandafter{\lastsectiondefs}% + \toks4=\expandafter{\prevchapterdefs}% + \toks6=\expandafter{\prevsectiondefs}% + \toks8=\expandafter{\lastcolordefs}% + \mark{% + \the\toks0 \the\toks2 + \noexpand\or \the\toks4 \the\toks6 + \noexpand\else \the\toks8 + }% +} +% \topmark doesn't work for the very first chapter (after the title +% page or the contents), so we use \firstmark there -- this gets us +% the mark with the chapter defs, unless the user sneaks in, e.g., +% @setcolor (or @url, or @link, etc.) between @contents and the very +% first @chapter. +\def\gettopheadingmarks{% + \ifcase0\topmark\fi + \ifx\thischapter\empty \ifcase0\firstmark\fi \fi +} +\def\getbottomheadingmarks{\ifcase1\botmark\fi} +\def\getcolormarks{\ifcase2\topmark\fi} + +% Avoid "undefined control sequence" errors. +\def\lastchapterdefs{} +\def\lastsectiondefs{} +\def\prevchapterdefs{} +\def\prevsectiondefs{} +\def\lastcolordefs{} + +% Main output routine. +\chardef\PAGE = 255 +\output = {\onepageout{\pagecontents\PAGE}} + +\newbox\headlinebox +\newbox\footlinebox + +% \onepageout takes a vbox as an argument. Note that \pagecontents +% does insertions, but you have to call it yourself. +\def\onepageout#1{% + \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi + % + \ifodd\pageno \advance\hoffset by \bindingoffset + \else \advance\hoffset by -\bindingoffset\fi + % + % Do this outside of the \shipout so @code etc. will be expanded in + % the headline as they should be, not taken literally (outputting ''code). + \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi + \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% + \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi + \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% + % + {% + % Have to do this stuff outside the \shipout because we want it to + % take effect in \write's, yet the group defined by the \vbox ends + % before the \shipout runs. + % + \indexdummies % don't expand commands in the output. + \normalturnoffactive % \ in index entries must not stay \, e.g., if + % the page break happens to be in the middle of an example. + % We don't want .vr (or whatever) entries like this: + % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} + % "\acronym" won't work when it's read back in; + % it needs to be + % {\code {{\tt \backslashcurfont }acronym} + \shipout\vbox{% + % Do this early so pdf references go to the beginning of the page. + \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi + % + \ifcropmarks \vbox to \outervsize\bgroup + \hsize = \outerhsize + \vskip-\topandbottommargin + \vtop to0pt{% + \line{\ewtop\hfil\ewtop}% + \nointerlineskip + \line{% + \vbox{\moveleft\cornerthick\nstop}% + \hfill + \vbox{\moveright\cornerthick\nstop}% + }% + \vss}% + \vskip\topandbottommargin + \line\bgroup + \hfil % center the page within the outer (page) hsize. + \ifodd\pageno\hskip\bindingoffset\fi + \vbox\bgroup + \fi + % + \unvbox\headlinebox + \pagebody{#1}% + \ifdim\ht\footlinebox > 0pt + % Only leave this space if the footline is nonempty. + % (We lessened \vsize for it in \oddfootingyyy.) + % The \baselineskip=24pt in plain's \makefootline has no effect. + \vskip 24pt + \unvbox\footlinebox + \fi + % + \ifcropmarks + \egroup % end of \vbox\bgroup + \hfil\egroup % end of (centering) \line\bgroup + \vskip\topandbottommargin plus1fill minus1fill + \boxmaxdepth = \cornerthick + \vbox to0pt{\vss + \line{% + \vbox{\moveleft\cornerthick\nsbot}% + \hfill + \vbox{\moveright\cornerthick\nsbot}% + }% + \nointerlineskip + \line{\ewbot\hfil\ewbot}% + }% + \egroup % \vbox from first cropmarks clause + \fi + }% end of \shipout\vbox + }% end of group with \indexdummies + \advancepageno + \ifnum\outputpenalty>-20000 \else\dosupereject\fi +} + +\newinsert\margin \dimen\margin=\maxdimen + +\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} +{\catcode`\@ =11 +\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi +% marginal hacks, juha@viisa.uucp (Juha Takala) +\ifvoid\margin\else % marginal info is present + \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi +\dimen@=\dp#1\relax \unvbox#1\relax +\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi +\ifr@ggedbottom \kern-\dimen@ \vfil \fi} +} + +% Here are the rules for the cropmarks. Note that they are +% offset so that the space between them is truly \outerhsize or \outervsize +% (P. A. MacKay, 12 November, 1986) +% +\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} +\def\nstop{\vbox + {\hrule height\cornerthick depth\cornerlong width\cornerthick}} +\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} +\def\nsbot{\vbox + {\hrule height\cornerlong depth\cornerthick width\cornerthick}} + +% Parse an argument, then pass it to #1. The argument is the rest of +% the input line (except we remove a trailing comment). #1 should be a +% macro which expects an ordinary undelimited TeX argument. +% +\def\parsearg{\parseargusing{}} +\def\parseargusing#1#2{% + \def\argtorun{#2}% + \begingroup + \obeylines + \spaceisspace + #1% + \parseargline\empty% Insert the \empty token, see \finishparsearg below. +} + +{\obeylines % + \gdef\parseargline#1^^M{% + \endgroup % End of the group started in \parsearg. + \argremovecomment #1\comment\ArgTerm% + }% +} + +% First remove any @comment, then any @c comment. +\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} +\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} + +% Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space. +% +% \argremovec might leave us with trailing space, e.g., +% @end itemize @c foo +% This space token undergoes the same procedure and is eventually removed +% by \finishparsearg. +% +\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} +\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} +\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% + \def\temp{#3}% + \ifx\temp\empty + % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp: + \let\temp\finishparsearg + \else + \let\temp\argcheckspaces + \fi + % Put the space token in: + \temp#1 #3\ArgTerm +} + +% If a _delimited_ argument is enclosed in braces, they get stripped; so +% to get _exactly_ the rest of the line, we had to prevent such situation. +% We prepended an \empty token at the very beginning and we expand it now, +% just before passing the control to \argtorun. +% (Similarly, we have to think about #3 of \argcheckspacesY above: it is +% either the null string, or it ends with \^^M---thus there is no danger +% that a pair of braces would be stripped. +% +% But first, we have to remove the trailing space token. +% +\def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}} + +% \parseargdef\foo{...} +% is roughly equivalent to +% \def\foo{\parsearg\Xfoo} +% \def\Xfoo#1{...} +% +% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my +% favourite TeX trick. --kasal, 16nov03 + +\def\parseargdef#1{% + \expandafter \doparseargdef \csname\string#1\endcsname #1% +} +\def\doparseargdef#1#2{% + \def#2{\parsearg#1}% + \def#1##1% +} + +% Several utility definitions with active space: +{ + \obeyspaces + \gdef\obeyedspace{ } + + % Make each space character in the input produce a normal interword + % space in the output. Don't allow a line break at this space, as this + % is used only in environments like @example, where each line of input + % should produce a line of output anyway. + % + \gdef\sepspaces{\obeyspaces\let =\tie} + + % If an index command is used in an @example environment, any spaces + % therein should become regular spaces in the raw index file, not the + % expansion of \tie (\leavevmode \penalty \@M \ ). + \gdef\unsepspaces{\let =\space} +} + + +\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} + +% Define the framework for environments in texinfo.tex. It's used like this: +% +% \envdef\foo{...} +% \def\Efoo{...} +% +% It's the responsibility of \envdef to insert \begingroup before the +% actual body; @end closes the group after calling \Efoo. \envdef also +% defines \thisenv, so the current environment is known; @end checks +% whether the environment name matches. The \checkenv macro can also be +% used to check whether the current environment is the one expected. +% +% Non-false conditionals (@iftex, @ifset) don't fit into this, so they +% are not treated as environments; they don't open a group. (The +% implementation of @end takes care not to call \endgroup in this +% special case.) + + +% At run-time, environments start with this: +\def\startenvironment#1{\begingroup\def\thisenv{#1}} +% initialize +\let\thisenv\empty + +% ... but they get defined via ``\envdef\foo{...}'': +\long\def\envdef#1#2{\def#1{\startenvironment#1#2}} +\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} + +% Check whether we're in the right environment: +\def\checkenv#1{% + \def\temp{#1}% + \ifx\thisenv\temp + \else + \badenverr + \fi +} + +% Environment mismatch, #1 expected: +\def\badenverr{% + \errhelp = \EMsimple + \errmessage{This command can appear only \inenvironment\temp, + not \inenvironment\thisenv}% +} +\def\inenvironment#1{% + \ifx#1\empty + out of any environment% + \else + in environment \expandafter\string#1% + \fi +} + +% @end foo executes the definition of \Efoo. +% But first, it executes a specialized version of \checkenv +% +\parseargdef\end{% + \if 1\csname iscond.#1\endcsname + \else + % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 + \expandafter\checkenv\csname#1\endcsname + \csname E#1\endcsname + \endgroup + \fi +} + +\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 +% since \penalty is valid in vertical mode, we'd end up putting the +% penalty on the vertical list instead of in the new paragraph. +{\catcode`@ = 11 + % Avoid using \@M directly, because that causes trouble + % if the definition is written into an index file. + \global\let\tiepenalty = \@M + \gdef\tie{\leavevmode\penalty\tiepenalty\ } +} + +% @: forces normal size whitespace following. +\def\:{\spacefactor=1000 } + +% @* forces a line break. +\def\*{\hfil\break\hbox{}\ignorespaces} + +% @/ allows a line break. +\let\/=\allowbreak + +% @. is an end-of-sentence period. +\def\.{.\spacefactor=\endofsentencespacefactor\space} + +% @! is an end-of-sentence bang. +\def\!{!\spacefactor=\endofsentencespacefactor\space} + +% @? is an end-of-sentence query. +\def\?{?\spacefactor=\endofsentencespacefactor\space} + +% @frenchspacing on|off says whether to put extra space after punctuation. +% +\def\onword{on} +\def\offword{off} +% +\parseargdef\frenchspacing{% + \def\temp{#1}% + \ifx\temp\onword \plainfrenchspacing + \else\ifx\temp\offword \plainnonfrenchspacing + \else + \errhelp = \EMsimple + \errmessage{Unknown @frenchspacing option `\temp', must be on/off}% + \fi\fi +} + +% @w prevents a word break. Without the \leavevmode, @w at the +% beginning of a paragraph, when TeX is still in vertical mode, would +% produce a whole line of output instead of starting the paragraph. +\def\w#1{\leavevmode\hbox{#1}} + +% @group ... @end group forces ... to be all on one page, by enclosing +% it in a TeX vbox. We use \vtop instead of \vbox to construct the box +% to keep its height that of a normal line. According to the rules for +% \topskip (p.114 of the TeXbook), the glue inserted is +% max (\topskip - \ht (first item), 0). If that height is large, +% therefore, no glue is inserted, and the space between the headline and +% the text is small, which looks bad. +% +% Another complication is that the group might be very large. This can +% cause the glue on the previous page to be unduly stretched, because it +% does not have much material. In this case, it's better to add an +% explicit \vfill so that the extra space is at the bottom. The +% threshold for doing this is if the group is more than \vfilllimit +% percent of a page (\vfilllimit can be changed inside of @tex). +% +\newbox\groupbox +\def\vfilllimit{0.7} +% +\envdef\group{% + \ifnum\catcode`\^^M=\active \else + \errhelp = \groupinvalidhelp + \errmessage{@group invalid in context where filling is enabled}% + \fi + \startsavinginserts + % + \setbox\groupbox = \vtop\bgroup + % Do @comment since we are called inside an environment such as + % @example, where each end-of-line in the input causes an + % end-of-line in the output. We don't want the end-of-line after + % the `@group' to put extra space in the output. Since @group + % should appear on a line by itself (according to the Texinfo + % manual), we don't worry about eating any user text. + \comment +} +% +% The \vtop produces a box with normal height and large depth; thus, TeX puts +% \baselineskip glue before it, and (when the next line of text is done) +% \lineskip glue after it. Thus, space below is not quite equal to space +% above. But it's pretty close. +\def\Egroup{% + % To get correct interline space between the last line of the group + % and the first line afterwards, we have to propagate \prevdepth. + \endgraf % Not \par, as it may have been set to \lisppar. + \global\dimen1 = \prevdepth + \egroup % End the \vtop. + % \dimen0 is the vertical size of the group's box. + \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox + % \dimen2 is how much space is left on the page (more or less). + \dimen2 = \pageheight \advance\dimen2 by -\pagetotal + % if the group doesn't fit on the current page, and it's a big big + % group, force a page break. + \ifdim \dimen0 > \dimen2 + \ifdim \pagetotal < \vfilllimit\pageheight + \page + \fi + \fi + \box\groupbox + \prevdepth = \dimen1 + \checkinserts +} +% +% TeX puts in an \escapechar (i.e., `@') at the beginning of the help +% message, so this ends up printing `@group can only ...'. +% +\newhelp\groupinvalidhelp{% +group can only be used in environments such as @example,^^J% +where each line of input produces a line of output.} + +% @need space-in-mils +% forces a page break if there is not space-in-mils remaining. + +\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. + \par + % + % If the @need value is less than one line space, it's useless. + \dimen0 = #1\mil + \dimen2 = \ht\strutbox + \advance\dimen2 by \dp\strutbox + \ifdim\dimen0 > \dimen2 + % + % Do a \strut just to make the height of this box be normal, so the + % normal leading is inserted relative to the preceding line. + % And a page break here is fine. + \vtop to #1\mil{\strut\vfil}% + % + % TeX does not even consider page breaks if a penalty added to the + % main vertical list is 10000 or more. But in order to see if the + % empty box we just added fits on the page, we must make it consider + % page breaks. On the other hand, we don't want to actually break the + % page after the empty box. So we use a penalty of 9999. + % + % There is an extremely small chance that TeX will actually break the + % page at this \penalty, if there are no other feasible breakpoints in + % sight. (If the user is using lots of big @group commands, which + % almost-but-not-quite fill up a page, TeX will have a hard time doing + % good page breaking, for example.) However, I could not construct an + % example where a page broke at this \penalty; if it happens in a real + % document, then we can reconsider our strategy. + \penalty9999 + % + % Back up by the size of the box, whether we did a page break or not. + \kern -#1\mil + % + % Do not allow a page break right after this kern. + \nobreak + \fi +} + +% @br forces paragraph break (and is undocumented). + +\let\br = \par + +% @page forces the start of a new page. +% +\def\page{\par\vfill\supereject} + +% @exdent text.... +% outputs text on separate line in roman font, starting at standard page margin + +% This records the amount of indent in the innermost environment. +% That's how much \exdent should take out. +\newskip\exdentamount + +% This defn is used inside fill environments such as @defun. +\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} + +% This defn is used inside nofill environments such as @example. +\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount + \leftline{\hskip\leftskip{\rm#1}}}} + +% @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'. +% +\newskip\inmarginspacing \inmarginspacing=1cm +\def\strutdepth{\dp\strutbox} +% +\def\doinmargin#1#2{\strut\vadjust{% + \nobreak + \kern-\strutdepth + \vtop to \strutdepth{% + \baselineskip=\strutdepth + \vss + % if you have multiple lines of stuff to put here, you'll need to + % make the vbox yourself of the appropriate size. + \ifx#1l% + \llap{\ignorespaces #2\hskip\inmarginspacing}% + \else + \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% + \fi + \null + }% +}} +\def\inleftmargin{\doinmargin l} +\def\inrightmargin{\doinmargin r} +% +% @inmargin{TEXT [, RIGHT-TEXT]} +% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; +% else use TEXT for both). +% +\def\inmargin#1{\parseinmargin #1,,\finish} +\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0 > 0pt + \def\lefttext{#1}% have both texts + \def\righttext{#2}% + \else + \def\lefttext{#1}% have only one text + \def\righttext{#1}% + \fi + % + \ifodd\pageno + \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin + \else + \def\temp{\inleftmargin\lefttext}% + \fi + \temp +} + +% @include FILE -- \input text of FILE. +% +\def\include{\parseargusing\filenamecatcodes\includezzz} +\def\includezzz#1{% + \pushthisfilestack + \def\thisfile{#1}% + {% + \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. + \edef\temp{\noexpand\input #1 }% + % + % This trickery is to read FILE outside of a group, in case it makes + % definitions, etc. + \expandafter + }\temp + \popthisfilestack +} +\def\filenamecatcodes{% + \catcode`\\=\other + \catcode`~=\other + \catcode`^=\other + \catcode`_=\other + \catcode`|=\other + \catcode`<=\other + \catcode`>=\other + \catcode`+=\other + \catcode`-=\other + \catcode`\`=\other + \catcode`\'=\other +} + +\def\pushthisfilestack{% + \expandafter\pushthisfilestackX\popthisfilestack\StackTerm +} +\def\pushthisfilestackX{% + \expandafter\pushthisfilestackY\thisfile\StackTerm +} +\def\pushthisfilestackY #1\StackTerm #2\StackTerm {% + \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% +} + +\def\popthisfilestack{\errthisfilestackempty} +\def\errthisfilestackempty{\errmessage{Internal error: + the stack of filenames is empty.}} + +\def\thisfile{} + +% @center line +% outputs that line, centered. +% +\parseargdef\center{% + \ifhmode + \let\next\centerH + \else + \let\next\centerV + \fi + \next{\hfil \ignorespaces#1\unskip \hfil}% +} +\def\centerH#1{% + {% + \hfil\break + \advance\hsize by -\leftskip + \advance\hsize by -\rightskip + \line{#1}% + \break + }% +} +\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 +% We'll use ems for NCHARS, close enough. +% NCHARS can also be the word `asis' or `none'. +% We cannot feasibly implement @paragraphindent asis, though. +% +\def\asisword{asis} % no translation, these are keywords +\def\noneword{none} +% +\parseargdef\paragraphindent{% + \def\temp{#1}% + \ifx\temp\asisword + \else + \ifx\temp\noneword + \defaultparindent = 0pt + \else + \defaultparindent = #1em + \fi + \fi + \parindent = \defaultparindent +} + +% @exampleindent NCHARS +% We'll use ems for NCHARS like @paragraphindent. +% It seems @exampleindent asis isn't necessary, but +% I preserve it to make it similar to @paragraphindent. +\parseargdef\exampleindent{% + \def\temp{#1}% + \ifx\temp\asisword + \else + \ifx\temp\noneword + \lispnarrowing = 0pt + \else + \lispnarrowing = #1em + \fi + \fi +} + +% @firstparagraphindent WORD +% If WORD is `none', then suppress indentation of the first paragraph +% after a section heading. If WORD is `insert', then do indent at such +% paragraphs. +% +% The paragraph indentation is suppressed or not by calling +% \suppressfirstparagraphindent, which the sectioning commands do. +% We switch the definition of this back and forth according to WORD. +% By default, we suppress indentation. +% +\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} +\def\insertword{insert} +% +\parseargdef\firstparagraphindent{% + \def\temp{#1}% + \ifx\temp\noneword + \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent + \else\ifx\temp\insertword + \let\suppressfirstparagraphindent = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @firstparagraphindent option `\temp'}% + \fi\fi +} + +% Here is how we actually suppress indentation. Redefine \everypar to +% \kern backwards by \parindent, and then reset itself to empty. +% +% We also make \indent itself not actually do anything until the next +% paragraph. +% +\gdef\dosuppressfirstparagraphindent{% + \gdef\indent{% + \restorefirstparagraphindent + \indent + }% + \gdef\noindent{% + \restorefirstparagraphindent + \noindent + }% + \global\everypar = {% + \kern -\parindent + \restorefirstparagraphindent + }% +} + +\gdef\restorefirstparagraphindent{% + \global \let \indent = \ptexindent + \global \let \noindent = \ptexnoindent + \global \everypar = {}% +} + + +% @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 + +% If working on a large document in chapters, it is convenient to +% be able to disable indexing, cross-referencing, and contents, for test runs. +% This is done with @novalidate (before @setfilename). +% +\newif\iflinks \linkstrue % by default we want the aux files. +\let\novalidate = \linksfalse + +% @setfilename is done at the beginning of every texinfo file. +% So open here the files we need to have open while reading the input. +% This makes it possible to make a .fmt file for texinfo. +\def\setfilename{% + \fixbackslash % Turn off hack to swallow `\input texinfo'. + \iflinks + \tryauxfile + % Open the new aux file. TeX will close it automatically at exit. + \immediate\openout\auxfile=\jobname.aux + \fi % \openindices needs to do some work in any case. + \openindices + \let\setfilename=\comment % Ignore extra @setfilename cmds. + % + % If texinfo.cnf is present on the system, read it. + % Useful for site-wide @afourpaper, etc. + \openin 1 texinfo.cnf + \ifeof 1 \else \input texinfo.cnf \fi + \closein 1 + % + \comment % Ignore the actual filename. +} + +% Called from \setfilename. +% +\def\openindices{% + \newindex{cp}% + \newcodeindex{fn}% + \newcodeindex{vr}% + \newcodeindex{tp}% + \newcodeindex{ky}% + \newcodeindex{pg}% +} + +% @bye. +\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} + + +\message{pdf,} +% adobe `portable' document format +\newcount\tempnum +\newcount\lnkcount +\newtoks\filename +\newcount\filenamelength +\newcount\pgn +\newtoks\toksA +\newtoks\toksB +\newtoks\toksC +\newtoks\toksD +\newbox\boxA +\newcount\countA +\newif\ifpdf +\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 +\else + \ifx\pdfoutput\relax + \else + \ifcase\pdfoutput + \else + \pdftrue + \fi + \fi +\fi + +% PDF uses PostScript string constants for the names of xref targets, +% 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}% +} + +\newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images +with PDF output, and none of those formats could be found. (.eps cannot +be supported due to the design of the PDF format; use regular TeX (DVI +output) for that.)} + +\ifpdf + % + % Color manipulation macros based on pdfcolor.tex, + % except using rgb instead of cmyk; the latter is said to render as a + % very dark gray on-screen and a very dark halftone in print, instead + % of actual black. + \def\rgbDarkRed{0.50 0.09 0.12} + \def\rgbBlack{0 0 0} + % + % k sets the color for filling (usual text, etc.); + % K sets the color for stroking (thin rules, e.g., normal _'s). + \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}} + % + % Set color, and create a mark which defines \thiscolor accordingly, + % so that \makeheadline knows which color to restore. + \def\setcolor#1{% + \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}% + \domark + \pdfsetcolor{#1}% + } + % + \def\maincolor{\rgbBlack} + \pdfsetcolor{\maincolor} + \edef\thiscolor{\maincolor} + \def\lastcolordefs{} + % + \def\makefootline{% + \baselineskip24pt + \line{\pdfsetcolor{\maincolor}\the\footline}% + } + % + \def\makeheadline{% + \vbox to 0pt{% + \vskip-22.5pt + \line{% + \vbox to8.5pt{}% + % Extract \thiscolor definition from the marks. + \getcolormarks + % Typeset the headline with \maincolor, then restore the color. + \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}% + }% + \vss + }% + \nointerlineskip + } + % + % + \pdfcatalog{/PageMode /UseOutlines} + % + % #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}% + % + % pdftex (and the PDF format) support .png, .jpg, .pdf (among + % others). Let's try in that order. + \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 + \errhelp = \nopdfimagehelp + \errmessage{Could not find image file #1 for pdf}% + \else \gdef\pdfimgext{PDF}% + \fi + \else \gdef\pdfimgext{pdf}% + \fi + \else \gdef\pdfimgext{JPG}% + \fi + \else \gdef\pdfimgext{jpeg}% + \fi + \else \gdef\pdfimgext{jpg}% + \fi + \else \gdef\pdfimgext{png}% + \fi + \closein 1 + \endgroup + % + % without \immediate, ancient pdftex seg faults when the same image is + % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) + \ifnum\pdftexversion < 14 + \immediate\pdfimage + \else + \immediate\pdfximage + \fi + \ifdim \wd0 >0pt width \imagewidth \fi + \ifdim \wd2 >0pt height \imageheight \fi + \ifnum\pdftexversion<13 + #1.\pdfimgext + \else + {#1.\pdfimgext}% + \fi + \ifnum\pdftexversion < 14 \else + \pdfrefximage \pdflastximage + \fi} + % + \def\pdfmkdest#1{{% + % We have to set dummies so commands such as @code, and characters + % such as \, aren't expanded when present in a section title. + \indexnofonts + \turnoffactive + \activebackslashdouble + \makevalueexpandable + \def\pdfdestname{#1}% + \backslashparens\pdfdestname + \safewhatsit{\pdfdest name{\pdfdestname} xyz}% + }} + % + % used to mark target names; must be expandable. + \def\pdfmkpgn#1{#1} + % + % by default, use a color that is dark enough to print on paper as + % nearly black, but still distinguishable for online viewing. + \def\urlcolor{\rgbDarkRed} + \def\linkcolor{\rgbDarkRed} + \def\endlink{\setcolor{\maincolor}\pdfendlink} + % + % Adding outlines to PDF; macros for calculating structure of outlines + % come from Petr Olsak + \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% + \else \csname#1\endcsname \fi} + \def\advancenumber#1{\tempnum=\expnumber{#1}\relax + \advance\tempnum by 1 + \expandafter\xdef\csname#1\endcsname{\the\tempnum}} + % + % #1 is the section text, which is what will be displayed in the + % outline by the pdf viewer. #2 is the pdf expression for the number + % of subentries (or empty, for subsubsections). #3 is the node text, + % which might be empty if this toc entry had no corresponding node. + % #4 is the page number + % + \def\dopdfoutline#1#2#3#4{% + % Generate a link to the node text if that exists; else, use the + % 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}% + \ifx\pdfoutlinedest\empty + \def\pdfoutlinedest{#4}% + \else + % Doubled backslashes in the name. + {\activebackslashdouble \xdef\pdfoutlinedest{#3}% + \backslashparens\pdfoutlinedest}% + \fi + % + % Also double the backslashes in the display string. + {\activebackslashdouble \xdef\pdfoutlinetext{#1}% + \backslashparens\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\numchapentry##1##2##3##4{% + \def\thischapnum{##2}% + \def\thissecnum{0}% + \def\thissubsecnum{0}% + }% + \def\numsecentry##1##2##3##4{% + \advancenumber{chap\thischapnum}% + \def\thissecnum{##2}% + \def\thissubsecnum{0}% + }% + \def\numsubsecentry##1##2##3##4{% + \advancenumber{sec\thissecnum}% + \def\thissubsecnum{##2}% + }% + \def\numsubsubsecentry##1##2##3##4{% + \advancenumber{subsec\thissubsecnum}% + }% + \def\thischapnum{0}% + \def\thissecnum{0}% + \def\thissubsecnum{0}% + % + % use \def rather than \let here because we redefine \chapentry et + % al. a second time, below. + \def\appentry{\numchapentry}% + \def\appsecentry{\numsecentry}% + \def\appsubsecentry{\numsubsecentry}% + \def\appsubsubsecentry{\numsubsubsecentry}% + \def\unnchapentry{\numchapentry}% + \def\unnsecentry{\numsecentry}% + \def\unnsubsecentry{\numsubsecentry}% + \def\unnsubsubsecentry{\numsubsubsecentry}% + \readdatafile{toc}% + % + % Read toc second time, this time actually producing the outlines. + % The `-' means take the \expnumber as the absolute number of + % subentries, which we calculated on our first read of the .toc above. + % + % We use the node names as the destinations. + \def\numchapentry##1##2##3##4{% + \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% + \def\numsecentry##1##2##3##4{% + \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% + \def\numsubsecentry##1##2##3##4{% + \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% + \def\numsubsubsecentry##1##2##3##4{% count is always zero + \dopdfoutline{##1}{}{##3}{##4}}% + % + % PDF outlines are displayed using system fonts, instead of + % document fonts. Therefore we cannot use special characters, + % since the encoding is unknown. For example, the eogonek from + % 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. + \indexnofonts + \setupdatafile + \catcode`\\=\active \otherbackslash + \input \tocreadfilename + \endgroup + } + % + \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 + \fi + \nextsp} + \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} + \ifnum\pdftexversion < 14 + \let \startlink \pdfannotlink + \else + \let \startlink \pdfstartlink + \fi + % make a live url in pdf output. + \def\pdfurl#1{% + \begingroup + % it seems we really need yet another set of dummies; have not + % tried to figure out what each command should do in the context + % of @url. for now, just make @/ a no-op, that's the only one + % people have actually reported a problem with. + % + \normalturnoffactive + \def\@{@}% + \let\/=\empty + \makevalueexpandable + % do we want to go so far as to use \indexnofonts instead of just + % special-casing \var here? + \def\var##1{##1}% + % + \leavevmode\setcolor{\urlcolor}% + \startlink attr{/Border [0 0 0]}% + user{/Subtype /Link /A << /S /URI /URI (#1) >>}% + \endgroup} + \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} + \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} + \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} + \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} + \def\maketoks{% + \expandafter\poptoks\the\toksA|ENDTOKS|\relax + \ifx\first0\adn0 + \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 + \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 + \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 + \else + \ifnum0=\countA\else\makelink\fi + \ifx\first.\let\next=\done\else + \let\next=\maketoks + \addtokens{\toksB}{\the\toksD} + \ifx\first,\addtokens{\toksB}{\space}\fi + \fi + \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi + \next} + \def\makelink{\addtokens{\toksB}% + {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} + \def\pdflink#1{% + \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} + \setcolor{\linkcolor}#1\endlink} + \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} +\else + % non-pdf mode + \let\pdfmkdest = \gobble + \let\pdfurl = \gobble + \let\endlink = \relax + \let\setcolor = \gobble + \let\pdfsetcolor = \gobble + \let\pdfmakeoutlines = \relax +\fi % \ifx\pdfoutput + + +\message{fonts,} + +% Change the current font style to #1, remembering it in \curfontstyle. +% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in +% italics, not bold italics. +% +\def\setfontstyle#1{% + \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. + \csname ten#1\endcsname % change the current font +} + +% Select #1 fonts with the current style. +% +\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} + +\def\rm{\fam=0 \setfontstyle{rm}} +\def\it{\fam=\itfam \setfontstyle{it}} +\def\sl{\fam=\slfam \setfontstyle{sl}} +\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} +\def\tt{\fam=\ttfam \setfontstyle{tt}} + +% Unfortunately, we have to override this for titles and the like, since +% in those cases "rm" is bold. Sigh. +\def\rmisbold{\rm\def\curfontstyle{bf}} + +% Texinfo sort of supports the sans serif font style, which plain TeX does not. +% So we set up a \sf. +\newfam\sffam +\def\sf{\fam=\sffam \setfontstyle{sf}} +\let\li = \sf % Sometimes we call it \li, not \sf. + +% We don't need math for this font style. +\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. +% +\def\lineskipfactor{.08333} +\def\strutheightpercent{.70833} +\def\strutdepthpercent {.29167} +% +% can get a sort of poor man's double spacing by redefining this. +\def\baselinefactor{1} +% +\def\setleading#1{% + \dimen0 = #1\relax + \normalbaselineskip = \baselinefactor\dimen0 + \normallineskip = \lineskipfactor\normalbaselineskip + \normalbaselines + \setbox\strutbox =\hbox{% + \vrule width0pt height\strutheightpercent\baselineskip + depth \strutdepthpercent \baselineskip + }% +} + +% PDF CMaps. See also LaTeX's t1.cmap. +% +% do nothing with this by default. +\expandafter\let\csname cmapOT1\endcsname\gobble +\expandafter\let\csname cmapOT1IT\endcsname\gobble +\expandafter\let\csname cmapOT1TT\endcsname\gobble + +% 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 + \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 +%%DocumentNeededResources: ProcSet (CIDInit) +%%IncludeResource: ProcSet (CIDInit) +%%BeginResource: CMap (TeX-OT1-0) +%%Title: (TeX-OT1-0 TeX OT1 0) +%%Version: 1.000 +%%EndComments +/CIDInit /ProcSet findresource begin +12 dict begin +begincmap +/CIDSystemInfo +<< /Registry (TeX) +/Ordering (OT1) +/Supplement 0 +>> def +/CMapName /TeX-OT1-0 def +/CMapType 2 def +1 begincodespacerange +<00> <7F> +endcodespacerange +8 beginbfrange +<00> <01> <0393> +<09> <0A> <03A8> +<23> <26> <0023> +<28> <3B> <0028> +<3F> <5B> <003F> +<5D> <5E> <005D> +<61> <7A> <0061> +<7B> <7C> <2013> +endbfrange +40 beginbfchar +<02> <0398> +<03> <039B> +<04> <039E> +<05> <03A0> +<06> <03A3> +<07> <03D2> +<08> <03A6> +<0B> <00660066> +<0C> <00660069> +<0D> <0066006C> +<0E> <006600660069> +<0F> <00660066006C> +<10> <0131> +<11> <0237> +<12> <0060> +<13> <00B4> +<14> <02C7> +<15> <02D8> +<16> <00AF> +<17> <02DA> +<18> <00B8> +<19> <00DF> +<1A> <00E6> +<1B> <0153> +<1C> <00F8> +<1D> <00C6> +<1E> <0152> +<1F> <00D8> +<21> <0021> +<22> <201D> +<27> <2019> +<3C> <00A1> +<3D> <003D> +<3E> <00BF> +<5C> <201C> +<5F> <02D9> +<60> <2018> +<7D> <02DD> +<7E> <007E> +<7F> <00A8> +endbfchar +endcmap +CMapName currentdict /CMap defineresource pop +end +end +%%EndResource +%%EOF + }\endgroup + \expandafter\edef\csname cmapOT1\endcsname#1{% + \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% + }% +% +% \cmapOT1IT + \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 +%%DocumentNeededResources: ProcSet (CIDInit) +%%IncludeResource: ProcSet (CIDInit) +%%BeginResource: CMap (TeX-OT1IT-0) +%%Title: (TeX-OT1IT-0 TeX OT1IT 0) +%%Version: 1.000 +%%EndComments +/CIDInit /ProcSet findresource begin +12 dict begin +begincmap +/CIDSystemInfo +<< /Registry (TeX) +/Ordering (OT1IT) +/Supplement 0 +>> def +/CMapName /TeX-OT1IT-0 def +/CMapType 2 def +1 begincodespacerange +<00> <7F> +endcodespacerange +8 beginbfrange +<00> <01> <0393> +<09> <0A> <03A8> +<25> <26> <0025> +<28> <3B> <0028> +<3F> <5B> <003F> +<5D> <5E> <005D> +<61> <7A> <0061> +<7B> <7C> <2013> +endbfrange +42 beginbfchar +<02> <0398> +<03> <039B> +<04> <039E> +<05> <03A0> +<06> <03A3> +<07> <03D2> +<08> <03A6> +<0B> <00660066> +<0C> <00660069> +<0D> <0066006C> +<0E> <006600660069> +<0F> <00660066006C> +<10> <0131> +<11> <0237> +<12> <0060> +<13> <00B4> +<14> <02C7> +<15> <02D8> +<16> <00AF> +<17> <02DA> +<18> <00B8> +<19> <00DF> +<1A> <00E6> +<1B> <0153> +<1C> <00F8> +<1D> <00C6> +<1E> <0152> +<1F> <00D8> +<21> <0021> +<22> <201D> +<23> <0023> +<24> <00A3> +<27> <2019> +<3C> <00A1> +<3D> <003D> +<3E> <00BF> +<5C> <201C> +<5F> <02D9> +<60> <2018> +<7D> <02DD> +<7E> <007E> +<7F> <00A8> +endbfchar +endcmap +CMapName currentdict /CMap defineresource pop +end +end +%%EndResource +%%EOF + }\endgroup + \expandafter\edef\csname cmapOT1IT\endcsname#1{% + \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% + }% +% +% \cmapOT1TT + \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 +%%DocumentNeededResources: ProcSet (CIDInit) +%%IncludeResource: ProcSet (CIDInit) +%%BeginResource: CMap (TeX-OT1TT-0) +%%Title: (TeX-OT1TT-0 TeX OT1TT 0) +%%Version: 1.000 +%%EndComments +/CIDInit /ProcSet findresource begin +12 dict begin +begincmap +/CIDSystemInfo +<< /Registry (TeX) +/Ordering (OT1TT) +/Supplement 0 +>> def +/CMapName /TeX-OT1TT-0 def +/CMapType 2 def +1 begincodespacerange +<00> <7F> +endcodespacerange +5 beginbfrange +<00> <01> <0393> +<09> <0A> <03A8> +<21> <26> <0021> +<28> <5F> <0028> +<61> <7E> <0061> +endbfrange +32 beginbfchar +<02> <0398> +<03> <039B> +<04> <039E> +<05> <03A0> +<06> <03A3> +<07> <03D2> +<08> <03A6> +<0B> <2191> +<0C> <2193> +<0D> <0027> +<0E> <00A1> +<0F> <00BF> +<10> <0131> +<11> <0237> +<12> <0060> +<13> <00B4> +<14> <02C7> +<15> <02D8> +<16> <00AF> +<17> <02DA> +<18> <00B8> +<19> <00DF> +<1A> <00E6> +<1B> <0153> +<1C> <00F8> +<1D> <00C6> +<1E> <0152> +<1F> <00D8> +<20> <2423> +<27> <2019> +<60> <2018> +<7F> <00A8> +endbfchar +endcmap +CMapName currentdict /CMap defineresource pop +end +end +%%EndResource +%%EOF + }\endgroup + \expandafter\edef\csname cmapOT1TT\endcsname#1{% + \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% + }% +\fi\fi + + +% Set the font macro #1 to the font named #2, adding on the +% specified font prefix (normally `cm'). +% #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). +\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 + +% 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 +\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\bfshape{b} +\def\bxshape{bx} +\def\ttshape{tt} +\def\ttbshape{tt} +\def\ttslshape{sltt} +\def\itshape{ti} +\def\itbshape{bxti} +\def\slshape{sl} +\def\slbshape{bxsl} +\def\sfshape{ss} +\def\sfbshape{ss} +\def\scshape{csc} +\def\scbshape{csc} + +% Definitions for a main text size of 11pt. This is the default in +% Texinfo. +% +\def\definetextfontsizexi{% +% Text fonts (11.2pt, magstep1). +\def\textnominalsize{11pt} +\edef\mainmagstep{\magstephalf} +\setfont\textrm\rmshape{10}{\mainmagstep}{OT1} +\setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT} +\setfont\textbf\bfshape{10}{\mainmagstep}{OT1} +\setfont\textit\itshape{10}{\mainmagstep}{OT1IT} +\setfont\textsl\slshape{10}{\mainmagstep}{OT1} +\setfont\textsf\sfshape{10}{\mainmagstep}{OT1} +\setfont\textsc\scshape{10}{\mainmagstep}{OT1} +\setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT} +\font\texti=cmmi10 scaled \mainmagstep +\font\textsy=cmsy10 scaled \mainmagstep +\def\textecsize{1095} + +% A few fonts for @defun names and args. +\setfont\defbf\bfshape{10}{\magstep1}{OT1} +\setfont\deftt\ttshape{10}{\magstep1}{OT1TT} +\setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT} +\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} + +% Fonts for indices, footnotes, small examples (9pt). +\def\smallnominalsize{9pt} +\setfont\smallrm\rmshape{9}{1000}{OT1} +\setfont\smalltt\ttshape{9}{1000}{OT1TT} +\setfont\smallbf\bfshape{10}{900}{OT1} +\setfont\smallit\itshape{9}{1000}{OT1IT} +\setfont\smallsl\slshape{9}{1000}{OT1} +\setfont\smallsf\sfshape{9}{1000}{OT1} +\setfont\smallsc\scshape{10}{900}{OT1} +\setfont\smallttsl\ttslshape{10}{900}{OT1TT} +\font\smalli=cmmi9 +\font\smallsy=cmsy9 +\def\smallecsize{0900} + +% Fonts for small examples (8pt). +\def\smallernominalsize{8pt} +\setfont\smallerrm\rmshape{8}{1000}{OT1} +\setfont\smallertt\ttshape{8}{1000}{OT1TT} +\setfont\smallerbf\bfshape{10}{800}{OT1} +\setfont\smallerit\itshape{8}{1000}{OT1IT} +\setfont\smallersl\slshape{8}{1000}{OT1} +\setfont\smallersf\sfshape{8}{1000}{OT1} +\setfont\smallersc\scshape{10}{800}{OT1} +\setfont\smallerttsl\ttslshape{10}{800}{OT1TT} +\font\smalleri=cmmi8 +\font\smallersy=cmsy8 +\def\smallerecsize{0800} + +% Fonts for title page (20.4pt): +\def\titlenominalsize{20pt} +\setfont\titlerm\rmbshape{12}{\magstep3}{OT1} +\setfont\titleit\itbshape{10}{\magstep4}{OT1IT} +\setfont\titlesl\slbshape{10}{\magstep4}{OT1} +\setfont\titlett\ttbshape{12}{\magstep3}{OT1TT} +\setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT} +\setfont\titlesf\sfbshape{17}{\magstep1}{OT1} +\let\titlebf=\titlerm +\setfont\titlesc\scbshape{10}{\magstep4}{OT1} +\font\titlei=cmmi12 scaled \magstep3 +\font\titlesy=cmsy10 scaled \magstep4 +\def\titleecsize{2074} + +% Chapter (and unnumbered) fonts (17.28pt). +\def\chapnominalsize{17pt} +\setfont\chaprm\rmbshape{12}{\magstep2}{OT1} +\setfont\chapit\itbshape{10}{\magstep3}{OT1IT} +\setfont\chapsl\slbshape{10}{\magstep3}{OT1} +\setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT} +\setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT} +\setfont\chapsf\sfbshape{17}{1000}{OT1} +\let\chapbf=\chaprm +\setfont\chapsc\scbshape{10}{\magstep3}{OT1} +\font\chapi=cmmi12 scaled \magstep2 +\font\chapsy=cmsy10 scaled \magstep3 +\def\chapecsize{1728} + +% Section fonts (14.4pt). +\def\secnominalsize{14pt} +\setfont\secrm\rmbshape{12}{\magstep1}{OT1} +\setfont\secit\itbshape{10}{\magstep2}{OT1IT} +\setfont\secsl\slbshape{10}{\magstep2}{OT1} +\setfont\sectt\ttbshape{12}{\magstep1}{OT1TT} +\setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT} +\setfont\secsf\sfbshape{12}{\magstep1}{OT1} +\let\secbf\secrm +\setfont\secsc\scbshape{10}{\magstep2}{OT1} +\font\seci=cmmi12 scaled \magstep1 +\font\secsy=cmsy10 scaled \magstep2 +\def\sececsize{1440} + +% Subsection fonts (13.15pt). +\def\ssecnominalsize{13pt} +\setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1} +\setfont\ssecit\itbshape{10}{1315}{OT1IT} +\setfont\ssecsl\slbshape{10}{1315}{OT1} +\setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT} +\setfont\ssecttsl\ttslshape{10}{1315}{OT1TT} +\setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1} +\let\ssecbf\ssecrm +\setfont\ssecsc\scbshape{10}{1315}{OT1} +\font\sseci=cmmi12 scaled \magstephalf +\font\ssecsy=cmsy10 scaled 1315 +\def\ssececsize{1200} + +% Reduced fonts for @acro in text (10pt). +\def\reducednominalsize{10pt} +\setfont\reducedrm\rmshape{10}{1000}{OT1} +\setfont\reducedtt\ttshape{10}{1000}{OT1TT} +\setfont\reducedbf\bfshape{10}{1000}{OT1} +\setfont\reducedit\itshape{10}{1000}{OT1IT} +\setfont\reducedsl\slshape{10}{1000}{OT1} +\setfont\reducedsf\sfshape{10}{1000}{OT1} +\setfont\reducedsc\scshape{10}{1000}{OT1} +\setfont\reducedttsl\ttslshape{10}{1000}{OT1TT} +\font\reducedi=cmmi10 +\font\reducedsy=cmsy10 +\def\reducedecsize{1000} + +% reset the current fonts +\textfonts +\rm +} % end of 11pt text font size definitions + + +% Definitions to make the main text be 10pt Computer Modern, with +% section, chapter, etc., sizes following suit. This is for the GNU +% Press printing of the Emacs 22 manual. Maybe other manuals in the +% future. Used with @smallbook, which sets the leading to 12pt. +% +\def\definetextfontsizex{% +% Text fonts (10pt). +\def\textnominalsize{10pt} +\edef\mainmagstep{1000} +\setfont\textrm\rmshape{10}{\mainmagstep}{OT1} +\setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT} +\setfont\textbf\bfshape{10}{\mainmagstep}{OT1} +\setfont\textit\itshape{10}{\mainmagstep}{OT1IT} +\setfont\textsl\slshape{10}{\mainmagstep}{OT1} +\setfont\textsf\sfshape{10}{\mainmagstep}{OT1} +\setfont\textsc\scshape{10}{\mainmagstep}{OT1} +\setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT} +\font\texti=cmmi10 scaled \mainmagstep +\font\textsy=cmsy10 scaled \mainmagstep +\def\textecsize{1000} + +% A few fonts for @defun names and args. +\setfont\defbf\bfshape{10}{\magstephalf}{OT1} +\setfont\deftt\ttshape{10}{\magstephalf}{OT1TT} +\setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT} +\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} + +% Fonts for indices, footnotes, small examples (9pt). +\def\smallnominalsize{9pt} +\setfont\smallrm\rmshape{9}{1000}{OT1} +\setfont\smalltt\ttshape{9}{1000}{OT1TT} +\setfont\smallbf\bfshape{10}{900}{OT1} +\setfont\smallit\itshape{9}{1000}{OT1IT} +\setfont\smallsl\slshape{9}{1000}{OT1} +\setfont\smallsf\sfshape{9}{1000}{OT1} +\setfont\smallsc\scshape{10}{900}{OT1} +\setfont\smallttsl\ttslshape{10}{900}{OT1TT} +\font\smalli=cmmi9 +\font\smallsy=cmsy9 +\def\smallecsize{0900} + +% Fonts for small examples (8pt). +\def\smallernominalsize{8pt} +\setfont\smallerrm\rmshape{8}{1000}{OT1} +\setfont\smallertt\ttshape{8}{1000}{OT1TT} +\setfont\smallerbf\bfshape{10}{800}{OT1} +\setfont\smallerit\itshape{8}{1000}{OT1IT} +\setfont\smallersl\slshape{8}{1000}{OT1} +\setfont\smallersf\sfshape{8}{1000}{OT1} +\setfont\smallersc\scshape{10}{800}{OT1} +\setfont\smallerttsl\ttslshape{10}{800}{OT1TT} +\font\smalleri=cmmi8 +\font\smallersy=cmsy8 +\def\smallerecsize{0800} + +% Fonts for title page (20.4pt): +\def\titlenominalsize{20pt} +\setfont\titlerm\rmbshape{12}{\magstep3}{OT1} +\setfont\titleit\itbshape{10}{\magstep4}{OT1IT} +\setfont\titlesl\slbshape{10}{\magstep4}{OT1} +\setfont\titlett\ttbshape{12}{\magstep3}{OT1TT} +\setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT} +\setfont\titlesf\sfbshape{17}{\magstep1}{OT1} +\let\titlebf=\titlerm +\setfont\titlesc\scbshape{10}{\magstep4}{OT1} +\font\titlei=cmmi12 scaled \magstep3 +\font\titlesy=cmsy10 scaled \magstep4 +\def\titleecsize{2074} + +% Chapter fonts (14.4pt). +\def\chapnominalsize{14pt} +\setfont\chaprm\rmbshape{12}{\magstep1}{OT1} +\setfont\chapit\itbshape{10}{\magstep2}{OT1IT} +\setfont\chapsl\slbshape{10}{\magstep2}{OT1} +\setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT} +\setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT} +\setfont\chapsf\sfbshape{12}{\magstep1}{OT1} +\let\chapbf\chaprm +\setfont\chapsc\scbshape{10}{\magstep2}{OT1} +\font\chapi=cmmi12 scaled \magstep1 +\font\chapsy=cmsy10 scaled \magstep2 +\def\chapecsize{1440} + +% Section fonts (12pt). +\def\secnominalsize{12pt} +\setfont\secrm\rmbshape{12}{1000}{OT1} +\setfont\secit\itbshape{10}{\magstep1}{OT1IT} +\setfont\secsl\slbshape{10}{\magstep1}{OT1} +\setfont\sectt\ttbshape{12}{1000}{OT1TT} +\setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT} +\setfont\secsf\sfbshape{12}{1000}{OT1} +\let\secbf\secrm +\setfont\secsc\scbshape{10}{\magstep1}{OT1} +\font\seci=cmmi12 +\font\secsy=cmsy10 scaled \magstep1 +\def\sececsize{1200} + +% Subsection fonts (10pt). +\def\ssecnominalsize{10pt} +\setfont\ssecrm\rmbshape{10}{1000}{OT1} +\setfont\ssecit\itbshape{10}{1000}{OT1IT} +\setfont\ssecsl\slbshape{10}{1000}{OT1} +\setfont\ssectt\ttbshape{10}{1000}{OT1TT} +\setfont\ssecttsl\ttslshape{10}{1000}{OT1TT} +\setfont\ssecsf\sfbshape{10}{1000}{OT1} +\let\ssecbf\ssecrm +\setfont\ssecsc\scbshape{10}{1000}{OT1} +\font\sseci=cmmi10 +\font\ssecsy=cmsy10 +\def\ssececsize{1000} + +% Reduced fonts for @acro in text (9pt). +\def\reducednominalsize{9pt} +\setfont\reducedrm\rmshape{9}{1000}{OT1} +\setfont\reducedtt\ttshape{9}{1000}{OT1TT} +\setfont\reducedbf\bfshape{10}{900}{OT1} +\setfont\reducedit\itshape{9}{1000}{OT1IT} +\setfont\reducedsl\slshape{9}{1000}{OT1} +\setfont\reducedsf\sfshape{9}{1000}{OT1} +\setfont\reducedsc\scshape{10}{900}{OT1} +\setfont\reducedttsl\ttslshape{10}{900}{OT1TT} +\font\reducedi=cmmi9 +\font\reducedsy=cmsy9 +\def\reducedecsize{0900} + +% reduce space between paragraphs +\divide\parskip by 2 + +% reset the current fonts +\textfonts +\rm +} % end of 10pt text font size definitions + + +% 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} +% +\parseargdef\fonttextsize{% + \def\textsizearg{#1}% + \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. + % + \begingroup \globaldefs=1 + \ifx\textsizearg\xword \definetextfontsizex + \else \ifx\textsizearg\xiword \definetextfontsizexi + \else + \errhelp=\EMsimple + \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'} + \fi\fi + \endgroup +} + + +% In order for the font changes to affect most math symbols and letters, +% we have to define the \textfont of the standard families. Since +% texinfo doesn't allow for producing subscripts and superscripts except +% in the main text, we don't bother to reset \scriptfont and +% \scriptscriptfont (which would also require loading a lot more fonts). +% +\def\resetmathfonts{% + \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy + \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf + \textfont\ttfam=\tentt \textfont\sffam=\tensf +} + +% The font-changing commands redefine the meanings of \tenSTYLE, instead +% of just \STYLE. We do this because \STYLE needs to also set the +% current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire +% \tenSTYLE to set the current font. +% +% Each font-changing command also sets the names \lsize (one size lower) +% and \lllsize (three sizes lower). These relative commands are used in +% the LaTeX logo and acronyms. +% +% This all needs generalizing, badly. +% +\def\textfonts{% + \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl + \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc + \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy + \let\tenttsl=\textttsl + \def\curfontsize{text}% + \def\lsize{reduced}\def\lllsize{smaller}% + \resetmathfonts \setleading{\textleading}} +\def\titlefonts{% + \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl + \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc + \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy + \let\tenttsl=\titlettsl + \def\curfontsize{title}% + \def\lsize{chap}\def\lllsize{subsec}% + \resetmathfonts \setleading{25pt}} +\def\titlefont#1{{\titlefonts\rmisbold #1}} +\def\chapfonts{% + \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl + \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc + \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy + \let\tenttsl=\chapttsl + \def\curfontsize{chap}% + \def\lsize{sec}\def\lllsize{text}% + \resetmathfonts \setleading{19pt}} +\def\secfonts{% + \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl + \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc + \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy + \let\tenttsl=\secttsl + \def\curfontsize{sec}% + \def\lsize{subsec}\def\lllsize{reduced}% + \resetmathfonts \setleading{16pt}} +\def\subsecfonts{% + \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl + \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc + \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy + \let\tenttsl=\ssecttsl + \def\curfontsize{ssec}% + \def\lsize{text}\def\lllsize{small}% + \resetmathfonts \setleading{15pt}} +\let\subsubsecfonts = \subsecfonts +\def\reducedfonts{% + \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl + \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc + \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy + \let\tenttsl=\reducedttsl + \def\curfontsize{reduced}% + \def\lsize{small}\def\lllsize{smaller}% + \resetmathfonts \setleading{10.5pt}} +\def\smallfonts{% + \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl + \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc + \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy + \let\tenttsl=\smallttsl + \def\curfontsize{small}% + \def\lsize{smaller}\def\lllsize{smaller}% + \resetmathfonts \setleading{10.5pt}} +\def\smallerfonts{% + \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl + \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc + \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy + \let\tenttsl=\smallerttsl + \def\curfontsize{smaller}% + \def\lsize{smaller}\def\lllsize{smaller}% + \resetmathfonts \setleading{9.5pt}} + +% Fonts for short table of contents. +\setfont\shortcontrm\rmshape{12}{1000}{OT1} +\setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12 +\setfont\shortcontsl\slshape{12}{1000}{OT1} +\setfont\shortconttt\ttshape{12}{1000}{OT1TT} + +% Define these just so they can be easily changed for other fonts. +\def\angleleft{$\langle$} +\def\angleright{$\rangle$} + +% Set the fonts to use with the @small... environments. +\let\smallexamplefonts = \smallfonts + +% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample +% can fit this many characters: +% 8.5x11=86 smallbook=72 a4=90 a5=69 +% If we use \scriptfonts (8pt), then we can fit this many characters: +% 8.5x11=90+ smallbook=80 a4=90+ a5=77 +% For me, subjectively, the few extra characters that fit aren't worth +% the additional smallness of 8pt. So I'm making the default 9pt. +% +% By the way, for comparison, here's what fits with @example (10pt): +% 8.5x11=71 smallbook=60 a4=75 a5=58 +% --karl, 24jan03. + +% Set up the default fonts, so we can use them for creating boxes. +% +\definetextfontsizexi + + +\message{markup,} + +% Check if we are currently using a typewriter font. Since all the +% Computer Modern typewriter fonts have zero interword stretch (and +% shrink), and it is reasonable to expect all typewriter fonts to have +% this property, we can check that font parameter. +% +\def\ifmonospace{\ifdim\fontdimen3\font=0pt } + +% Markup style infrastructure. \defmarkupstylesetup\INITMACRO will +% define and register \INITMACRO to be called on markup style changes. +% \INITMACRO can check \currentmarkupstyle for the innermost +% style and the set of \ifmarkupSTYLE switches for all styles +% currently in effect. +\newif\ifmarkupvar +\newif\ifmarkupsamp +\newif\ifmarkupkey +%\newif\ifmarkupfile % @file == @samp. +%\newif\ifmarkupoption % @option == @samp. +\newif\ifmarkupcode +\newif\ifmarkupkbd +%\newif\ifmarkupenv % @env == @code. +%\newif\ifmarkupcommand % @command == @code. +\newif\ifmarkuptex % @tex (and part of @math, for now). +\newif\ifmarkupexample +\newif\ifmarkupverb +\newif\ifmarkupverbatim + +\let\currentmarkupstyle\empty + +\def\setupmarkupstyle#1{% + \csname markup#1true\endcsname + \def\currentmarkupstyle{#1}% + \markupstylesetup +} + +\let\markupstylesetup\empty + +\def\defmarkupstylesetup#1{% + \expandafter\def\expandafter\markupstylesetup + \expandafter{\markupstylesetup #1}% + \def#1% +} + +% Markup style setup for left and right quotes. +\defmarkupstylesetup\markupsetuplq{% + \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 + \ifx\temp\relax \markupsetuprqdefault \else \temp \fi +} + +{ +\catcode`\'=\active +\catcode`\`=\active + +\gdef\markupsetuplqdefault{\let`\lq} +\gdef\markupsetuprqdefault{\let'\rq} + +\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\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. +% +\def\codequoteright{% + \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax + \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax + '% + \else \char'15 \fi + \else \char'15 \fi +} +% +% and a similar option for the left quote char vs. a grave accent. +% Modern fonts display ASCII 0x60 as a grave accent, so some people like +% the code environments to do likewise. +% +\def\codequoteleft{% + \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax + \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax + % [Knuth] pp. 380,381,391 + % \relax disables Spanish ligatures ?` and !` of \tt font. + \relax`% + \else \char'22 \fi + \else \char'22 \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 + +% \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} + +% like \smartslanted except unconditionally uses \ttsl. +% @var is set to this for defun arguments. +\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} + +% @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} + +\let\i=\smartitalic +\let\slanted=\smartslanted +\def\var#1{{\setupmarkupstyle{var}\smartslanted{#1}}} +\let\dfn=\smartslanted +\let\emph=\smartitalic + +% Explicit font changes: @r, @sc, undocumented @ii. +\def\r#1{{\rm #1}} % roman font +\def\sc#1{{\smallcaps#1}} % smallcaps font +\def\ii#1{{\it #1}} % italic font + +% @b, explicit bold. Also @strong. +\def\b#1{{\bf #1}} +\let\strong=\b + +% @sansserif, explicit sans. +\def\sansserif#1{{\sf #1}} + +% We can't just use \exhyphenpenalty, because that only has effect at +% the end of a paragraph. Restore normal hyphenation at the end of the +% group within which \nohyphenation is presumably called. +% +\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} +\def\restorehyphenation{\hyphenchar\font = `- } + +% Set sfcode to normal for the chars that usually have another value. +% Can't use plain's \frenchspacing because it uses the `\x notation, and +% sometimes \x has an active definition that messes things up. +% +\catcode`@=11 + \def\plainfrenchspacing{% + \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m + \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m + \def\endofsentencespacefactor{1000}% for @. and friends + } + \def\plainnonfrenchspacing{% + \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000 + \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250 + \def\endofsentencespacefactor{3000}% for @. and friends + } +\catcode`@=\other +\def\endofsentencespacefactor{3000}% default + +% @t, explicit typewriter. +\def\t#1{% + {\tt \rawbackslash \plainfrenchspacing #1}% + \null +} + +% @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}}}} + +% 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. +\def\tclose#1{% + {% + % Change normal interword space to be same as for the current font. + \spaceskip = \fontdimen2\font + % + % Switch to typewriter. + \tt + % + % But `\ ' produces the large typewriter interword space. + \def\ {{\spaceskip = 0pt{} }}% + % + % Turn off hyphenation. + \nohyphenation + % + \rawbackslash + \plainfrenchspacing + #1% + }% + \null +} + +% 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) +% and arrange explicitly to hyphenate at a dash. +% -- rms. +{ + \catcode`\-=\active \catcode`\_=\active + \catcode`\'=\active \catcode`\`=\active + \global\let'=\rq \global\let`=\lq % default definitions + % + \global\def\code{\begingroup + \setupmarkupstyle{code}% + % The following should really be moved into \setupmarkupstyle handlers. + \catcode\dashChar=\active \catcode\underChar=\active + \ifallowcodebreaks + \let-\codedash + \let_\codeunder + \else + \let-\realdash + \let_\realunder + \fi + \codex + } +} + +\def\realdash{-} +\def\codedash{-\discretionary{}{}{}} +\def\codeunder{% + % this is all so @math{@code{var_name}+1} can work. In math mode, _ + % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) + % will therefore expand the active definition of _, which is us + % (inside @code that is), therefore an endless loop. + \ifusingtt{\ifmmode + \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. + \else\normalunderscore \fi + \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. +% +\newif\ifallowcodebreaks \allowcodebreakstrue + +\def\keywordtrue{true} +\def\keywordfalse{false} + +\parseargdef\allowcodebreaks{% + \def\txiarg{#1}% + \ifx\txiarg\keywordtrue + \allowcodebreakstrue + \else\ifx\txiarg\keywordfalse + \allowcodebreaksfalse + \else + \errhelp = \EMsimple + \errmessage{Unknown @allowcodebreaks option `\txiarg'}% + \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 +\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} + +% @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 + \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\ (\code{#1})% DVI: 2nd arg given, show both it and url + \fi + \else + \code{#1}% only url given, so show it + \fi + \fi + \endlink +\endgroup} + +% @url synonym for @uref, since that's how everyone uses it. +% +\let\url=\uref + +% rms does not like angle brackets --karl, 17may97. +% So now @email is just like @uref, unless we are pdf. +% +%\def\email#1{\angleleft{\tt #1}\angleright} +\ifpdf + \def\email#1{\doemail#1,,\finish} + \def\doemail#1,#2,#3\finish{\begingroup + \unsepspaces + \pdfurl{mailto:#1}% + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi + \endlink + \endgroup} +\else + \let\email=\uref +\fi + +% 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. +% +\def\dmn#1{\thinspace #1} + +% @l was never documented to mean ``switch to the Lisp font'', +% and it is not used as such in any manual I can find. We need it for +% Polish suppressed-l. --karl, 22sep96. +%\def\l#1{{\li #1}\null} + +% @acronym for "FBI", "NATO", and the like. +% We print this one point size smaller, since it's intended for +% all-uppercase. +% +\def\acronym#1{\doacronym #1,,\finish} +\def\doacronym#1,#2,#3\finish{% + {\selectfonts\lsize #1}% + \def\temp{#2}% + \ifx\temp\empty \else + \space ({\unsepspaces \ignorespaces \temp \unskip})% + \fi +} + +% @abbr for "Comput. J." and the like. +% No font change, but don't do end-of-sentence spacing. +% +\def\abbr#1{\doabbr #1,,\finish} +\def\doabbr#1,#2,#3\finish{% + {\plainfrenchspacing #1}% + \def\temp{#2}% + \ifx\temp\empty \else + \space ({\unsepspaces \ignorespaces \temp \unskip})% + \fi +} + + +\message{glyphs,} + +% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. +% +% Since these characters are used in examples, they should be an even number of +% \tt widths. Each \tt character is 1en, so two makes it 1em. +% +\def\point{$\star$} +\def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}} +\def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} +\def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}} +\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} +\def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}} + +% The @error{} command. +% Adapted from the TeXbook's \boxit. +% +\newbox\errorbox +% +{\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} +% +\setbox\errorbox=\hbox to \dimen0{\hfil + \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. + \advance\hsize by -2\dimen2 % Rules. + \vbox{% + \hrule height\dimen2 + \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. + \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. + \kern3pt\vrule width\dimen2}% Space to right. + \hrule height\dimen2} + \hfil} +% +\def\error{\leavevmode\lower.7ex\copy\errorbox} + +% @pounds{} is a sterling sign, which Knuth put in the CM italic font. +% +\def\pounds{{\it\$}} + +% @euro{} comes from a separate font, depending on the current style. +% We use the free feym* fonts from the eurosym package by Henrik +% Theiling, which support regular, slanted, bold and bold slanted (and +% "outlined" (blackboard board, sort of) versions, which we don't need). +% It is available from http://www.ctan.org/tex-archive/fonts/eurosym. +% +% Although only regular is the truly official Euro symbol, we ignore +% that. The Euro is designed to be slightly taller than the regular +% font height. +% +% feymr - regular +% feymo - slanted +% feybr - bold +% feybo - bold slanted +% +% There is no good (free) typewriter version, to my knowledge. +% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide. +% Hmm. +% +% Also doesn't work in math. Do we need to do math with euro symbols? +% Hope not. +% +% +\def\euro{{\eurofont e}} +\def\eurofont{% + % We set the font at each command, rather than predefining it in + % \textfonts and the other font-switching commands, so that + % installations which never need the symbol don't have to have the + % font installed. + % + % There is only one designed size (nominal 10pt), so we always scale + % that to the current nominal size. + % + % By the way, simply using "at 1em" works for cmr10 and the like, but + % does not work for cmbx10 and other extended/shrunken fonts. + % + \def\eurosize{\csname\curfontsize nominalsize\endcsname}% + % + \ifx\curfontstyle\bfstylename + % bold: + \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize + \else + % regular: + \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize + \fi + \thiseurofont +} + +% Glyphs from the EC fonts. We don't use \let for the aliases, because +% sometimes we redefine the original macro, and the alias should reflect +% the redefinition. +% +% Use LaTeX names for the Icelandic letters. +\def\DH{{\ecfont \char"D0}} % Eth +\def\dh{{\ecfont \char"F0}} % eth +\def\TH{{\ecfont \char"DE}} % Thorn +\def\th{{\ecfont \char"FE}} % thorn +% +\def\guillemetleft{{\ecfont \char"13}} +\def\guillemotleft{\guillemetleft} +\def\guillemetright{{\ecfont \char"14}} +\def\guillemotright{\guillemetright} +\def\guilsinglleft{{\ecfont \char"0E}} +\def\guilsinglright{{\ecfont \char"0F}} +\def\quotedblbase{{\ecfont \char"12}} +\def\quotesinglbase{{\ecfont \char"0D}} +% +% This positioning is not perfect (see the ogonek LaTeX package), but +% we have the precomposed glyphs for the most common cases. We put the +% tests to use those glyphs in the single \ogonek macro so we have fewer +% dummy definitions to worry about for index entries, etc. +% +% ogonek is also used with other letters in Lithuanian (IOU), but using +% the precomposed glyphs for those is not so easy since they aren't in +% the same EC font. +\def\ogonek#1{{% + \def\temp{#1}% + \ifx\temp\macrocharA\Aogonek + \else\ifx\temp\macrochara\aogonek + \else\ifx\temp\macrocharE\Eogonek + \else\ifx\temp\macrochare\eogonek + \else + \ecfont \setbox0=\hbox{#1}% + \ifdim\ht0=1ex\accent"0C #1% + \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}% + \fi + \fi\fi\fi\fi + }% +} +\def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A} +\def\aogonek{{\ecfont \char"A1}}\def\macrochara{a} +\def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E} +\def\eogonek{{\ecfont \char"A6}}\def\macrochare{e} +% +% Use the ec* fonts (cm-super in outline format) for non-CM glyphs. +\def\ecfont{% + % We can't distinguish serif/sans and italic/slanted, but this + % is used for crude hacks anyway (like adding French and German + % quotes to documents typeset with CM, where we lose kerning), so + % 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 + \else + % regular: + \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize + \fi + \thisecfont +} + +% @registeredsymbol - R in a circle. The font for the R should really +% be smaller yet, but lllsize is the best we can do for now. +% Adapted from the plain.tex definition of \copyright. +% +\def\registeredsymbol{% + $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% + \hfil\crcr\Orb}}% + }$% +} + +% @textdegree - the normal degrees sign. +% +\def\textdegree{$^\circ$} + +% Laurent Siebenmann reports \Orb undefined with: +% 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 +\def\Orb{\mathhexbox20D} +\fi + +% Quotes. +\chardef\quotedblleft="5C +\chardef\quotedblright=`\" +\chardef\quoteleft=`\` +\chardef\quoteright=`\' + + +\message{page headings,} + +\newskip\titlepagetopglue \titlepagetopglue = 1.5in +\newskip\titlepagebottomglue \titlepagebottomglue = 2pc + +% First the title page. Must do @settitle before @titlepage. +\newif\ifseenauthor +\newif\iffinishedtitlepage + +% Do an implicit @contents or @shortcontents after @end titlepage if the +% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. +% +\newif\ifsetcontentsaftertitlepage + \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue +\newif\ifsetshortcontentsaftertitlepage + \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue + +\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. + \begingroup + \parindent=0pt \textfonts + % Leave some space at the very top of the page. + \vglue\titlepagetopglue + % No rule at page bottom unless we print one at the top with @title. + \finishedtitlepagetrue + % + % Most title ``pages'' are actually two pages long, with space + % at the top of the second. We don't want the ragged left on the second. + \let\oldpage = \page + \def\page{% + \iffinishedtitlepage\else + \finishtitlepage + \fi + \let\page = \oldpage + \page + \null + }% +} + +\def\Etitlepage{% + \iffinishedtitlepage\else + \finishtitlepage + \fi + % It is important to do the page break before ending the group, + % because the headline and footline are only empty inside the group. + % If we use the new definition of \page, we always get a blank page + % after the title page, which we certainly don't want. + \oldpage + \endgroup + % + % Need this before the \...aftertitlepage checks so that if they are + % in effect the toc pages will come out with page numbers. + \HEADINGSon + % + % If they want short, they certainly want long too. + \ifsetshortcontentsaftertitlepage + \shortcontents + \contents + \global\let\shortcontents = \relax + \global\let\contents = \relax + \fi + % + \ifsetcontentsaftertitlepage + \contents + \global\let\contents = \relax + \global\let\shortcontents = \relax + \fi +} + +\def\finishtitlepage{% + \vskip4pt \hrule height 2pt width \hsize + \vskip\titlepagebottomglue + \finishedtitlepagetrue +} + +%%% Macros to be used within @titlepage: + +\let\subtitlerm=\tenrm +\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} + +\parseargdef\title{% + \checkenv\titlepage + \leftline{\titlefonts\rmisbold #1} + % print a rule at the page bottom also. + \finishedtitlepagefalse + \vskip4pt \hrule height 4pt width \hsize \vskip4pt +} + +\parseargdef\subtitle{% + \checkenv\titlepage + {\subtitlefont \rightline{#1}}% +} + +% @author should come last, but may come many times. +% It can also be used inside @quotation. +% +\parseargdef\author{% + \def\temp{\quotation}% + \ifx\thisenv\temp + \def\quotationauthor{#1}% printed in \Equotation. + \else + \checkenv\titlepage + \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi + {\secfonts\rmisbold \leftline{#1}}% + \fi +} + + +%%% Set up page headings and footings. + +\let\thispage=\folio + +\newtoks\evenheadline % headline on even pages +\newtoks\oddheadline % headline on odd pages +\newtoks\evenfootline % footline on even pages +\newtoks\oddfootline % footline on odd pages + +% Now make TeX use those variables +\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline + \else \the\evenheadline \fi}} +\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline + \else \the\evenfootline \fi}\HEADINGShook} +\let\HEADINGShook=\relax + +% Commands to set those variables. +% For example, this is what @headings on does +% @evenheading @thistitle|@thispage|@thischapter +% @oddheading @thischapter|@thispage|@thistitle +% @evenfooting @thisfile|| +% @oddfooting ||@thisfile + + +\def\evenheading{\parsearg\evenheadingxxx} +\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} +\def\evenheadingyyy #1\|#2\|#3\|#4\finish{% +\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} + +\def\oddheading{\parsearg\oddheadingxxx} +\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} +\def\oddheadingyyy #1\|#2\|#3\|#4\finish{% +\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} + +\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% + +\def\evenfooting{\parsearg\evenfootingxxx} +\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} +\def\evenfootingyyy #1\|#2\|#3\|#4\finish{% +\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} + +\def\oddfooting{\parsearg\oddfootingxxx} +\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} +\def\oddfootingyyy #1\|#2\|#3\|#4\finish{% + \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% + % + % Leave some space for the footline. Hopefully ok to assume + % @evenfooting will not be used by itself. + \global\advance\pageheight by -12pt + \global\advance\vsize by -12pt +} + +\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} + +% @evenheadingmarks top \thischapter <- chapter at the top of a page +% @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page +% +% The same set of arguments for: +% +% @oddheadingmarks +% @evenfootingmarks +% @oddfootingmarks +% @everyheadingmarks +% @everyfootingmarks + +\def\evenheadingmarks{\headingmarks{even}{heading}} +\def\oddheadingmarks{\headingmarks{odd}{heading}} +\def\evenfootingmarks{\headingmarks{even}{footing}} +\def\oddfootingmarks{\headingmarks{odd}{footing}} +\def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1} + \headingmarks{odd}{heading}{#1} } +\def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1} + \headingmarks{odd}{footing}{#1} } +% #1 = even/odd, #2 = heading/footing, #3 = top/bottom. +\def\headingmarks#1#2#3 {% + \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname + \global\expandafter\let\csname get#1#2marks\endcsname \temp +} + +\everyheadingmarks bottom +\everyfootingmarks bottom + +% @headings double turns headings on for double-sided printing. +% @headings single turns headings on for single-sided printing. +% @headings off turns them off. +% @headings on same as @headings double, retained for compatibility. +% @headings after turns on double-sided headings after this page. +% @headings doubleafter turns on double-sided headings after this page. +% @headings singleafter turns on single-sided headings after this page. +% By default, they are off at the start of a document, +% and turned `on' after @end titlepage. + +\def\headings #1 {\csname HEADINGS#1\endcsname} + +\def\HEADINGSoff{% +\global\evenheadline={\hfil} \global\evenfootline={\hfil} +\global\oddheadline={\hfil} \global\oddfootline={\hfil}} +\HEADINGSoff +% 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 +% title on inside top of left hand pages, and page numbers on outside top +% edge of all pages. +\def\HEADINGSdouble{% +\global\pageno=1 +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\folio\hfil\thistitle}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chapoddpage +} +\let\contentsalignmacro = \chappager + +% For single-sided printing, chapter title goes across top left of page, +% page number on top right. +\def\HEADINGSsingle{% +\global\pageno=1 +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\thischapter\hfil\folio}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chappager +} +\def\HEADINGSon{\HEADINGSdouble} + +\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} +\let\HEADINGSdoubleafter=\HEADINGSafter +\def\HEADINGSdoublex{% +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\folio\hfil\thistitle}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chapoddpage +} + +\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} +\def\HEADINGSsinglex{% +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\thischapter\hfil\folio}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chappager +} + +% Subroutines used in generating headings +% 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 +\def\today{% + \number\day\space + \ifcase\month + \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr + \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug + \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec + \fi + \space\number\year} +\fi + +% @settitle line... specifies the title of the document, for headings. +% It generates no output of its own. +\def\thistitle{\putwordNoTitle} +\def\settitle{\parsearg{\gdef\thistitle}} + + +\message{tables,} +% Tables -- @table, @ftable, @vtable, @item(x). + +% default indentation of table text +\newdimen\tableindent \tableindent=.8in +% default indentation of @itemize and @enumerate text +\newdimen\itemindent \itemindent=.3in +% margin between end of table item and start of table text. +\newdimen\itemmargin \itemmargin=.1in + +% used internally for \itemindent minus \itemmargin +\newdimen\itemmax + +% Note @table, @ftable, and @vtable define @item, @itemx, etc., with +% these defs. +% They also define \itemindex +% to index the item name in whatever manner is desired (perhaps none). + +\newif\ifitemxneedsnegativevskip + +\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} + +\def\internalBitem{\smallbreak \parsearg\itemzzz} +\def\internalBitemx{\itemxpar \parsearg\itemzzz} + +\def\itemzzz #1{\begingroup % + \advance\hsize by -\rightskip + \advance\hsize by -\tableindent + \setbox0=\hbox{\itemindicate{#1}}% + \itemindex{#1}% + \nobreak % This prevents a break before @itemx. + % + % If the item text does not fit in the space we have, put it on a line + % by itself, and do not allow a page break either before or after that + % line. We do not start a paragraph here because then if the next + % command is, e.g., @kindex, the whatsit would get put into the + % horizontal list on a line by itself, resulting in extra blank space. + \ifdim \wd0>\itemmax + % + % Make this a paragraph so we get the \parskip glue and wrapping, + % but leave it ragged-right. + \begingroup + \advance\leftskip by-\tableindent + \advance\hsize by\tableindent + \advance\rightskip by0pt plus1fil + \leavevmode\unhbox0\par + \endgroup + % + % We're going to be starting a paragraph, but we don't want the + % \parskip glue -- logically it's part of the @item we just started. + \nobreak \vskip-\parskip + % + % Stop a page break at the \parskip glue coming up. However, if + % what follows is an environment such as @example, there will be no + % \parskip glue; then the negative vskip we just inserted would + % cause the example and the item to crash together. So we use this + % bizarre value of 10001 as a signal to \aboveenvbreak to insert + % \parskip glue after all. Section titles are handled this way also. + % + \penalty 10001 + \endgroup + \itemxneedsnegativevskipfalse + \else + % The item text fits into the space. Start a paragraph, so that the + % following text (if any) will end up on the same line. + \noindent + % Do this with kerns and \unhbox so that if there is a footnote in + % the item text, it can migrate to the main vertical list and + % eventually be printed. + \nobreak\kern-\tableindent + \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 + \unhbox0 + \nobreak\kern\dimen0 + \endgroup + \itemxneedsnegativevskiptrue + \fi +} + +\def\item{\errmessage{@item while not in a list environment}} +\def\itemx{\errmessage{@itemx while not in a list environment}} + +% @table, @ftable, @vtable. +\envdef\table{% + \let\itemindex\gobble + \tablecheck{table}% +} +\envdef\ftable{% + \def\itemindex ##1{\doind {fn}{\code{##1}}}% + \tablecheck{ftable}% +} +\envdef\vtable{% + \def\itemindex ##1{\doind {vr}{\code{##1}}}% + \tablecheck{vtable}% +} +\def\tablecheck#1{% + \ifnum \the\catcode`\^^M=\active + \endgroup + \errmessage{This command won't work in this context; perhaps the problem is + that we are \inenvironment\thisenv}% + \def\next{\doignore{#1}}% + \else + \let\next\tablex + \fi + \next +} +\def\tablex#1{% + \def\itemindicate{#1}% + \parsearg\tabley +} +\def\tabley#1{% + {% + \makevalueexpandable + \edef\temp{\noexpand\tablez #1\space\space\space}% + \expandafter + }\temp \endtablez +} +\def\tablez #1 #2 #3 #4\endtablez{% + \aboveenvbreak + \ifnum 0#1>0 \advance \leftskip by #1\mil \fi + \ifnum 0#2>0 \tableindent=#2\mil \fi + \ifnum 0#3>0 \advance \rightskip by #3\mil \fi + \itemmax=\tableindent + \advance \itemmax by -\itemmargin + \advance \leftskip by \tableindent + \exdentamount=\tableindent + \parindent = 0pt + \parskip = \smallskipamount + \ifdim \parskip=0pt \parskip=2pt \fi + \let\item = \internalBitem + \let\itemx = \internalBitemx +} +\def\Etable{\endgraf\afterenvbreak} +\let\Eftable\Etable +\let\Evtable\Etable +\let\Eitemize\Etable +\let\Eenumerate\Etable + +% This is the counter used by @enumerate, which is really @itemize + +\newcount \itemno + +\envdef\itemize{\parsearg\doitemize} + +\def\doitemize#1{% + \aboveenvbreak + \itemmax=\itemindent + \advance\itemmax by -\itemmargin + \advance\leftskip by \itemindent + \exdentamount=\itemindent + \parindent=0pt + \parskip=\smallskipamount + \ifdim\parskip=0pt \parskip=2pt \fi + % + % Try typesetting the item mark that if the document erroneously says + % something like @itemize @samp (intending @table), there's an error + % right away at the @itemize. It's not the best error message in the + % world, but it's better than leaving it to the @item. This means if + % the user wants an empty mark, they have to say @w{} not just @w. + \def\itemcontents{#1}% + \setbox0 = \hbox{\itemcontents}% + % + % @itemize with no arg is equivalent to @itemize @bullet. + \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi + % + \let\item=\itemizeitem +} + +% Definition of @item while inside @itemize and @enumerate. +% +\def\itemizeitem{% + \advance\itemno by 1 % for enumerations + {\let\par=\endgraf \smallbreak}% reasonable place to break + {% + % If the document has an @itemize directly after a section title, a + % \nobreak will be last on the list, and \sectionheading will have + % done a \vskip-\parskip. In that case, we don't want to zero + % parskip, or the item text will crash with the heading. On the + % other hand, when there is normal text preceding the item (as there + % usually is), we do want to zero parskip, or there would be too much + % space. In that case, we won't have a \nobreak before. At least + % that's the theory. + \ifnum\lastpenalty<10000 \parskip=0in \fi + \noindent + \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% + % + \vadjust{\penalty 1200}}% not good to break after first line of item. + \flushcr +} + +% \splitoff TOKENS\endmark defines \first to be the first token in +% TOKENS, and \rest to be the remainder. +% +\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% + +% Allow an optional argument of an uppercase letter, lowercase letter, +% or number, to specify the first label in the enumerated list. No +% argument is the same as `1'. +% +\envparseargdef\enumerate{\enumeratey #1 \endenumeratey} +\def\enumeratey #1 #2\endenumeratey{% + % If we were given no argument, pretend we were given `1'. + \def\thearg{#1}% + \ifx\thearg\empty \def\thearg{1}\fi + % + % Detect if the argument is a single token. If so, it might be a + % letter. Otherwise, the only valid thing it can be is a number. + % (We will always have one token, because of the test we just made. + % This is a good thing, since \splitoff doesn't work given nothing at + % all -- the first parameter is undelimited.) + \expandafter\splitoff\thearg\endmark + \ifx\rest\empty + % Only one token in the argument. It could still be anything. + % A ``lowercase letter'' is one whose \lccode is nonzero. + % An ``uppercase letter'' is one whose \lccode is both nonzero, and + % not equal to itself. + % Otherwise, we assume it's a number. + % + % We need the \relax at the end of the \ifnum lines to stop TeX from + % continuing to look for a <number>. + % + \ifnum\lccode\expandafter`\thearg=0\relax + \numericenumerate % a number (we hope) + \else + % It's a letter. + \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax + \lowercaseenumerate % lowercase letter + \else + \uppercaseenumerate % uppercase letter + \fi + \fi + \else + % Multiple tokens in the argument. We hope it's a number. + \numericenumerate + \fi +} + +% An @enumerate whose labels are integers. The starting integer is +% given in \thearg. +% +\def\numericenumerate{% + \itemno = \thearg + \startenumeration{\the\itemno}% +} + +% The starting (lowercase) letter is in \thearg. +\def\lowercaseenumerate{% + \itemno = \expandafter`\thearg + \startenumeration{% + % Be sure we're not beyond the end of the alphabet. + \ifnum\itemno=0 + \errmessage{No more lowercase letters in @enumerate; get a bigger + alphabet}% + \fi + \char\lccode\itemno + }% +} + +% The starting (uppercase) letter is in \thearg. +\def\uppercaseenumerate{% + \itemno = \expandafter`\thearg + \startenumeration{% + % Be sure we're not beyond the end of the alphabet. + \ifnum\itemno=0 + \errmessage{No more uppercase letters in @enumerate; get a bigger + alphabet} + \fi + \char\uccode\itemno + }% +} + +% Call \doitemize, adding a period to the first argument and supplying the +% common last two arguments. Also subtract one from the initial value in +% \itemno, since @item increments \itemno. +% +\def\startenumeration#1{% + \advance\itemno by -1 + \doitemize{#1.}\flushcr +} + +% @alphaenumerate and @capsenumerate are abbreviations for giving an arg +% to @enumerate. +% +\def\alphaenumerate{\enumerate{a}} +\def\capsenumerate{\enumerate{A}} +\def\Ealphaenumerate{\Eenumerate} +\def\Ecapsenumerate{\Eenumerate} + + +% @multitable macros +% Amy Hendrickson, 8/18/94, 3/6/96 +% +% @multitable ... @end multitable will make as many columns as desired. +% Contents of each column will wrap at width given in preamble. Width +% can be specified either with sample text given in a template line, +% or in percent of \hsize, the current width of text on page. + +% Table can continue over pages but will only break between lines. + +% To make preamble: +% +% Either define widths of columns in terms of percent of \hsize: +% @multitable @columnfractions .25 .3 .45 +% @item ... +% +% Numbers following @columnfractions are the percent of the total +% current hsize to be used for each column. You may use as many +% columns as desired. + + +% Or use a template: +% @multitable {Column 1 template} {Column 2 template} {Column 3 template} +% @item ... +% using the widest term desired in each column. + +% Each new table line starts with @item, each subsequent new column +% starts with @tab. Empty columns may be produced by supplying @tab's +% with nothing between them for as many times as empty columns are needed, +% ie, @tab@tab@tab will produce two empty columns. + +% @item, @tab do not need to be on their own lines, but it will not hurt +% if they are. + +% Sample multitable: + +% @multitable {Column 1 template} {Column 2 template} {Column 3 template} +% @item first col stuff @tab second col stuff @tab third col +% @item +% first col stuff +% @tab +% second col stuff +% @tab +% third col +% @item first col stuff @tab second col stuff +% @tab Many paragraphs of text may be used in any column. +% +% They will wrap at the width determined by the template. +% @item@tab@tab This will be in third column. +% @end multitable + +% Default dimensions may be reset by user. +% @multitableparskip is vertical space between paragraphs in table. +% @multitableparindent is paragraph indent in table. +% @multitablecolmargin is horizontal space to be left between columns. +% @multitablelinespace is space to leave between table items, baseline +% to baseline. +% 0pt means it depends on current normal line spacing. +% +\newskip\multitableparskip +\newskip\multitableparindent +\newdimen\multitablecolspace +\newskip\multitablelinespace +\multitableparskip=0pt +\multitableparindent=6pt +\multitablecolspace=12pt +\multitablelinespace=0pt + +% Macros used to set up halign preamble: +% +\let\endsetuptable\relax +\def\xendsetuptable{\endsetuptable} +\let\columnfractions\relax +\def\xcolumnfractions{\columnfractions} +\newif\ifsetpercent + +% #1 is the @columnfraction, usually a decimal number like .5, but might +% be just 1. We just use it, whatever it is. +% +\def\pickupwholefraction#1 {% + \global\advance\colcount by 1 + \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% + \setuptable +} + +\newcount\colcount +\def\setuptable#1{% + \def\firstarg{#1}% + \ifx\firstarg\xendsetuptable + \let\go = \relax + \else + \ifx\firstarg\xcolumnfractions + \global\setpercenttrue + \else + \ifsetpercent + \let\go\pickupwholefraction + \else + \global\advance\colcount by 1 + \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a + % separator; typically that is always in the input, anyway. + \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% + \fi + \fi + \ifx\go\pickupwholefraction + % Put the argument back for the \pickupwholefraction call, so + % we'll always have a period there to be parsed. + \def\go{\pickupwholefraction#1}% + \else + \let\go = \setuptable + \fi% + \fi + \go +} + +% multitable-only commands. +% +% @headitem starts a heading row, which we typeset in bold. +% Assignments have to be global since we are inside the implicit group +% of an alignment entry. \everycr resets \everytab so we don't have to +% undo it ourselves. +\def\headitemfont{\b}% for people to use in the template row; not changeable +\def\headitem{% + \checkenv\multitable + \crcr + \global\everytab={\bf}% can't use \headitemfont since the parsing differs + \the\everytab % for the first item +}% +% +% A \tab used to include \hskip1sp. But then the space in a template +% line is not enough. That is bad. So let's go back to just `&' until +% we again encounter the problem the 1sp was intended to solve. +% --karl, nathan@acm.org, 20apr99. +\def\tab{\checkenv\multitable &\the\everytab}% + +% @multitable ... @end multitable definitions: +% +\newtoks\everytab % insert after every tab. +% +\envdef\multitable{% + \vskip\parskip + \startsavinginserts + % + % @item within a multitable starts a normal row. + % We use \def instead of \let so that if one of the multitable entries + % contains an @itemize, we don't choke on the \item (seen as \crcr aka + % \endtemplate) expanding \doitemize. + \def\item{\crcr}% + % + \tolerance=9500 + \hbadness=9500 + \setmultitablespacing + \parskip=\multitableparskip + \parindent=\multitableparindent + \overfullrule=0pt + \global\colcount=0 + % + \everycr = {% + \noalign{% + \global\everytab={}% + \global\colcount=0 % Reset the column counter. + % Check for saved footnotes, etc. + \checkinserts + % Keeps underfull box messages off when table breaks over pages. + %\filbreak + % Maybe so, but it also creates really weird page breaks when the + % table breaks over pages. Wouldn't \vfil be better? Wait until the + % problem manifests itself, so it can be fixed for real --karl. + }% + }% + % + \parsearg\domultitable +} +\def\domultitable#1{% + % To parse everything between @multitable and @item: + \setuptable#1 \endsetuptable + % + % This preamble sets up a generic column definition, which will + % be used as many times as user calls for columns. + % \vtop will set a single line and will also let text wrap and + % continue for many paragraphs if desired. + \halign\bgroup &% + \global\advance\colcount by 1 + \multistrut + \vtop{% + % Use the current \colcount to find the correct column width: + \hsize=\expandafter\csname col\the\colcount\endcsname + % + % In order to keep entries from bumping into each other + % we will add a \leftskip of \multitablecolspace to all columns after + % the first one. + % + % If a template has been used, we will add \multitablecolspace + % to the width of each template entry. + % + % If the user has set preamble in terms of percent of \hsize we will + % use that dimension as the width of the column, and the \leftskip + % will keep entries from bumping into each other. Table will start at + % left margin and final column will justify at right margin. + % + % Make sure we don't inherit \rightskip from the outer environment. + \rightskip=0pt + \ifnum\colcount=1 + % The first column will be indented with the surrounding text. + \advance\hsize by\leftskip + \else + \ifsetpercent \else + % If user has not set preamble in terms of percent of \hsize + % we will advance \hsize by \multitablecolspace. + \advance\hsize by \multitablecolspace + \fi + % In either case we will make \leftskip=\multitablecolspace: + \leftskip=\multitablecolspace + \fi + % Ignoring space at the beginning and end avoids an occasional spurious + % blank line, when TeX decides to break the line at the space before the + % box from the multistrut, so the strut ends up on a line by itself. + % For example: + % @multitable @columnfractions .11 .89 + % @item @code{#} + % @tab Legal holiday which is valid in major parts of the whole country. + % Is automatically provided with highlighting sequences respectively + % marking characters. + \noindent\ignorespaces##\unskip\multistrut + }\cr +} +\def\Emultitable{% + \crcr + \egroup % end the \halign + \global\setpercentfalse +} + +\def\setmultitablespacing{% + \def\multistrut{\strut}% just use the standard line spacing + % + % Compute \multitablelinespace (if not defined by user) for use in + % \multitableparskip calculation. We used define \multistrut based on + % this, but (ironically) that caused the spacing to be off. + % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100. +\ifdim\multitablelinespace=0pt +\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. +\ifdim\multitableparskip>\multitablelinespace +\global\multitableparskip=\multitablelinespace +\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. +\fi} + + +\message{conditionals,} + +% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, +% @ifnotxml always succeed. They currently do nothing; we don't +% attempt to check whether the conditionals are properly nested. But we +% have to remember that they are conditionals, so that @end doesn't +% attempt to close an environment group. +% +\def\makecond#1{% + \expandafter\let\csname #1\endcsname = \relax + \expandafter\let\csname iscond.#1\endcsname = 1 +} +\makecond{iftex} +\makecond{ifnotdocbook} +\makecond{ifnothtml} +\makecond{ifnotinfo} +\makecond{ifnotplaintext} +\makecond{ifnotxml} + +% Ignore @ignore, @ifhtml, @ifinfo, and the like. +% +\def\direntry{\doignore{direntry}} +\def\documentdescription{\doignore{documentdescription}} +\def\docbook{\doignore{docbook}} +\def\html{\doignore{html}} +\def\ifdocbook{\doignore{ifdocbook}} +\def\ifhtml{\doignore{ifhtml}} +\def\ifinfo{\doignore{ifinfo}} +\def\ifnottex{\doignore{ifnottex}} +\def\ifplaintext{\doignore{ifplaintext}} +\def\ifxml{\doignore{ifxml}} +\def\ignore{\doignore{ignore}} +\def\menu{\doignore{menu}} +\def\xml{\doignore{xml}} + +% Ignore text until a line `@end #1', keeping track of nested conditionals. +% +% A count to remember the depth of nesting. +\newcount\doignorecount + +\def\doignore#1{\begingroup + % Scan in ``verbatim'' mode: + \obeylines + \catcode`\@ = \other + \catcode`\{ = \other + \catcode`\} = \other + % + % Make sure that spaces turn into tokens that match what \doignoretext wants. + \spaceisspace + % + % Count number of #1's that we've seen. + \doignorecount = 0 + % + % Swallow text until we reach the matching `@end #1'. + \dodoignore{#1}% +} + +{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. + \obeylines % + % + \gdef\dodoignore#1{% + % #1 contains the command name as a string, e.g., `ifinfo'. + % + % Define a command to find the next `@end #1'. + \long\def\doignoretext##1^^M@end #1{% + \doignoretextyyy##1^^M@#1\_STOP_}% + % + % And this command to find another #1 command, at the beginning of a + % line. (Otherwise, we would consider a line `@c @ifset', for + % example, to count as an @ifset for nesting.) + \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% + % + % And now expand that command. + \doignoretext ^^M% + }% +} + +\def\doignoreyyy#1{% + \def\temp{#1}% + \ifx\temp\empty % Nothing found. + \let\next\doignoretextzzz + \else % Found a nested condition, ... + \advance\doignorecount by 1 + \let\next\doignoretextyyy % ..., look for another. + % If we're here, #1 ends with ^^M\ifinfo (for example). + \fi + \next #1% the token \_STOP_ is present just after this macro. +} + +% We have to swallow the remaining "\_STOP_". +% +\def\doignoretextzzz#1{% + \ifnum\doignorecount = 0 % We have just found the outermost @end. + \let\next\enddoignore + \else % Still inside a nested condition. + \advance\doignorecount by -1 + \let\next\doignoretext % Look for the next @end. + \fi + \next +} + +% Finish off ignored text. +{ \obeylines% + % Ignore anything after the last `@end #1'; this matters in verbatim + % environments, where otherwise the newline after an ignored conditional + % would result in a blank line in the output. + \gdef\enddoignore#1^^M{\endgroup\ignorespaces}% +} + + +% @set VAR sets the variable VAR to an empty value. +% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. +% +% Since we want to separate VAR from REST-OF-LINE (which might be +% empty), we can't just use \parsearg; we have to insert a space of our +% own to delimit the rest of the line, and then take it out again if we +% didn't need it. +% We rely on the fact that \parsearg sets \catcode`\ =10. +% +\parseargdef\set{\setyyy#1 \endsetyyy} +\def\setyyy#1 #2\endsetyyy{% + {% + \makevalueexpandable + \def\temp{#2}% + \edef\next{\gdef\makecsname{SET#1}}% + \ifx\temp\empty + \next{}% + \else + \setzzz#2\endsetzzz + \fi + }% +} +% Remove the trailing space \setxxx inserted. +\def\setzzz#1 \endsetzzz{\next{#1}} + +% @clear VAR clears (i.e., unsets) the variable VAR. +% +\parseargdef\clear{% + {% + \makevalueexpandable + \global\expandafter\let\csname SET#1\endcsname=\relax + }% +} + +% @value{foo} gets the text saved in variable foo. +\def\value{\begingroup\makevalueexpandable\valuexxx} +\def\valuexxx#1{\expandablevalue{#1}\endgroup} +{ + \catcode`\- = \active \catcode`\_ = \active + % + \gdef\makevalueexpandable{% + \let\value = \expandablevalue + % We don't want these characters active, ... + \catcode`\-=\other \catcode`\_=\other + % ..., 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 + } +} + +% We have this subroutine so that we can handle at least some @value's +% properly in indexes (we call \makevalueexpandable in \indexdummies). +% The command has to be fully expandable (if the variable is set), since +% the result winds up in the index file. This means that if the +% variable's value contains other Texinfo commands, it's almost certain +% it will fail (although perhaps we could fix that with sufficient work +% to do a one-level expansion on the result, instead of complete). +% +\def\expandablevalue#1{% + \expandafter\ifx\csname SET#1\endcsname\relax + {[No value for ``#1'']}% + \message{Variable `#1', used in @value, is not set.}% + \else + \csname SET#1\endcsname + \fi +} + +% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined +% with @set. +% +% To get special treatment of `@end ifset,' call \makeond and the redefine. +% +\makecond{ifset} +\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} +\def\doifset#1#2{% + {% + \makevalueexpandable + \let\next=\empty + \expandafter\ifx\csname SET#2\endcsname\relax + #1% If not set, redefine \next. + \fi + \expandafter + }\next +} +\def\ifsetfail{\doignore{ifset}} + +% @ifclear VAR ... @end ifclear reads 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 +% above code: if the variable is not set, do nothing, if it is set, +% then redefine \next to \ifclearfail. +% +\makecond{ifclear} +\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} +\def\ifclearfail{\doignore{ifclear}} + +% @dircategory CATEGORY -- specify a category of the dir file +% which this file should belong to. Ignore this in TeX. +\let\dircategory=\comment + +% @defininfoenclose. +\let\definfoenclose=\comment + + +\message{indexing,} +% Index generation facilities + +% Define \newwrite to be identical to plain tex's \newwrite +% except not \outer, so it can be used within macros and \if's. +\edef\newwrite{\makecsname{ptexnewwrite}} + +% \newindex {foo} defines an index named foo. +% It automatically defines \fooindex such that +% \fooindex ...rest of line... puts an entry in the index foo. +% It also defines \fooindfile to be the number of the output channel for +% the file that accumulates this index. The file's extension is foo. +% The name of an index should be no more than 2 characters long +% for the sake of vms. +% +\def\newindex#1{% + \iflinks + \expandafter\newwrite \csname#1indfile\endcsname + \openout \csname#1indfile\endcsname \jobname.#1 % Open the file + \fi + \expandafter\xdef\csname#1index\endcsname{% % Define @#1index + \noexpand\doindex{#1}} +} + +% @defindex foo == \newindex{foo} +% +\def\defindex{\parsearg\newindex} + +% Define @defcodeindex, like @defindex except put all entries in @code. +% +\def\defcodeindex{\parsearg\newcodeindex} +% +\def\newcodeindex#1{% + \iflinks + \expandafter\newwrite \csname#1indfile\endcsname + \openout \csname#1indfile\endcsname \jobname.#1 + \fi + \expandafter\xdef\csname#1index\endcsname{% + \noexpand\docodeindex{#1}}% +} + + +% @synindex foo bar makes index foo feed into index bar. +% Do this instead of @defindex foo if you don't want it as a separate index. +% +% @syncodeindex foo bar similar, but put all entries made for index foo +% inside @code. +% +\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} +\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} + +% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), +% #3 the target index (bar). +\def\dosynindex#1#2#3{% + % Only do \closeout if we haven't already done it, else we'll end up + % closing the target index. + \expandafter \ifx\csname donesynindex#2\endcsname \relax + % The \closeout helps reduce unnecessary open files; the limit on the + % Acorn RISC OS is a mere 16 files. + \expandafter\closeout\csname#2indfile\endcsname + \expandafter\let\csname donesynindex#2\endcsname = 1 + \fi + % redefine \fooindfile: + \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname + \expandafter\let\csname#2indfile\endcsname=\temp + % redefine \fooindex: + \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% +} + +% Define \doindex, the driver for all \fooindex macros. +% Argument #1 is generated by the calling \fooindex macro, +% and it is "foo", the name of the index. + +% \doindex just uses \parsearg; it calls \doind for the actual work. +% This is because \doind is more useful to call from other macros. + +% There is also \dosubind {index}{topic}{subtopic} +% which makes an entry in a two-level index such as the operation index. + +\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} +\def\singleindexer #1{\doind{\indexname}{#1}} + +% like the previous two, but they put @code around the argument. +\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} +\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} + +% Take care of Texinfo commands that can appear in an index entry. +% Since there are some commands we want to expand, and others we don't, +% we have to laboriously prevent expansion for those that we don't. +% +\def\indexdummies{% + \escapechar = `\\ % use backslash in output files. + \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 + % + % I don't entirely understand this, but when an index entry is + % generated from a macro call, the \endinput which \scanmacro inserts + % causes processing to be prematurely terminated. This is, + % apparently, because \indexsorttmp is fully expanded, and \endinput + % is an expandable command. The redefinition below makes \endinput + % disappear altogether for that purpose -- although logging shows that + % processing continues to some further point. On the other hand, it + % seems \endinput does not hurt in the printed index arg, since that + % is still getting written without apparent harm. + % + % Sample source (mac-idx3.tex, reported by Graham Percival to + % help-texinfo, 22may06): + % @macro funindex {WORD} + % @findex xyz + % @end macro + % ... + % @funindex commtest + % + % The above is not enough to reproduce the bug, but it gives the flavor. + % + % Sample whatsit resulting: + % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}} + % + % So: + \let\endinput = \empty + % + % Do the redefinitions. + \commondummies +} + +% For the aux and toc files, @ is the escape character. So we want to +% redefine everything using @ as the escape character (instead of +% \realbackslash, still used for index files). When everything uses @, +% this will be simpler. +% +\def\atdummies{% + \def\@{@@}% + \def\ {@ }% + \let\{ = \lbraceatcmd + \let\} = \rbraceatcmd + % + % Do the redefinitions. + \commondummies + \otherbackslash +} + +% Called from \indexdummies and \atdummies. +% +\def\commondummies{% + % + % \definedummyword defines \#1 as \string\#1\space, thus effectively + % 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. + % + % For control letters, we have \definedummyletter, which omits the + % space. + % + % These can be used both for control words that take an argument and + % those that do not. If it is followed by {arg} in the input, then + % that will dutifully get written to the index (or wherever). + % + \def\definedummyword ##1{\def##1{\string##1\space}}% + \def\definedummyletter##1{\def##1{\string##1}}% + \let\definedummyaccent\definedummyletter + % + \commondummiesnofonts + % + \definedummyletter\_% + % + % Non-English letters. + \definedummyword\AA + \definedummyword\AE + \definedummyword\DH + \definedummyword\L + \definedummyword\O + \definedummyword\OE + \definedummyword\TH + \definedummyword\aa + \definedummyword\ae + \definedummyword\dh + \definedummyword\exclamdown + \definedummyword\l + \definedummyword\o + \definedummyword\oe + \definedummyword\ordf + \definedummyword\ordm + \definedummyword\questiondown + \definedummyword\ss + \definedummyword\th + % + % Although these internal commands shouldn't show up, sometimes they do. + \definedummyword\bf + \definedummyword\gtr + \definedummyword\hat + \definedummyword\less + \definedummyword\sf + \definedummyword\sl + \definedummyword\tclose + \definedummyword\tt + % + \definedummyword\LaTeX + \definedummyword\TeX + % + % Assorted special characters. + \definedummyword\bullet + \definedummyword\comma + \definedummyword\copyright + \definedummyword\registeredsymbol + \definedummyword\dots + \definedummyword\enddots + \definedummyword\equiv + \definedummyword\error + \definedummyword\euro + \definedummyword\guillemetleft + \definedummyword\guillemetright + \definedummyword\guilsinglleft + \definedummyword\guilsinglright + \definedummyword\expansion + \definedummyword\minus + \definedummyword\ogonek + \definedummyword\pounds + \definedummyword\point + \definedummyword\print + \definedummyword\quotedblbase + \definedummyword\quotedblleft + \definedummyword\quotedblright + \definedummyword\quoteleft + \definedummyword\quoteright + \definedummyword\quotesinglbase + \definedummyword\result + \definedummyword\textdegree + % + % We want to disable all macros so that they are not expanded by \write. + \macrolist + % + \normalturnoffactive + % + % Handle some cases of @value -- where it does not contain any + % (non-fully-expandable) commands. + \makevalueexpandable +} + +% \commondummiesnofonts: common to \commondummies and \indexnofonts. +% +\def\commondummiesnofonts{% + % Control letters and accents. + \definedummyletter\!% + \definedummyaccent\"% + \definedummyaccent\'% + \definedummyletter\*% + \definedummyaccent\,% + \definedummyletter\.% + \definedummyletter\/% + \definedummyletter\:% + \definedummyaccent\=% + \definedummyletter\?% + \definedummyaccent\^% + \definedummyaccent\`% + \definedummyaccent\~% + \definedummyword\u + \definedummyword\v + \definedummyword\H + \definedummyword\dotaccent + \definedummyword\ogonek + \definedummyword\ringaccent + \definedummyword\tieaccent + \definedummyword\ubaraccent + \definedummyword\udotaccent + \definedummyword\dotless + % + % Texinfo font commands. + \definedummyword\b + \definedummyword\i + \definedummyword\r + \definedummyword\sc + \definedummyword\t + % + % Commands that take arguments. + \definedummyword\acronym + \definedummyword\cite + \definedummyword\code + \definedummyword\command + \definedummyword\dfn + \definedummyword\email + \definedummyword\emph + \definedummyword\env + \definedummyword\file + \definedummyword\kbd + \definedummyword\key + \definedummyword\math + \definedummyword\option + \definedummyword\pxref + \definedummyword\ref + \definedummyword\samp + \definedummyword\strong + \definedummyword\tie + \definedummyword\uref + \definedummyword\url + \definedummyword\var + \definedummyword\verb + \definedummyword\w + \definedummyword\xref +} + +% \indexnofonts is used when outputting the strings to sort the index +% by, and when constructing control sequence names. It eliminates all +% control sequences and just writes whatever the best ASCII sort string +% would be for a given command (usually its argument). +% +\def\indexnofonts{% + % Accent commands should become @asis. + \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. + \let\definedummyword\definedummyaccent + % + \commondummiesnofonts + % + % Don't no-op \tt, since it isn't a user-level command + % and is used in the definitions of the active chars like <, >, |, etc. + % Likewise with the other plain tex font commands. + %\let\tt=\asis + % + \def\ { }% + \def\@{@}% + % how to handle braces? + \def\_{\normalunderscore}% + % + % Non-English letters. + \def\AA{AA}% + \def\AE{AE}% + \def\DH{DZZ}% + \def\L{L}% + \def\OE{OE}% + \def\O{O}% + \def\TH{ZZZ}% + \def\aa{aa}% + \def\ae{ae}% + \def\dh{dzz}% + \def\exclamdown{!}% + \def\l{l}% + \def\oe{oe}% + \def\ordf{a}% + \def\ordm{o}% + \def\o{o}% + \def\questiondown{?}% + \def\ss{ss}% + \def\th{zzz}% + % + \def\LaTeX{LaTeX}% + \def\TeX{TeX}% + % + % Assorted special characters. + % (The following {} will end up in the sort string, but that's ok.) + \def\bullet{bullet}% + \def\comma{,}% + \def\copyright{copyright}% + \def\dots{...}% + \def\enddots{...}% + \def\equiv{==}% + \def\error{error}% + \def\euro{euro}% + \def\expansion{==>}% + \def\guillemetleft{<<}% + \def\guillemetright{>>}% + \def\guilsinglleft{<}% + \def\guilsinglright{>}% + \def\minus{-}% + \def\point{.}% + \def\pounds{pounds}% + \def\print{-|}% + \def\quotedblbase{"}% + \def\quotedblleft{"}% + \def\quotedblright{"}% + \def\quoteleft{`}% + \def\quoteright{'}% + \def\quotesinglbase{,}% + \def\registeredsymbol{R}% + \def\result{=>}% + \def\textdegree{o}% + % + % 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 + % writing an index entry, and texindex isn't prepared for an index sort entry + % that starts with \. + % + % Since macro invocations are followed by braces, we can just redefine them + % to take a single TeX argument. The case of a macro invocation that + % goes to end-of-line is not handled. + % + \macrolist +} + +\let\indexbackslash=0 %overridden during \printindex. +\let\SETmarginindex=\relax % put index entries in margin (undocumented)? + +% Most index entries go through here, but \dosubind is the general case. +% #1 is the index name, #2 is the entry text. +\def\doind#1#2{\dosubind{#1}{#2}{}} + +% Workhorse for all \fooindexes. +% #1 is name of index, #2 is stuff to put there, #3 is subentry -- +% empty if called from \doind, as we usually are (the main exception +% is with most defuns, which call us directly). +% +\def\dosubind#1#2#3{% + \iflinks + {% + % Store the main index entry text (including the third arg). + \toks0 = {#2}% + % If third arg is present, precede it with a space. + \def\thirdarg{#3}% + \ifx\thirdarg\empty \else + \toks0 = \expandafter{\the\toks0 \space #3}% + \fi + % + \edef\writeto{\csname#1indfile\endcsname}% + % + \safewhatsit\dosubindwrite + }% + \fi +} + +% Write the entry in \toks0 to the index file: +% +\def\dosubindwrite{% + % Put the index entry in the margin if desired. + \ifx\SETmarginindex\relax\else + \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% + \fi + % + % Remember, we are within a group. + \indexdummies % Must do this here, since \bf, etc expand at this stage + \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now + % so it will be output as is; and it will print as backslash. + % + % Process the index entry with all font commands turned off, to + % get the string to sort by. + {\indexnofonts + \edef\temp{\the\toks0}% need full expansion + \xdef\indexsorttmp{\temp}% + }% + % + % Set up the complete index entry, with both the sort key and + % the original text, including any font commands. We write + % three arguments to \entry to the .?? file (four in the + % subentry case), texindex reduces to two when writing the .??s + % sorted result. + \edef\temp{% + \write\writeto{% + \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% + }% + \temp +} + +% Take care of unwanted page breaks/skips around a whatsit: +% +% If a skip is the last thing on the list now, preserve it +% by backing up by \lastskip, doing the \write, then inserting +% the skip again. Otherwise, the whatsit generated by the +% \write or \pdfdest will make \lastskip zero. The result is that +% sequences like this: +% @end defun +% @tindex whatever +% @defun ... +% will have extra space inserted, because the \medbreak in the +% start of the @defun won't see the skip inserted by the @end of +% the previous defun. +% +% But don't do any of this if we're not in vertical mode. We +% don't want to do a \vskip and prematurely end a paragraph. +% +% Avoid page breaks due to these extra skips, too. +% +% But wait, there is a catch there: +% We'll have to check whether \lastskip is zero skip. \ifdim is not +% sufficient for this purpose, as it ignores stretch and shrink parts +% of the skip. The only way seems to be to check the textual +% representation of the skip. +% +% The following is almost like \def\zeroskipmacro{0.0pt} except that +% the ``p'' and ``t'' characters have catcode \other, not 11 (letter). +% +\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} +% +\newskip\whatsitskip +\newcount\whatsitpenalty +% +% ..., ready, GO: +% +\def\safewhatsit#1{% +\ifhmode + #1% +\else + % \lastskip and \lastpenalty cannot both be nonzero simultaneously. + \whatsitskip = \lastskip + \edef\lastskipmacro{\the\lastskip}% + \whatsitpenalty = \lastpenalty + % + % If \lastskip is nonzero, that means the last item was a + % skip. And since a skip is discardable, that means this + % -\whatsitskip glue we're inserting is preceded by a + % non-discardable item, therefore it is not a potential + % breakpoint, therefore no \nobreak needed. + \ifx\lastskipmacro\zeroskipmacro + \else + \vskip-\whatsitskip + \fi + % + #1% + % + \ifx\lastskipmacro\zeroskipmacro + % If \lastskip was zero, perhaps the last item was a penalty, and + % perhaps it was >=10000, e.g., a \nobreak. In that case, we want + % 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. + % would allow a break between the index-whatever whatsit + % and the "Description." paragraph. + \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi + \else + % On the other hand, if we had a nonzero \lastskip, + % this make-up glue would be preceded by a non-discardable item + % (the whatsit from the \write), so we must insert a \nobreak. + \nobreak\vskip\whatsitskip + \fi +\fi +} + +% The index entry written in the file actually looks like +% \entry {sortstring}{page}{topic} +% or +% \entry {sortstring}{page}{topic}{subtopic} +% The texindex program reads in these files and writes files +% containing these kinds of lines: +% \initial {c} +% before the first topic whose initial is c +% \entry {topic}{pagelist} +% for a topic that is used without subtopics +% \primary {topic} +% for the beginning of a topic that is used with subtopics +% \secondary {subtopic}{pagelist} +% for each subtopic. + +% Define the user-accessible indexing commands +% @findex, @vindex, @kindex, @cindex. + +\def\findex {\fnindex} +\def\kindex {\kyindex} +\def\cindex {\cpindex} +\def\vindex {\vrindex} +\def\tindex {\tpindex} +\def\pindex {\pgindex} + +\def\cindexsub {\begingroup\obeylines\cindexsub} +{\obeylines % +\gdef\cindexsub "#1" #2^^M{\endgroup % +\dosubind{cp}{#2}{#1}}} + +% Define the macros used in formatting output of the sorted index material. + +% @printindex causes a particular index (the ??s file) to get printed. +% It does not print any chapter heading (usually an @unnumbered). +% +\parseargdef\printindex{\begingroup + \dobreak \chapheadingskip{10000}% + % + \smallfonts \rm + \tolerance = 9500 + \plainfrenchspacing + \everypar = {}% don't want the \kern\-parindent from indentation suppression. + % + % See if the index file exists and is nonempty. + % Change catcode of @ here so that if the index file contains + % \initial {@} + % as its first line, TeX doesn't complain about mismatched braces + % (because it thinks @} is a control sequence). + \catcode`\@ = 11 + \openin 1 \jobname.#1s + \ifeof 1 + % \enddoublecolumns gets confused if there is no text in the index, + % and it loses the chapter title and the aux file entries for the + % index. The easiest way to prevent this problem is to make sure + % there is some text. + \putwordIndexNonexistent + \else + % + % If the index file exists but is empty, then \openin leaves \ifeof + % false. We have to make TeX try to read something from the file, so + % it can discover if there is anything in it. + \read 1 to \temp + \ifeof 1 + \putwordIndexIsEmpty + \else + % Index files are almost Texinfo source, but we use \ as the escape + % character. It would be better to use @, but that's too big a change + % to make right now. + \def\indexbackslash{\backslashcurfont}% + \catcode`\\ = 0 + \escapechar = `\\ + \begindoublecolumns + \input \jobname.#1s + \enddoublecolumns + \fi + \fi + \closein 1 +\endgroup} + +% These macros are used by the sorted index file itself. +% Change them to control the appearance of the index. + +\def\initial#1{{% + % Some minor font changes for the special characters. + \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt + % + % Remove any glue we may have, we'll be inserting our own. + \removelastskip + % + % We like breaks before the index initials, so insert a bonus. + \nobreak + \vskip 0pt plus 3\baselineskip + \penalty 0 + \vskip 0pt plus -3\baselineskip + % + % Typeset the initial. Making this add up to a whole number of + % baselineskips increases the chance of the dots lining up from column + % to column. It still won't often be perfect, because of the stretch + % we need before each entry, but it's better. + % + % No shrink because it confuses \balancecolumns. + \vskip 1.67\baselineskip plus .5\baselineskip + \leftline{\secbf #1}% + % Do our best not to break after the initial. + \nobreak + \vskip .33\baselineskip plus .1\baselineskip +}} + +% \entry typesets a paragraph consisting of the text (#1), dot leaders, and +% then page number (#2) flushed to the right margin. It is used for index +% and table of contents entries. The paragraph is indented by \leftskip. +% +% A straightforward implementation would start like this: +% \def\entry#1#2{... +% 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{% + \begingroup + % + % Start a new paragraph if necessary, so our assignments below can't + % affect previous text. + \par + % + % Do not fill out the last line with white space. + \parfillskip = 0in + % + % No extra space above this paragraph. + \parskip = 0in + % + % Do not prefer a separate line ending with a hyphen to fewer lines. + \finalhyphendemerits = 0 + % + % \hangindent is only relevant when the entry text and page number + % don't both fit on one line. In that case, bob suggests starting the + % dots pretty far over on the line. Unfortunately, a large + % indentation looks wrong when the entry text itself is broken across + % lines. So we use a small indentation and put up with long leaders. + % + % \hangafter is reset to 1 (which is the value we want) at the start + % of each paragraph, so we need not do anything with that. + \hangindent = 2em + % + % When the entry text needs to be broken, just fill out the first line + % with blank space. + \rightskip = 0pt plus1fil + % + % A bit of stretch before each entry for the benefit of balancing + % columns. + \vskip 0pt plus1pt + % + % Swallow the left brace of the text (first parameter): + \afterassignment\doentry + \let\temp = +} +\def\doentry{% + \bgroup % Instead of the swallowed brace. + \noindent + \aftergroup\finishentry + % And now comes the text of the entry. +} +\def\finishentry#1{% + % #1 is the page number. + % + % The following is kludged to not output a line of dots in the index if + % there are no page numbers. The next person who breaks this will be + % cursed by a Unix daemon. + \setbox\boxA = \hbox{#1}% + \ifdim\wd\boxA = 0pt + \ % + \else + % + % If we must, put the page number on a line of its own, and fill out + % this line with blank space. (The \hfil is overwhelmed with the + % fill leaders glue in \indexdotfill if the page number does fit.) + \hfil\penalty50 + \null\nobreak\indexdotfill % Have leaders before the page number. + % + % The `\ ' here is removed by the implicit \unskip that TeX does as + % part of (the primitive) \par. Without it, a spurious underfull + % \hbox ensues. + \ifpdf + \pdfgettoks#1.% + \ \the\toksA + \else + \ #1% + \fi + \fi + \par + \endgroup +} + +% Like plain.tex's \dotfill, except uses up at least 1 em. +\def\indexdotfill{\cleaders + \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill} + +\def\primary #1{\line{#1\hfil}} + +\newskip\secondaryindent \secondaryindent=0.5cm +\def\secondary#1#2{{% + \parfillskip=0in + \parskip=0in + \hangindent=1in + \hangafter=1 + \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill + \ifpdf + \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. + \else + #2 + \fi + \par +}} + +% Define two-column mode, which we use to typeset indexes. +% Adapted from the TeXbook, page 416, which is to say, +% the manmac.tex format used to print the TeXbook itself. +\catcode`\@=11 + +\newbox\partialpage +\newdimen\doublecolumnhsize + +\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns + % Grab any single-column material above us. + \output = {% + % + % Here is a possibility not foreseen in manmac: if we accumulate a + % whole lot of material, we might end up calling this \output + % routine twice in a row (see the doublecol-lose test, which is + % essentially a couple of indexes with @setchapternewpage off). In + % that case we just ship out what is in \partialpage with the normal + % output routine. Generally, \partialpage will be empty when this + % runs and this will be a no-op. See the indexspread.tex test case. + \ifvoid\partialpage \else + \onepageout{\pagecontents\partialpage}% + \fi + % + \global\setbox\partialpage = \vbox{% + % Unvbox the main output page. + \unvbox\PAGE + \kern-\topskip \kern\baselineskip + }% + }% + \eject % run that output routine to set \partialpage + % + % Use the double-column output routine for subsequent pages. + \output = {\doublecolumnout}% + % + % Change the page size parameters. We could do this once outside this + % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 + % format, but then we repeat the same computation. Repeating a couple + % of assignments once per index is clearly meaningless for the + % execution time, so we may as well do it in one place. + % + % First we halve the line length, less a little for the gutter between + % the columns. We compute the gutter based on the line length, so it + % changes automatically with the paper format. The magic constant + % below is chosen so that the gutter has the same value (well, +-<1pt) + % as it did when we hard-coded it. + % + % We put the result in a separate register, \doublecolumhsize, so we + % can restore it in \pagesofar, after \hsize itself has (potentially) + % been clobbered. + % + \doublecolumnhsize = \hsize + \advance\doublecolumnhsize by -.04154\hsize + \divide\doublecolumnhsize by 2 + \hsize = \doublecolumnhsize + % + % Double the \vsize as well. (We don't need a separate register here, + % since nobody clobbers \vsize.) + \vsize = 2\vsize +} + +% The double-column output routine for all double-column pages except +% the last. +% +\def\doublecolumnout{% + \splittopskip=\topskip \splitmaxdepth=\maxdepth + % Get the available space for the double columns -- the normal + % (undoubled) page height minus any material left over from the + % previous page. + \dimen@ = \vsize + \divide\dimen@ by 2 + \advance\dimen@ by -\ht\partialpage + % + % box0 will be the left-hand column, box2 the right. + \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ + \onepageout\pagesofar + \unvbox255 + \penalty\outputpenalty +} +% +% Re-output the contents of the output page -- any previous material, +% followed by the two boxes we just split, in box0 and box2. +\def\pagesofar{% + \unvbox\partialpage + % + \hsize = \doublecolumnhsize + \wd0=\hsize \wd2=\hsize + \hbox to\pagewidth{\box0\hfil\box2}% +} +% +% All done with double columns. +\def\enddoublecolumns{% + % The following penalty ensures that the page builder is exercised + % _before_ we change the output routine. This is necessary in the + % following situation: + % + % The last section of the index consists only of a single entry. + % Before this section, \pagetotal is less than \pagegoal, so no + % break occurs before the last section starts. However, the last + % section, consisting of \initial and the single \entry, does not + % fit on the page and has to be broken off. Without the following + % penalty the page builder will not be exercised until \eject + % below, and by that time we'll already have changed the output + % routine to the \balancecolumns version, so the next-to-last + % double-column page will be processed with \balancecolumns, which + % is wrong: The two columns will go to the main vertical list, with + % the broken-off section in the recent contributions. As soon as + % the output routine finishes, TeX starts reconsidering the page + % break. The two columns and the broken-off section both fit on the + % page, because the two columns now take up only half of the page + % goal. When TeX sees \eject from below which follows the final + % section, it invokes the new output routine that we've set after + % \balancecolumns below; \onepageout will try to fit the two columns + % and the final section into the vbox of \pageheight (see + % \pagebody), causing an overfull box. + % + % Note that glue won't work here, because glue does not exercise the + % page builder, unlike penalties (see The TeXbook, pp. 280-281). + \penalty0 + % + \output = {% + % Split the last of the double-column material. Leave it on the + % current page, no automatic page break. + \balancecolumns + % + % If we end up splitting too much material for the current page, + % though, there will be another page break right after this \output + % invocation ends. Having called \balancecolumns once, we do not + % want to call it again. Therefore, reset \output to its normal + % definition right away. (We hope \balancecolumns will never be + % called on to balance too much material, but if it is, this makes + % the output somewhat more palatable.) + \global\output = {\onepageout{\pagecontents\PAGE}}% + }% + \eject + \endgroup % started in \begindoublecolumns + % + % \pagegoal was set to the doubled \vsize above, since we restarted + % the current page. We're now back to normal single-column + % typesetting, so reset \pagegoal to the normal \vsize (after the + % \endgroup where \vsize got restored). + \pagegoal = \vsize +} +% +% Called at the end of the double column material. +\def\balancecolumns{% + \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. + \dimen@ = \ht0 + \advance\dimen@ by \topskip + \advance\dimen@ by-\baselineskip + \divide\dimen@ by 2 % target to split to + %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% + \splittopskip = \topskip + % Loop until we get a decent breakpoint. + {% + \vbadness = 10000 + \loop + \global\setbox3 = \copy0 + \global\setbox1 = \vsplit3 to \dimen@ + \ifdim\ht3>\dimen@ + \global\advance\dimen@ by 1pt + \repeat + }% + %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% + \setbox0=\vbox to\dimen@{\unvbox1}% + \setbox2=\vbox to\dimen@{\unvbox3}% + % + \pagesofar +} +\catcode`\@ = \other + + +\message{sectioning,} +% Chapters, sections, etc. + +% \unnumberedno is an oxymoron, of course. 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 +% chapters, we're in trouble anyway, I'm sure.) +\newcount\unnumberedno \unnumberedno = 10000 +\newcount\chapno +\newcount\secno \secno=0 +\newcount\subsecno \subsecno=0 +\newcount\subsubsecno \subsubsecno=0 + +% This counter is funny since it counts through charcodes of letters A, B, ... +\newcount\appendixno \appendixno = `\@ +% +% \def\appendixletter{\char\the\appendixno} +% We do the following ugly conditional instead of the above simple +% construct for the sake of pdftex, which needs the actual +% letter in the expansion, not just typeset. +% +\def\appendixletter{% + \ifnum\appendixno=`A A% + \else\ifnum\appendixno=`B B% + \else\ifnum\appendixno=`C C% + \else\ifnum\appendixno=`D D% + \else\ifnum\appendixno=`E E% + \else\ifnum\appendixno=`F F% + \else\ifnum\appendixno=`G G% + \else\ifnum\appendixno=`H H% + \else\ifnum\appendixno=`I I% + \else\ifnum\appendixno=`J J% + \else\ifnum\appendixno=`K K% + \else\ifnum\appendixno=`L L% + \else\ifnum\appendixno=`M M% + \else\ifnum\appendixno=`N N% + \else\ifnum\appendixno=`O O% + \else\ifnum\appendixno=`P P% + \else\ifnum\appendixno=`Q Q% + \else\ifnum\appendixno=`R R% + \else\ifnum\appendixno=`S S% + \else\ifnum\appendixno=`T T% + \else\ifnum\appendixno=`U U% + \else\ifnum\appendixno=`V V% + \else\ifnum\appendixno=`W W% + \else\ifnum\appendixno=`X X% + \else\ifnum\appendixno=`Y Y% + \else\ifnum\appendixno=`Z Z% + % The \the is necessary, despite appearances, because \appendixletter is + % expanded while writing the .toc file. \char\appendixno is not + % expandable, thus it is written literally, thus all appendixes come out + % with the same letter (or @) in the toc without it. + \else\char\the\appendixno + \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi + \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} + +% Each @chapter defines these (using marks) as the number+name, number +% and name of the chapter. Page headings and footings can use +% these. @section does likewise. +\def\thischapter{} +\def\thischapternum{} +\def\thischaptername{} +\def\thissection{} +\def\thissectionnum{} +\def\thissectionname{} + +\newcount\absseclevel % used to calculate proper heading level +\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count + +% @raisesections: treat @section as chapter, @subsection as section, etc. +\def\raisesections{\global\advance\secbase by -1} +\let\up=\raisesections % original BFox name + +% @lowersections: treat @chapter as section, @section as subsection, etc. +\def\lowersections{\global\advance\secbase by 1} +\let\down=\lowersections % original BFox name + +% we only have subsub. +\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 +% +% Trace whether the current chapter is an appendix or not: +% \chapheadtype is "N" or "A", unnumbered chapters are ignored. +\def\chapheadtype{N} + +% Choose a heading macro +% #1 is heading type +% #2 is heading level +% #3 is text for heading +\def\genhead#1#2#3{% + % Compute the abs. sec. level: + \absseclevel=#2 + \advance\absseclevel by \secbase + % Make sure \absseclevel doesn't fall outside the range: + \ifnum \absseclevel < 0 + \absseclevel = 0 + \else + \ifnum \absseclevel > 3 + \absseclevel = 3 + \fi + \fi + % The heading type: + \def\headtype{#1}% + \if \headtype U% + \ifnum \absseclevel < \unmlevel + \chardef\unmlevel = \absseclevel + \fi + \else + % Check for appendix sections: + \ifnum \absseclevel = 0 + \edef\chapheadtype{\headtype}% + \else + \if \headtype A\if \chapheadtype N% + \errmessage{@appendix... within a non-appendix chapter}% + \fi\fi + \fi + % Check for numbered within unnumbered: + \ifnum \absseclevel > \unmlevel + \def\headtype{U}% + \else + \chardef\unmlevel = 3 + \fi + \fi + % Now print the heading: + \if \headtype U% + \ifcase\absseclevel + \unnumberedzzz{#3}% + \or \unnumberedseczzz{#3}% + \or \unnumberedsubseczzz{#3}% + \or \unnumberedsubsubseczzz{#3}% + \fi + \else + \if \headtype A% + \ifcase\absseclevel + \appendixzzz{#3}% + \or \appendixsectionzzz{#3}% + \or \appendixsubseczzz{#3}% + \or \appendixsubsubseczzz{#3}% + \fi + \else + \ifcase\absseclevel + \chapterzzz{#3}% + \or \seczzz{#3}% + \or \numberedsubseczzz{#3}% + \or \numberedsubsubseczzz{#3}% + \fi + \fi + \fi + \suppressfirstparagraphindent +} + +% an interface: +\def\numhead{\genhead N} +\def\apphead{\genhead A} +\def\unnmhead{\genhead U} + +% @chapter, @appendix, @unnumbered. Increment top-level counter, reset +% all lower-level sectioning counters to zero. +% +% Also set \chaplevelprefix, which we prepend to @float sequence numbers +% (e.g., figures), q.v. By default (before any chapter), that is empty. +\let\chaplevelprefix = \empty +% +\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz +\def\chapterzzz#1{% + % section resetting is \global in case the chapter is in a group, such + % as an @include file. + \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 + \global\advance\chapno by 1 + % + % Used for \float. + \gdef\chaplevelprefix{\the\chapno.}% + \resetallfloatnos + % + % \putwordChapter can contain complex things in translations. + \toks0=\expandafter{\putwordChapter}% + \message{\the\toks0 \space \the\chapno}% + % + % Write the actual heading. + \chapmacro{#1}{Ynumbered}{\the\chapno}% + % + % So @section and the like are numbered underneath this chapter. + \global\let\section = \numberedsec + \global\let\subsection = \numberedsubsec + \global\let\subsubsection = \numberedsubsubsec +} + +\outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz +% +\def\appendixzzz#1{% + \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 + \global\advance\appendixno by 1 + \gdef\chaplevelprefix{\appendixletter.}% + \resetallfloatnos + % + % \putwordAppendix can contain complex things in translations. + \toks0=\expandafter{\putwordAppendix}% + \message{\the\toks0 \space \appendixletter}% + % + \chapmacro{#1}{Yappendix}{\appendixletter}% + % + \global\let\section = \appendixsec + \global\let\subsection = \appendixsubsec + \global\let\subsubsection = \appendixsubsubsec +} + +\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz +\def\unnumberedzzz#1{% + \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 + \global\advance\unnumberedno by 1 + % + % Since an unnumbered has no number, no prefix for figures. + \global\let\chaplevelprefix = \empty + \resetallfloatnos + % + % This used to be simply \message{#1}, but TeX fully expands the + % argument to \message. Therefore, if #1 contained @-commands, TeX + % expanded them. For example, in `@unnumbered The @cite{Book}', TeX + % expanded @cite (which turns out to cause errors because \cite is meant + % to be executed, not expanded). + % + % Anyway, we don't want the fully-expanded definition of @cite to appear + % as a result of the \message, we just want `@cite' itself. We use + % \the<toks register> to achieve this: TeX expands \the<toks> only once, + % simply yielding the contents of <toks register>. (We also do this for + % the toc entries.) + \toks0 = {#1}% + \message{(\the\toks0)}% + % + \chapmacro{#1}{Ynothing}{\the\unnumberedno}% + % + \global\let\section = \unnumberedsec + \global\let\subsection = \unnumberedsubsec + \global\let\subsubsection = \unnumberedsubsubsec +} + +% @centerchap is like @unnumbered, but the heading is centered. +\outer\parseargdef\centerchap{% + % Well, we could do the following in a group, but that would break + % an assumption that \chapmacro is called at the outermost level. + % Thus we are safer this way: --kasal, 24feb04 + \let\centerparametersmaybe = \centerparameters + \unnmhead0{#1}% + \let\centerparametersmaybe = \relax +} + +% @top is like @unnumbered. +\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 +\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 +\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 +\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 +\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 +\def\unnumberedsubseczzz#1{% + \global\subsubsecno=0 \global\advance\subsecno by 1 + \sectionheading{#1}{subsec}{Ynothing}% + {\the\unnumberedno.\the\secno.\the\subsecno}% +} + +% Subsubsections. +\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz +\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 +\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 +\def\unnumberedsubsubseczzz#1{% + \global\advance\subsubsecno by 1 + \sectionheading{#1}{subsubsec}{Ynothing}% + {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% +} + +% These macros control what the section commands do, according +% to what kind of chapter we are in (ordinary, appendix, or unnumbered). +% Define them by default for a numbered chapter. +\let\section = \numberedsec +\let\subsection = \numberedsubsec +\let\subsubsection = \numberedsubsubsec + +% 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 +} + +\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 + \suppressfirstparagraphindent +} + +% @heading, @subheading, @subsubheading. +\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} + \suppressfirstparagraphindent} +\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} + \suppressfirstparagraphindent} +\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} + \suppressfirstparagraphindent} + +% These macros generate a chapter, section, etc. heading only +% (including whitespace, linebreaking, etc. around it), +% given all the information in convenient, parsed form. + +%%% 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 + +\def\chapbreak{\dobreak \chapheadingskip {-4000}} +\def\chappager{\par\vfill\supereject} +% Because \domark is called before \chapoddpage, the filler page will +% get the headings for the next chapter, which is wrong. But we don't +% care -- we just disable all headings on the filler page. +\def\chapoddpage{% + \chappager + \ifodd\pageno \else + \begingroup + \evenheadline={\hfil}\evenfootline={\hfil}% + \oddheadline={\hfil}\oddfootline={\hfil}% + \hbox to 0pt{}% + \chappager + \endgroup + \fi +} + +\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} + +\def\CHAPPAGoff{% +\global\let\contentsalignmacro = \chappager +\global\let\pchapsepmacro=\chapbreak +\global\let\pagealignmacro=\chappager} + +\def\CHAPPAGon{% +\global\let\contentsalignmacro = \chappager +\global\let\pchapsepmacro=\chappager +\global\let\pagealignmacro=\chappager +\global\def\HEADINGSon{\HEADINGSsingle}} + +\def\CHAPPAGodd{% +\global\let\contentsalignmacro = \chapoddpage +\global\let\pchapsepmacro=\chapoddpage +\global\let\pagealignmacro=\chapoddpage +\global\def\HEADINGSon{\HEADINGSdouble}} + +\CHAPPAGon + +% Chapter opening. +% +% #1 is the text, #2 is the section type (Ynumbered, Ynothing, +% Yappendix, Yomitfromtoc), #3 the chapter number. +% +% To test against our argument. +\def\Ynothingkeyword{Ynothing} +\def\Yomitfromtockeyword{Yomitfromtoc} +\def\Yappendixkeyword{Yappendix} +% +\def\chapmacro#1#2#3{% + % Insert the first mark before the heading break (see notes for \domark). + \let\prevchapterdefs=\lastchapterdefs + \let\prevsectiondefs=\lastsectiondefs + \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}% + \gdef\thissection{}}% + % + \def\temptype{#2}% + \ifx\temptype\Ynothingkeyword + \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% + \gdef\thischapter{\thischaptername}}% + \else\ifx\temptype\Yomitfromtockeyword + \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% + \gdef\thischapter{}}% + \else\ifx\temptype\Yappendixkeyword + \toks0={#1}% + \xdef\lastchapterdefs{% + \gdef\noexpand\thischaptername{\the\toks0}% + \gdef\noexpand\thischapternum{\appendixletter}% + % \noexpand\putwordAppendix avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thischapter{\noexpand\putwordAppendix{} + \noexpand\thischapternum: + \noexpand\thischaptername}% + }% + \else + \toks0={#1}% + \xdef\lastchapterdefs{% + \gdef\noexpand\thischaptername{\the\toks0}% + \gdef\noexpand\thischapternum{\the\chapno}% + % \noexpand\putwordChapter avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thischapter{\noexpand\putwordChapter{} + \noexpand\thischapternum: + \noexpand\thischaptername}% + }% + \fi\fi\fi + % + % Output the mark. Pass it through \safewhatsit, to take care of + % the preceding space. + \safewhatsit\domark + % + % Insert the chapter heading break. + \pchapsepmacro + % + % Now the second mark, after the heading break. No break points + % between here and the heading. + \let\prevchapterdefs=\lastchapterdefs + \let\prevsectiondefs=\lastsectiondefs + \domark + % + {% + \chapfonts \rmisbold + % + % Have to define \lastsection before calling \donoderef, because the + % xref code eventually uses it. On the other hand, it has to be called + % after \pchapsepmacro, or the headline will change too soon. + \gdef\lastsection{#1}% + % + % Only insert the separating space if we have a chapter/appendix + % number, and don't print the unnumbered ``number''. + \ifx\temptype\Ynothingkeyword + \setbox0 = \hbox{}% + \def\toctype{unnchap}% + \else\ifx\temptype\Yomitfromtockeyword + \setbox0 = \hbox{}% contents like unnumbered, but no toc entry + \def\toctype{omit}% + \else\ifx\temptype\Yappendixkeyword + \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% + \def\toctype{app}% + \else + \setbox0 = \hbox{#3\enspace}% + \def\toctype{numchap}% + \fi\fi\fi + % + % Write the toc entry for this chapter. Must come before the + % \donoderef, because we include the current node name in the toc + % entry, and \donoderef resets it to empty. + \writetocentry{\toctype}{#1}{#3}% + % + % For pdftex, we have to write out the node definition (aka, make + % the pdfdest) after any page break, but before the actual text has + % been typeset. If the destination for the pdf outline is after the + % text, then jumping from the outline may wind up with the text not + % being visible, for instance under high magnification. + \donoderef{#2}% + % + % Typeset the actual heading. + \nobreak % Avoid page breaks at the interline glue. + \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright + \hangindent=\wd0 \centerparametersmaybe + \unhbox0 #1\par}% + }% + \nobreak\bigskip % no page break after a chapter title + \nobreak +} + +% @centerchap -- centered and unnumbered. +\let\centerparametersmaybe = \relax +\def\centerparameters{% + \advance\rightskip by 3\rightskip + \leftskip = \rightskip + \parfillskip = 0pt +} + + +% I don't think this chapter style is supported any more, so I'm not +% updating it with the new noderef stuff. We'll see. --karl, 11aug03. +% +\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 +} +\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 +} +\def\CHAPFopen{% + \global\let\chapmacro=\chfopen + \global\let\centerchapmacro=\centerchfopen} + + +% Section titles. These macros combine the section number parts and +% call the generic \sectionheading to do the printing. +% +\newskip\secheadingskip +\def\secheadingbreak{\dobreak \secheadingskip{-1000}} + +% Subsection titles. +\newskip\subsecheadingskip +\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} + +% Subsubsection titles. +\def\subsubsecheadingskip{\subsecheadingskip} +\def\subsubsecheadingbreak{\subsecheadingbreak} + + +% Print any size, any type, section title. +% +% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is +% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the +% section number. +% +\def\seckeyword{sec} +% +\def\sectionheading#1#2#3#4{% + {% + % Switch to the right set of fonts. + \csname #2fonts\endcsname \rmisbold + % + \def\sectionlevel{#2}% + \def\temptype{#3}% + % + % Insert first mark before the heading break (see notes for \domark). + \let\prevsectiondefs=\lastsectiondefs + \ifx\temptype\Ynothingkeyword + \ifx\sectionlevel\seckeyword + \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}% + \gdef\thissection{\thissectionname}}% + \fi + \else\ifx\temptype\Yomitfromtockeyword + % Don't redefine \thissection. + \else\ifx\temptype\Yappendixkeyword + \ifx\sectionlevel\seckeyword + \toks0={#1}% + \xdef\lastsectiondefs{% + \gdef\noexpand\thissectionname{\the\toks0}% + \gdef\noexpand\thissectionnum{#4}% + % \noexpand\putwordSection avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thissection{\noexpand\putwordSection{} + \noexpand\thissectionnum: + \noexpand\thissectionname}% + }% + \fi + \else + \ifx\sectionlevel\seckeyword + \toks0={#1}% + \xdef\lastsectiondefs{% + \gdef\noexpand\thissectionname{\the\toks0}% + \gdef\noexpand\thissectionnum{#4}% + % \noexpand\putwordSection avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thissection{\noexpand\putwordSection{} + \noexpand\thissectionnum: + \noexpand\thissectionname}% + }% + \fi + \fi\fi\fi + % + % Go into vertical mode. Usually we'll already be there, but we + % don't want the following whatsit to end up in a preceding paragraph + % if the document didn't happen to have a blank line. + \par + % + % Output the mark. Pass it through \safewhatsit, to take care of + % the preceding space. + \safewhatsit\domark + % + % Insert space above the heading. + \csname #2headingbreak\endcsname + % + % Now the second mark, after the heading break. No break points + % between here and the heading. + \let\prevsectiondefs=\lastsectiondefs + \domark + % + % Only insert the space after the number if we have a section number. + \ifx\temptype\Ynothingkeyword + \setbox0 = \hbox{}% + \def\toctype{unn}% + \gdef\lastsection{#1}% + \else\ifx\temptype\Yomitfromtockeyword + % for @headings -- no section number, don't include in toc, + % and don't redefine \lastsection. + \setbox0 = \hbox{}% + \def\toctype{omit}% + \let\sectionlevel=\empty + \else\ifx\temptype\Yappendixkeyword + \setbox0 = \hbox{#4\enspace}% + \def\toctype{app}% + \gdef\lastsection{#1}% + \else + \setbox0 = \hbox{#4\enspace}% + \def\toctype{num}% + \gdef\lastsection{#1}% + \fi\fi\fi + % + % Write the toc entry (before \donoderef). See comments in \chapmacro. + \writetocentry{\toctype\sectionlevel}{#1}{#4}% + % + % Write the node reference (= pdf destination for pdftex). + % Again, see comments in \chapmacro. + \donoderef{#3}% + % + % Interline glue will be inserted when the vbox is completed. + % That glue will be a valid breakpoint for the page, since it'll be + % preceded by a whatsit (usually from the \donoderef, or from the + % \writetocentry if there was no node). We don't want to allow that + % break, since then the whatsits could end up on page n while the + % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000. + \nobreak + % + % Output the actual section heading. + \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright + \hangindent=\wd0 % zero if no section number + \unhbox0 #1}% + }% + % Add extra space after the heading -- half of whatever came above it. + % Don't allow stretch, though. + \kern .5 \csname #2headingskip\endcsname + % + % Do not let the kern be a potential breakpoint, as it would be if it + % was followed by glue. + \nobreak + % + % 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.) + \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 + \penalty 10001 +} + + +\message{toc,} +% Table of contents. +\newwrite\tocfile + +% Write an entry to the toc file, opening it if necessary. +% Called from @chapter, etc. +% +% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} +% We append the current node name (if any) and page number as additional +% arguments for the \{chap,sec,...}entry macros which will eventually +% read this. The node name is used in the pdf outlines as the +% destination to jump to. +% +% We open the .toc file for writing here instead of at @setfilename (or +% any other fixed time) so that @contents can be anywhere in the document. +% But if #1 is `omit', then we don't do anything. This is used for the +% table of contents chapter openings themselves. +% +\newif\iftocfileopened +\def\omitkeyword{omit}% +% +\def\writetocentry#1#2#3{% + \edef\writetoctype{#1}% + \ifx\writetoctype\omitkeyword \else + \iftocfileopened\else + \immediate\openout\tocfile = \jobname.toc + \global\tocfileopenedtrue + \fi + % + \iflinks + {\atdummies + \edef\temp{% + \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}% + \temp + }% + \fi + \fi + % + % Tell \shipout to create a pdf destination on each page, if we're + % writing pdf. These are used in the table of contents. We can't + % just write one on every page because the title pages are numbered + % 1 and 2 (the page numbers aren't printed), and so are the first + % two pages of the document. Thus, we'd have two destinations named + % `1', and two named `2'. + \ifpdf \global\pdfmakepagedesttrue \fi +} + + +% These characters do not print properly in the Computer Modern roman +% fonts, so we must take special care. This is more or less redundant +% with the Texinfo input format setup at the end of this file. +% +\def\activecatcodes{% + \catcode`\"=\active + \catcode`\$=\active + \catcode`\<=\active + \catcode`\>=\active + \catcode`\\=\active + \catcode`\^=\active + \catcode`\_=\active + \catcode`\|=\active + \catcode`\~=\active +} + + +% Read the toc file, which is essentially Texinfo input. +\def\readtocfile{% + \setupdatafile + \activecatcodes + \input \tocreadfilename +} + +\newskip\contentsrightmargin \contentsrightmargin=1in +\newcount\savepageno +\newcount\lastnegativepageno \lastnegativepageno = -1 + +% Prepare to read what we've written to \tocfile. +% +\def\startcontents#1{% + % If @setchapternewpage on, and @headings double, the contents should + % start on an odd page, unlike chapters. Thus, we maintain + % \contentsalignmacro in parallel with \pagealignmacro. + % From: Torbjorn Granlund <tege@matematik.su.se> + \contentsalignmacro + \immediate\closeout\tocfile + % + % Don't need to put `Contents' or `Short Contents' in the headline. + % It is abundantly clear what they are. + \chapmacro{#1}{Yomitfromtoc}{}% + % + \savepageno = \pageno + \begingroup % Set up to handle contents files properly. + \raggedbottom % Worry more about breakpoints than the bottom. + \advance\hsize by -\contentsrightmargin % Don't use the full line length. + % + % Roman numerals for page numbers. + \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi +} + +% redefined for the two-volume lispref. We always output on +% \jobname.toc even if this is redefined. +% +\def\tocreadfilename{\jobname.toc} + +% Normal (long) toc. +% +\def\contents{% + \startcontents{\putwordTOC}% + \openin 1 \tocreadfilename\space + \ifeof 1 \else + \readtocfile + \fi + \vfill \eject + \contentsalignmacro % in case @setchapternewpage odd is in effect + \ifeof 1 \else + \pdfmakeoutlines + \fi + \closein 1 + \endgroup + \lastnegativepageno = \pageno + \global\pageno = \savepageno +} + +% And just the chapters. +\def\summarycontents{% + \startcontents{\putwordShortTOC}% + % + \let\numchapentry = \shortchapentry + \let\appentry = \shortchapentry + \let\unnchapentry = \shortunnchapentry + % We want a true roman here for the page numbers. + \secfonts + \let\rm=\shortcontrm \let\bf=\shortcontbf + \let\sl=\shortcontsl \let\tt=\shortconttt + \rm + \hyphenpenalty = 10000 + \advance\baselineskip by 1pt % Open it up a little. + \def\numsecentry##1##2##3##4{} + \let\appsecentry = \numsecentry + \let\unnsecentry = \numsecentry + \let\numsubsecentry = \numsecentry + \let\appsubsecentry = \numsecentry + \let\unnsubsecentry = \numsecentry + \let\numsubsubsecentry = \numsecentry + \let\appsubsubsecentry = \numsecentry + \let\unnsubsubsecentry = \numsecentry + \openin 1 \tocreadfilename\space + \ifeof 1 \else + \readtocfile + \fi + \closein 1 + \vfill \eject + \contentsalignmacro % in case @setchapternewpage odd is in effect + \endgroup + \lastnegativepageno = \pageno + \global\pageno = \savepageno +} +\let\shortcontents = \summarycontents + +% Typeset the label for a chapter or appendix for the short contents. +% The arg is, e.g., `A' for an appendix, or `3' for a chapter. +% +\def\shortchaplabel#1{% + % This space should be enough, since a single number is .5em, and the + % widest letter (M) is 1em, at least in the Computer Modern fonts. + % But use \hss just in case. + % (This space doesn't include the extra space that gets added after + % the label; that gets put in by \shortchapentry above.) + % + % We'd like to right-justify chapter numbers, but that looks strange + % with appendix letters. And right-justifying numbers and + % left-justifying letters looks strange when there is less than 10 + % chapters. Have to read the whole toc once to know how many chapters + % there are before deciding ... + \hbox to 1em{#1\hss}% +} + +% These macros generate individual entries in the table of contents. +% The first argument is the chapter or section name. +% The last argument is the page number. +% The arguments in between are the chapter number, section number, ... + +% Chapters, in the main contents. +\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} +% +% Chapters, in the short toc. +% See comments in \dochapentry re vbox and related settings. +\def\shortchapentry#1#2#3#4{% + \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% +} + +% Appendices, in the main contents. +% Need the word Appendix, and a fixed-size box. +% +\def\appendixbox#1{% + % We use M since it's probably the widest letter. + \setbox0 = \hbox{\putwordAppendix{} M}% + \hbox to \wd0{\putwordAppendix{} #1\hss}} +% +\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} + +% Unnumbered chapters. +\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} +\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} + +% Sections. +\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} +\let\appsecentry=\numsecentry +\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} + +% Subsections. +\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} +\let\appsubsecentry=\numsubsecentry +\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} + +% And subsubsections. +\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} +\let\appsubsubsecentry=\numsubsubsecentry +\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} + +% This parameter controls the indentation of the various levels. +% Same as \defaultparindent. +\newdimen\tocindent \tocindent = 15pt + +% Now for the actual typesetting. In all these, #1 is the text and #2 is the +% page number. +% +% If the toc has to be broken over pages, we want it to be at chapters +% if at all possible; hence the \penalty. +\def\dochapentry#1#2{% + \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip + \begingroup + \chapentryfonts + \tocentry{#1}{\dopageno\bgroup#2\egroup}% + \endgroup + \nobreak\vskip .25\baselineskip plus.1\baselineskip +} + +\def\dosecentry#1#2{\begingroup + \secentryfonts \leftskip=\tocindent + \tocentry{#1}{\dopageno\bgroup#2\egroup}% +\endgroup} + +\def\dosubsecentry#1#2{\begingroup + \subsecentryfonts \leftskip=2\tocindent + \tocentry{#1}{\dopageno\bgroup#2\egroup}% +\endgroup} + +\def\dosubsubsecentry#1#2{\begingroup + \subsubsecentryfonts \leftskip=3\tocindent + \tocentry{#1}{\dopageno\bgroup#2\egroup}% +\endgroup} + +% We use the same \entry macro as for the index entries. +\let\tocentry = \entry + +% Space between chapter (or whatever) number and the title. +\def\labelspace{\hskip1em \relax} + +\def\dopageno#1{{\rm #1}} +\def\doshortpageno#1{{\rm #1}} + +\def\chapentryfonts{\secfonts \rm} +\def\secentryfonts{\textfonts} +\def\subsecentryfonts{\textfonts} +\def\subsubsecentryfonts{\textfonts} + + +\message{environments,} +% @foo ... @end foo. + +% @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. + +\envdef\tex{% + \setupmarkupstyle{tex}% + \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 + \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 + \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie + \catcode `\%=14 + \catcode `\+=\other + \catcode `\"=\other + \catcode `\|=\other + \catcode `\<=\other + \catcode `\>=\other + \catcode`\`=\other + \catcode`\'=\other + \escapechar=`\\ + % + \let\b=\ptexb + \let\bullet=\ptexbullet + \let\c=\ptexc + \let\,=\ptexcomma + \let\.=\ptexdot + \let\dots=\ptexdots + \let\equiv=\ptexequiv + \let\!=\ptexexclam + \let\i=\ptexi + \let\indent=\ptexindent + \let\noindent=\ptexnoindent + \let\{=\ptexlbrace + \let\+=\tabalign + \let\}=\ptexrbrace + \let\/=\ptexslash + \let\*=\ptexstar + \let\t=\ptext + \expandafter \let\csname top\endcsname=\ptextop % outer + \let\frenchspacing=\plainfrenchspacing + % + \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% + \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% + \def\@{@}% +} +% There is no need to define \Etex. + +% Define @lisp ... @end lisp. +% @lisp environment forms a group so it can rebind things, +% including the definition of @end lisp (which normally is erroneous). + +% Amount to narrow the margins by for @lisp. +\newskip\lispnarrowing \lispnarrowing=0.4in + +% This is the definition that ^^M gets inside @lisp, @example, and other +% such environments. \null is better than a space, since it doesn't +% have any width. +\def\lisppar{\null\endgraf} + +% This space is always present above and below environments. +\newskip\envskipamount \envskipamount = 0pt + +% Make spacing and below environment symmetrical. We use \parskip here +% to help in doing that, since in @example-like environments \parskip +% is reset to zero; thus the \afterenvbreak inserts no space -- but the +% start of the next paragraph will insert \parskip. +% +\def\aboveenvbreak{{% + % =10000 instead of <10000 because of a special case in \itemzzz and + % \sectionheading, q.v. + \ifnum \lastpenalty=10000 \else + \advance\envskipamount by \parskip + \endgraf + \ifdim\lastskip<\envskipamount + \removelastskip + % it's not a good place to break if the last penalty was \nobreak + % or better ... + \ifnum\lastpenalty<10000 \penalty-50 \fi + \vskip\envskipamount + \fi + \fi +}} + +\let\afterenvbreak = \aboveenvbreak + +% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will +% also clear it, so that its embedded environments do the narrowing again. +\let\nonarrowing=\relax + +% @cartouche ... @end cartouche: draw rectangle w/rounded corners around +% environment contents. +\font\circle=lcircle10 +\newdimen\circthick +\newdimen\cartouter\newdimen\cartinner +\newskip\normbskip\newskip\normpskip\newskip\normlskip +\circthick=\fontdimen8\circle +% +\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth +\def\ctr{{\hskip 6pt\circle\char'010}} +\def\cbl{{\circle\char'012\hskip -6pt}} +\def\cbr{{\hskip 6pt\circle\char'011}} +\def\carttop{\hbox to \cartouter{\hskip\lskip + \ctl\leaders\hrule height\circthick\hfil\ctr + \hskip\rskip}} +\def\cartbot{\hbox to \cartouter{\hskip\lskip + \cbl\leaders\hrule height\circthick\hfil\cbr + \hskip\rskip}} +% +\newskip\lskip\newskip\rskip + +\envdef\cartouche{% + \ifhmode\par\fi % can't be in the midst of a paragraph. + \startsavinginserts + \lskip=\leftskip \rskip=\rightskip + \leftskip=0pt\rightskip=0pt % we want these *outside*. + \cartinner=\hsize \advance\cartinner by-\lskip + \advance\cartinner by-\rskip + \cartouter=\hsize + \advance\cartouter by 18.4pt % allow for 3pt kerns on either + % side, and for 6pt waste from + % each corner char, and rule thickness + \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip + % Flag to tell @lisp, etc., not to narrow margin. + \let\nonarrowing = t% + \vbox\bgroup + \baselineskip=0pt\parskip=0pt\lineskip=0pt + \carttop + \hbox\bgroup + \hskip\lskip + \vrule\kern3pt + \vbox\bgroup + \kern3pt + \hsize=\cartinner + \baselineskip=\normbskip + \lineskip=\normlskip + \parskip=\normpskip + \vskip -\parskip + \comment % For explanation, see the end of \def\group. +} +\def\Ecartouche{% + \ifhmode\par\fi + \kern3pt + \egroup + \kern3pt\vrule + \hskip\rskip + \egroup + \cartbot + \egroup + \checkinserts +} + + +% This macro is called at the beginning of all the @example variants, +% inside a group. +\newdimen\nonfillparindent +\def\nonfillstart{% + \aboveenvbreak + \hfuzz = 12pt % Don't be fussy + \sepspaces % Make spaces be word-separators rather than space tokens. + \let\par = \lisppar % don't ignore blank lines + \obeylines % each line of input is a line of output + \parskip = 0pt + % Turn off paragraph indentation but redefine \indent to emulate + % the normal \indent. + \nonfillparindent=\parindent + \parindent = 0pt + \let\indent\nonfillindent + % + \emergencystretch = 0pt % don't try to avoid overfull boxes + \ifx\nonarrowing\relax + \advance \leftskip by \lispnarrowing + \exdentamount=\lispnarrowing + \else + \let\nonarrowing = \relax + \fi + \let\exdent=\nofillexdent +} + +\begingroup +\obeyspaces +% We want to swallow spaces (but not other tokens) after the fake +% @indent in our nonfill-environments, where spaces are normally +% active and set to @tie, resulting in them not being ignored after +% @indent. +\gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}% +\gdef\nonfillindentcheck{% +\ifx\temp % +\expandafter\nonfillindentgobble% +\else% +\leavevmode\nonfillindentbox% +\fi% +}% +\endgroup +\def\nonfillindentgobble#1{\nonfillindent} +\def\nonfillindentbox{\hbox to \nonfillparindent{\hss}} + +% If you want all examples etc. small: @set dispenvsize small. +% If you want even small examples the full size: @set dispenvsize nosmall. +% This affects the following displayed environments: +% @example, @display, @format, @lisp +% +\def\smallword{small} +\def\nosmallword{nosmall} +\let\SETdispenvsize\relax +\def\setnormaldispenv{% + \ifx\SETdispenvsize\smallword + % end paragraph for sake of leading, in case document has no blank + % line. This is redundant with what happens in \aboveenvbreak, but + % we need to do it before changing the fonts, and it's inconvenient + % to change the fonts afterward. + \ifnum \lastpenalty=10000 \else \endgraf \fi + \smallexamplefonts \rm + \fi +} +\def\setsmalldispenv{% + \ifx\SETdispenvsize\nosmallword + \else + \ifnum \lastpenalty=10000 \else \endgraf \fi + \smallexamplefonts \rm + \fi +} + +% 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} + \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} +} + +% @lisp: indented, narrowed, typewriter font; @example: same as @lisp. +% +% @smallexample and @smalllisp: use smaller fonts. +% Originally contributed by Pavel@xerox. +% +\maketwodispenvs {lisp}{example}{% + \nonfillstart + \tt\setupmarkupstyle{example}% + \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. + \gobble % eat return +} +% @display/@smalldisplay: same as @lisp except keep current font. +% +\makedispenv {display}{% + \nonfillstart + \gobble +} + +% @format/@smallformat: same as @display except don't narrow margins. +% +\makedispenv{format}{% + \let\nonarrowing = t% + \nonfillstart + \gobble +} + +% @flushleft: same as @format, but doesn't obey \SETdispenvsize. +\envdef\flushleft{% + \let\nonarrowing = t% + \nonfillstart + \gobble +} +\let\Eflushleft = \afterenvbreak + +% @flushright. +% +\envdef\flushright{% + \let\nonarrowing = t% + \nonfillstart + \advance\leftskip by 0pt plus 1fill + \gobble +} +\let\Eflushright = \afterenvbreak + + +% @raggedright does more-or-less normal line breaking but no right +% justification. From plain.tex. +\envdef\raggedright{% + \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax +} +\let\Eraggedright\par + +\envdef\raggedleft{% + \parindent=0pt \leftskip0pt plus2em + \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt + \hbadness=10000 % Last line will usually be underfull, so turn off + % badness reporting. +} +\let\Eraggedleft\par + +\envdef\raggedcenter{% + \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em + \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt + \hbadness=10000 % Last line will usually be underfull, so turn off + % badness reporting. +} +\let\Eraggedcenter\par + + +% @quotation does normal linebreaking (hence we can't use \nonfillstart) +% and narrows the margins. We keep \parskip nonzero in general, since +% we're doing normal filling. So, when using \aboveenvbreak and +% \afterenvbreak, temporarily make \parskip 0. +% +\def\quotationstart{% + {\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 + \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 + % indent a bit. + \leftline{\kern 2\leftskip \sl ---\quotationauthor}% + \fi + {\parskip=0pt \afterenvbreak}% +} + +% If we're given an argument, typeset it in bold with a colon after. +\def\quotationlabel#1{% + \def\temp{#1}% + \ifx\temp\empty \else + {\bf #1: }% + \fi +} + + +% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} +% If we want to allow any <char> as delimiter, +% we need the curly braces so that makeinfo sees the @verb command, eg: +% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org +% +% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. +% +% [Knuth] p.344; only we need to do the other characters Texinfo sets +% active too. Otherwise, they get lost as the first character on a +% verbatim line. +\def\dospecials{% + \do\ \do\\\do\{\do\}\do\$\do\&% + \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% + \do\<\do\>\do\|\do\@\do+\do\"% + % Don't do the quotes -- if we do, @set txicodequoteundirected and + % @set txicodequotebacktick will not have effect on @verb and + % @verbatim, and ?` and !` ligatures won't get disabled. + %\do\`\do\'% +} +% +% [Knuth] p. 380 +\def\uncatcodespecials{% + \def\do##1{\catcode`##1=\other}\dospecials} +% +% Setup for the @verb command. +% +% Eight spaces for a tab +\begingroup + \catcode`\^^I=\active + \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} +\endgroup +% +\def\setupverb{% + \tt % easiest (and conventionally used) font for verbatim + \def\par{\leavevmode\endgraf}% + \setupmarkupstyle{verb}% + \tabeightspaces + % Respect line breaks, + % print special symbols as themselves, and + % make each space count + % must do in this order: + \obeylines \uncatcodespecials \sepspaces +} + +% Setup for the @verbatim environment +% +% Real tab expansion +\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount +% +\def\starttabbox{\setbox0=\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 + }% + } +\endgroup + +% start the verbatim environment. +\def\setupverbatim{% + \let\nonarrowing = t% + \nonfillstart + % Easiest (and conventionally used) font for verbatim + \tt + \def\par{\leavevmode\egroup\box0\endgraf}% + \tabexpand + \setupmarkupstyle{verbatim}% + % Respect line breaks, + % print special symbols as themselves, and + % make each space count + % must do in this order: + \obeylines \uncatcodespecials \sepspaces + \everypar{\starttabbox}% +} + +% Do the @verb magic: verbatim text is quoted by unique +% delimiter characters. Before first delimiter expect a +% right brace, after last delimiter expect closing brace: +% +% \def\doverb'{'<char>#1<char>'}'{#1} +% +% [Knuth] p. 382; only eat outer {} +\begingroup + \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other + \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] +\endgroup +% +\def\verb{\begingroup\setupverb\doverb} +% +% +% Do the @verbatim magic: define the macro \doverbatim so that +% the (first) argument ends when '@end verbatim' is reached, ie: +% +% \def\doverbatim#1@end verbatim{#1} +% +% For Texinfo it's a lot easier than for LaTeX, +% because texinfo's \verbatim doesn't stop at '\end{verbatim}': +% we need not redefine '\', '{' and '}'. +% +% Inspired by LaTeX's verbatim command set [latex.ltx] +% +\begingroup + \catcode`\ =\active + \obeylines % + % ignore everything up to the first ^^M, that's the newline at the end + % of the @verbatim input line itself. Otherwise we get an extra blank + % line in the output. + \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% + % We really want {...\end verbatim} in the body of the macro, but + % without the active space; thus we have to use \xdef and \gobble. +\endgroup +% +\envdef\verbatim{% + \setupverbatim\doverbatim +} +\let\Everbatim = \afterenvbreak + + +% @verbatiminclude FILE - insert text of file in verbatim environment. +% +\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} +% +\def\doverbatiminclude#1{% + {% + \makevalueexpandable + \setupverbatim + \indexnofonts % Allow `@@' and other weird things in file names. + \input #1 + \afterenvbreak + }% +} + +% @copying ... @end copying. +% Save the text away for @insertcopying later. +% +% We save the uninterpreted tokens, rather than creating a box. +% Saving the text in a box would be much easier, but then all the +% typesetting commands (@smallbook, font changes, etc.) have to be done +% beforehand -- and a) we want @copying to be done first in the source +% file; b) letting users define the frontmatter in as flexible order as +% possible is very desirable. +% +\def\copying{\checkenv{}\begingroup\scanargctxt\docopying} +\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}} +% +\def\insertcopying{% + \begingroup + \parindent = 0pt % paragraph indentation looks wrong on title page + \scanexp\copyingtext + \endgroup +} + + +\message{defuns,} +% @defun etc. + +\newskip\defbodyindent \defbodyindent=.4in +\newskip\defargsindent \defargsindent=50pt +\newskip\deflastargmargin \deflastargmargin=18pt +\newcount\defunpenalty + +% Start the processing of @deffn: +\def\startdefun{% + \ifnum\lastpenalty<10000 + \medbreak + \defunpenalty=10003 % Will keep this @deffn together with the + % following @def command, see below. + \else + % If there are two @def commands in a row, we'll have a \nobreak, + % which is there to keep the function description together with its + % header. But if there's nothing but headers, we need to allow a + % break somewhere. Check specifically for penalty 10002, inserted + % by \printdefunline, instead of 10000, since the sectioning + % 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 + % with penalty of 10003 after the very first @deffn in the + % sequence (see above), and penalty of 10002 after any following + % @def command. + \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi + % + % Similarly, after a section heading, do not allow a break. + % But do insert the glue. + \medskip % preceded by discardable penalty, so not a breakpoint + \fi + % + \parindent=0in + \advance\leftskip by \defbodyindent + \exdentamount=\defbodyindent +} + +\def\dodefunx#1{% + % First, check whether we are in the right environment: + \checkenv#1% + % + % As above, allow line break if we have multiple x headers in a row. + % It's not a great place, though. + \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi + % + % And now, it's time to reuse the body of the original defun: + \expandafter\gobbledefun#1% +} +\def\gobbledefun#1\startdefun{} + +% \printdefunline \deffnheader{text} +% +\def\printdefunline#1#2{% + \begingroup + % call \deffnheader: + #1#2 \endheader + % common ending: + \interlinepenalty = 10000 + \advance\rightskip by 0pt plus 1fil + \endgraf + \nobreak\vskip -\parskip + \penalty\defunpenalty % signal to \startdefun and \dodefunx + % Some of the @defun-type tags do not enable magic parentheses, + % rendering the following check redundant. But we don't optimize. + \checkparencounts + \endgroup +} + +\def\Edefun{\endgraf\medbreak} + +% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; +% the only thing remaining is to define \deffnheader. +% +\def\makedefun#1{% + \expandafter\let\csname E#1\endcsname = \Edefun + \edef\temp{\noexpand\domakedefun + \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% + \temp +} + +% \domakedefun \deffn \deffnx \deffnheader +% +% Define \deffn and \deffnx, without parameters. +% \deffnheader has to be defined explicitly. +% +\def\domakedefun#1#2#3{% + \envdef#1{% + \startdefun + \parseargusing\activeparens{\printdefunline#3}% + }% + \def#2{\dodefunx#1}% + \def#3% +} + +%%% Untyped functions: + +% @deffn category name args +\makedefun{deffn}{\deffngeneral{}} + +% @deffn category class name args +\makedefun{defop}#1 {\defopon{#1\ \putwordon}} + +% \defopon {category on}class name args +\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } + +% \deffngeneral {subind}category name args +% +\def\deffngeneral#1#2 #3 #4\endheader{% + % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. + \dosubind{fn}{\code{#3}}{#1}% + \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% +} + +%%% Typed functions: + +% @deftypefn category type name args +\makedefun{deftypefn}{\deftypefngeneral{}} + +% @deftypeop category class type name args +\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} + +% \deftypeopon {category on}class type name args +\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } + +% \deftypefngeneral {subind}category type name args +% +\def\deftypefngeneral#1#2 #3 #4 #5\endheader{% + \dosubind{fn}{\code{#4}}{#1}% + \defname{#2}{#3}{#4}\defunargs{#5\unskip}% +} + +%%% Typed variables: + +% @deftypevr category type var args +\makedefun{deftypevr}{\deftypecvgeneral{}} + +% @deftypecv category class type var args +\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} + +% \deftypecvof {category of}class type var args +\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } + +% \deftypecvgeneral {subind}category type var args +% +\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% + \dosubind{vr}{\code{#4}}{#1}% + \defname{#2}{#3}{#4}\defunargs{#5\unskip}% +} + +%%% Untyped variables: + +% @defvr category var args +\makedefun{defvr}#1 {\deftypevrheader{#1} {} } + +% @defcv category class var args +\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} + +% \defcvof {category of}class var args +\def\defcvof#1#2 {\deftypecvof{#1}#2 {} } + +%%% Type: +% @deftp category name args +\makedefun{deftp}#1 #2 #3\endheader{% + \doind{tp}{\code{#2}}% + \defname{#1}{}{#2}\defunargs{#3\unskip}% +} + +% Remaining @defun-like shortcuts: +\makedefun{defun}{\deffnheader{\putwordDeffunc} } +\makedefun{defmac}{\deffnheader{\putwordDefmac} } +\makedefun{defspec}{\deffnheader{\putwordDefspec} } +\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } +\makedefun{defvar}{\defvrheader{\putwordDefvar} } +\makedefun{defopt}{\defvrheader{\putwordDefopt} } +\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } +\makedefun{defmethod}{\defopon\putwordMethodon} +\makedefun{deftypemethod}{\deftypeopon\putwordMethodon} +\makedefun{defivar}{\defcvof\putwordInstanceVariableof} +\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} + +% \defname, which formats the name of the @def (not the args). +% #1 is the category, such as "Function". +% #2 is the return type, if any. +% #3 is the function name. +% +% We are followed by (but not passed) the arguments, if any. +% +\def\defname#1#2#3{% + % 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 + % 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. + % 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 + % 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. + \noindent + \hbox to 0pt{% + \hfil\box0 \kern-\hsize + % \hsize has to be shortened this way: + \kern\leftskip + % Intentionally do not respect \rightskip, since we need the space. + }% + % + % Allow all lines to be underfull without complaint: + \tolerance=10000 \hbadness=10000 + \exdentamount=\defbodyindent + {% + % defun fonts. We use typewriter by default (used to be bold) because: + % . we're printing identifiers, they should be in tt in principle. + % . in languages with many accents, such as Czech or French, it's + % common to leave accents off identifiers. The result looks ok in + % tt, but exceedingly strange in rm. + % . we don't want -- and --- to be treated as ligatures. + % . 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 + #3% output function name + }% + {\rm\enskip}% hskip 0.5 em of \tenrm + % + \boldbrax + % arguments will be output next, if any. +} + +% Print arguments in slanted roman (not ttsl), inconsistently with using +% tt for the name. This is because literal text is sometimes needed in +% the argument list (groff manual), and ttsl and tt are not very +% distinguishable. Prevent hyphenation at `-' chars. +% +\def\defunargs#1{% + % use sl by default (not ttsl), + % tt for the names. + \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. + \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}% + #1% + \sl\hyphenchar\font=45 +} + +% We want ()&[] to print specially on the defun line. +% +\def\activeparens{% + \catcode`\(=\active \catcode`\)=\active + \catcode`\[=\active \catcode`\]=\active + \catcode`\&=\active +} + +% Make control sequences which act like normal parenthesis chars. +\let\lparen = ( \let\rparen = ) + +% Be sure that we always have a definition for `(', etc. For example, +% if the fn name has parens in it, \boldbrax will not be in effect yet, +% so TeX would otherwise complain about undefined control sequence. +{ + \activeparens + \global\let(=\lparen \global\let)=\rparen + \global\let[=\lbrack \global\let]=\rbrack + \global\let& = \& + + \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} + \gdef\magicamp{\let&=\amprm} +} + +\newcount\parencount + +% If we encounter &foo, then turn on ()-hacking afterwards +\newif\ifampseen +\def\amprm#1 {\ampseentrue{\bf\ }} + +\def\parenfont{% + \ifampseen + % At the first level, print parens in roman, + % otherwise use the default font. + \ifnum \parencount=1 \rm \fi + \else + % The \sf parens (in \boldbrax) actually are a little bolder than + % the contained text. This is especially needed for [ and ] . + \sf + \fi +} +\def\infirstlevel#1{% + \ifampseen + \ifnum\parencount=1 + #1% + \fi + \fi +} +\def\bfafterword#1 {#1 \bf} + +\def\opnr{% + \global\advance\parencount by 1 + {\parenfont(}% + \infirstlevel \bfafterword +} +\def\clnr{% + {\parenfont)}% + \infirstlevel \sl + \global\advance\parencount by -1 +} + +\newcount\brackcount +\def\lbrb{% + \global\advance\brackcount by 1 + {\bf[}% +} +\def\rbrb{% + {\bf]}% + \global\advance\brackcount by -1 +} + +\def\checkparencounts{% + \ifnum\parencount=0 \else \badparencount \fi + \ifnum\brackcount=0 \else \badbrackcount \fi +} +% these should not use \errmessage; the glibc manual, at least, actually +% has such constructs (when documenting function pointers). +\def\badparencount{% + \message{Warning: unbalanced parentheses in @def...}% + \global\parencount=0 +} +\def\badbrackcount{% + \message{Warning: unbalanced square brackets in @def...}% + \global\brackcount=0 +} + + +\message{macros,} +% @macro. + +% 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 + \newwrite\macscribble + \def\scantokens#1{% + \toks0={#1}% + \immediate\openout\macscribble=\jobname.tmp + \immediate\write\macscribble{\the\toks0}% + \immediate\closeout\macscribble + \input \jobname.tmp + } +\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\scanexp#1{% + \edef\temp{\noexpand\scanmacro{#1}}% + \temp +} + +\newcount\paramno % Count of parameters +\newtoks\macname % Macro name +\newif\ifrecursive % Is it recursive? + +% List of all defined macros in the form +% \definedummyword\macro1\definedummyword\macro2... +% Currently is also contains all @aliases; the list can be split +% if there is a need. +\def\macrolist{} + +% Add the macro to \macrolist +\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname} +\def\addtomacrolistxxx#1{% + \toks0 = \expandafter{\macrolist\definedummyword#1}% + \xdef\macrolist{\the\toks0}% +} + +% Utility routines. +% This does \let #1 = #2, with \csnames; that is, +% \let \csname#1\endcsname = \csname#2\endcsname +% (except of course we have to play expansion games). +% +\def\cslet#1#2{% + \expandafter\let + \csname#1\expandafter\endcsname + \csname#2\endcsname +} + +% Trim leading and trailing spaces off a string. +% Concepts from aro-bend problem 15 (see CTAN). +{\catcode`\@=11 +\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} +\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} +\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} +\def\unbrace#1{#1} +\unbrace{\gdef\trim@@@ #1 } #2@{#1} +} + +% Trim a single trailing ^^M off a string. +{\catcode`\^^M=\other \catcode`\Q=3% +\gdef\eatcr #1{\eatcra #1Q^^MQ}% +\gdef\eatcra#1^^MQ{\eatcrb#1Q}% +\gdef\eatcrb#1Q#2Q{#1}% +} + +% 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 \. + +% 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 +% body, and then making it the \newlinechar in \scanmacro. + +\def\scanctxt{% + \catcode`\"=\other + \catcode`\+=\other + \catcode`\<=\other + \catcode`\>=\other + \catcode`\@=\other + \catcode`\^=\other + \catcode`\_=\other + \catcode`\|=\other + \catcode`\~=\other + \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi +} + +\def\scanargctxt{% + \scanctxt + \catcode`\\=\other + \catcode`\^^M=\other +} + +\def\macrobodyctxt{% + \scanctxt + \catcode`\{=\other + \catcode`\}=\other + \catcode`\^^M=\other + \usembodybackslash +} + +\def\macroargctxt{% + \scanctxt + \catcode`\\=\other +} + +% \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\macro{\recursivefalse\parsearg\macroxxx} +\def\rmacro{\recursivetrue\parsearg\macroxxx} + +\def\macroxxx#1{% + \getargs{#1}% now \macname is the macname and \argl the arglist + \ifx\argl\empty % no arguments + \paramno=0% + \else + \expandafter\parsemargdef \argl;% + \fi + \if1\csname ismacro.\the\macname\endcsname + \message{Warning: redefining \the\macname}% + \else + \expandafter\ifx\csname \the\macname\endcsname \relax + \else \errmessage{Macro name \the\macname\space already defined}\fi + \global\cslet{macsave.\the\macname}{\the\macname}% + \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% + \addtomacrolist{\the\macname}% + \fi + \begingroup \macrobodyctxt + \ifrecursive \expandafter\parsermacbody + \else \expandafter\parsemacbody + \fi} + +\parseargdef\unmacro{% + \if1\csname ismacro.#1\endcsname + \global\cslet{#1}{macsave.#1}% + \global\expandafter\let \csname ismacro.#1\endcsname=0% + % Remove the macro name from \macrolist: + \begingroup + \expandafter\let\csname#1\endcsname \relax + \let\definedummyword\unmacrodo + \xdef\macrolist{\macrolist}% + \endgroup + \else + \errmessage{Macro #1 not defined}% + \fi +} + +% Called by \do from \dounmacro on each macro. The idea is to omit any +% macro definitions that have been changed to \relax. +% +\def\unmacrodo#1{% + \ifx #1\relax + % remove this + \else + \noexpand\definedummyword \noexpand#1% + \fi +} + +% This makes use of the obscure feature that if the last token of a +% <parameter list> is #, then the preceding argument is delimited by +% 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\getmacargs#1{\def\argl{#1}} + +% 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. +% 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 +% 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,;,} +\def\parsemargdefxxx#1,{% + \if#1;\let\next=\relax + \else \let\next=\parsemargdefxxx + \advance\paramno by 1% + \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname + {\xeatspaces{\hash\the\paramno}}% + \edef\paramlist{\paramlist\hash\the\paramno,}% + \fi\next} + +% These two commands read recursive and nonrecursive macro bodies. +% (They're different since rec and nonrec macros end differently.) + +\long\def\parsemacbody#1@end macro% +{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% +\long\def\parsermacbody#1@end rmacro% +{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% + +% This defines the macro itself. There are six cases: recursive and +% nonrecursive macros of zero, one, 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 + \ifcase\paramno + % 0 + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\scanmacro{\temp}}% + \or % 1 + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \noexpand\braceorline + \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}}% + \fi + \else + \ifcase\paramno + % 0 + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\norecurse{\the\macname}% + \noexpand\scanmacro{\temp}\egroup}% + \or % 1 + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \noexpand\braceorline + \expandafter\noexpand\csname\the\macname xxx\endcsname}% + \expandafter\xdef\csname\the\macname xxx\endcsname##1{% + \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}% + \fi + \fi} + +\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) +\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} +\def\braceorlinexxx{% + \ifx\nchar\bgroup\else + \expandafter\parsearg + \fi \macnamexxx} + + +% @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. +\def\alias{\parseargusing\obeyspaces\aliasxxx} +\def\aliasxxx #1{\aliasyyy#1\relax} +\def\aliasyyy #1=#2\relax{% + {% + \expandafter\let\obeyedspace=\empty + \addtomacrolist{#1}% + \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% + }% + \next +} + + +\message{cross references,} + +\newwrite\auxfile +\newif\ifhavexrefs % True if xref values are known. +\newif\ifwarnedxrefs % True if we warned once that they aren't known. + +% @inforef is relatively simple. +\def\inforef #1{\inforefzzz #1,,,,**} +\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 +% cross-references. The @node line might or might not have commas, and +% might or might not have spaces before the first comma, like: +% @node foo , bar , ... +% We don't want such trailing spaces in the node name. +% +\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse} +% +% also remove a trailing comma, in case of something like this: +% @node Help-Cross, , , Cross-refs +\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse} +\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}} + +\let\nwnode=\node +\let\lastnode=\empty + +% Write a cross-reference definition for the current node. #1 is the +% type (Ynumbered, Yappendix, Ynothing). +% +\def\donoderef#1{% + \ifx\lastnode\empty\else + \setref{\lastnode}{#1}% + \global\let\lastnode=\empty + \fi +} + +% @anchor{NAME} -- define xref target at arbitrary point. +% +\newcount\savesfregister +% +\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} +\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} +\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} + +% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an +% anchor), which consists of three parts: +% 1) NAME-title - the current sectioning name taken from \lastsection, +% or the anchor name. +% 2) NAME-snt - section number and type, passed as the SNT arg, or +% empty for anchors. +% 3) NAME-pg - the page number. +% +% This is called from \donoderef, \anchor, and \dofloat. In the case of +% floats, there is an additional part, which is not written here: +% 4) NAME-lof - the text as it should appear in a @listoffloats. +% +\def\setref#1#2{% + \pdfmkdest{#1}% + \iflinks + {% + \atdummies % preserve commands, but don't expand them + \edef\writexrdef##1##2{% + \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef + ##1}{##2}}% these are parameters of \writexrdef + }% + \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 + }% + \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 +% manual. All but the node name can be omitted. +% +\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} +\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} +\def\ref#1{\xrefX[#1,,,,,,,]} +\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup + \unsepspaces + \def\printedmanual{\ignorespaces #5}% + \def\printedrefname{\ignorespaces #3}% + \setbox1=\hbox{\printedmanual\unskip}% + \setbox0=\hbox{\printedrefname\unskip}% + \ifdim \wd0 = 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. + \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. + \def\printedrefname{\ignorespaces #1}% + \else + \ifhavexrefs + % We know the real title if we have the xref values. + \def\printedrefname{\refx{#1-title}{}}% + \else + % Otherwise just copy the Info node name. + \def\printedrefname{\ignorespaces #1}% + \fi% + \fi + \fi + \fi + % + % Make link in pdf output. + \ifpdf + {\indexnofonts + \turnoffactive + % This expands tokens, so do it after making catcode changes, so _ + % etc. don't get their TeX definitions. + \getfilename{#4}% + % + % See comments at \activebackslashdouble. + {\activebackslashdouble \xdef\pdfxrefdest{#1}% + \backslashparens\pdfxrefdest}% + % + \leavevmode + \startlink attr{/Border [0 0 0]}% + \ifnum\filenamelength>0 + goto file{\the\filename.pdf} name{\pdfxrefdest}% + \else + goto name{\pdfmkpgn{\pdfxrefdest}}% + \fi + }% + \setcolor{\linkcolor}% + \fi + % + % Float references are printed completely differently: "Figure 1.2" + % instead of "[somenode], p.3". We distinguish them by the + % LABEL-title being set to a magic string. + {% + % Have to otherify everything special to allow the \csname to + % include an _ in the xref name, etc. + \indexnofonts + \turnoffactive + \expandafter\global\expandafter\let\expandafter\Xthisreftitle + \csname XR#1-title\endcsname + }% + \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 + \refx{#1-snt}{}% + \else + \printedrefname + \fi + % + % if the user also gave the printed manual name (fifth arg), append + % "in MANUALNAME". + \ifdim \wd1 > 0pt + \space \putwordin{} \cite{\printedmanual}% + \fi + \else + % node/anchor (non-float) references. + % + % 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 + % _ (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 + % printing. So we \turnoffactive for the \refx-snt, back on for the + % printing, back off for the \refx-pg. + {\turnoffactive + % Only output a following space if the -snt ref is nonempty; for + % @unnumbered and @anchor, it won't be. + \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. + \xrefprintnodename\printedrefname + % + % But we always want a comma and a space: + ,\space + % + % output the `page 3'. + \turnoffactive \putwordpage\tie\refx{#1-pg}{}% + \fi + \fi + \endlink +\endgroup} + +% 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 +% one that Bob is working on :). +% +\def\xrefprintnodename#1{[#1]} + +% Things referred to by \setref. +% +\def\Ynothing{} +\def\Yomitfromtoc{} +\def\Ynumbered{% + \ifnum\secno=0 + \putwordChapter@tie \the\chapno + \else \ifnum\subsecno=0 + \putwordSection@tie \the\chapno.\the\secno + \else \ifnum\subsubsecno=0 + \putwordSection@tie \the\chapno.\the\secno.\the\subsecno + \else + \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno + \fi\fi\fi +} +\def\Yappendix{% + \ifnum\secno=0 + \putwordAppendix@tie @char\the\appendixno{}% + \else \ifnum\subsecno=0 + \putwordSection@tie @char\the\appendixno.\the\secno + \else \ifnum\subsubsecno=0 + \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno + \else + \putwordSection@tie + @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno + \fi\fi\fi +} + +% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. +% If its value is nonempty, SUFFIX is output afterward. +% +\def\refx#1#2{% + {% + \indexnofonts + \otherbackslash + \expandafter\global\expandafter\let\expandafter\thisrefX + \csname XR#1\endcsname + }% + \ifx\thisrefX\relax + % If not defined, say something at least. + \angleleft un\-de\-fined\angleright + \iflinks + \ifhavexrefs + \message{\linenumber Undefined cross reference `#1'.}% + \else + \ifwarnedxrefs\else + \global\warnedxrefstrue + \message{Cross reference values unknown; you must run TeX again.}% + \fi + \fi + \fi + \else + % It's defined, so just use it. + \thisrefX + \fi + #2% Output the suffix in any case. +} + +% This is the macro invoked by entries in the aux file. Usually it's +% just a \def (we prepend XR to the control sequence name to avoid +% collisions). But if this is a float type, we have more work to do. +% +\def\xrdef#1#2{% + {% The node name might contain 8-bit characters, which in our current + % implementation are changed to commands like @'e. Don't let these + % mess up the control sequence name. + \indexnofonts + \turnoffactive + \xdef\safexrefname{#1}% + }% + % + \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref + % + % Was that xref control sequence that we just defined for a float? + \expandafter\iffloat\csname XR\safexrefname\endcsname + % it was a float, and we have the (safe) float type in \iffloattype. + \expandafter\let\expandafter\floatlist + \csname floatlist\iffloattype\endcsname + % + % Is this the first time we've seen this float type? + \expandafter\ifx\floatlist\relax + \toks0 = {\do}% yes, so just \do + \else + % had it before, so preserve previous elements in list. + \toks0 = \expandafter{\floatlist\do}% + \fi + % + % Remember this xref in the control sequence \floatlistFLOATTYPE, + % for later use in \listoffloats. + \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0 + {\safexrefname}}% + \fi +} + +% Read the last existing aux file, if any. No error if none exists. +% +\def\tryauxfile{% + \openin 1 \jobname.aux + \ifeof 1 \else + \readdatafile{aux}% + \global\havexrefstrue + \fi + \closein 1 +} + +\def\setupdatafile{% + \catcode`\^^@=\other + \catcode`\^^A=\other + \catcode`\^^B=\other + \catcode`\^^C=\other + \catcode`\^^D=\other + \catcode`\^^E=\other + \catcode`\^^F=\other + \catcode`\^^G=\other + \catcode`\^^H=\other + \catcode`\^^K=\other + \catcode`\^^L=\other + \catcode`\^^N=\other + \catcode`\^^P=\other + \catcode`\^^Q=\other + \catcode`\^^R=\other + \catcode`\^^S=\other + \catcode`\^^T=\other + \catcode`\^^U=\other + \catcode`\^^V=\other + \catcode`\^^W=\other + \catcode`\^^X=\other + \catcode`\^^Z=\other + \catcode`\^^[=\other + \catcode`\^^\=\other + \catcode`\^^]=\other + \catcode`\^^^=\other + \catcode`\^^_=\other + % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. + % in xref tags, i.e., node names. But since ^^e4 notation isn't + % supported in the main text, it doesn't seem desirable. Furthermore, + % that is not enough: for node names that actually contain a ^ + % character, we would end up writing a line like this: 'xrdef {'hat + % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first + % argument, and \hat is not an expandable control sequence. It could + % all be worked out, but why? Either we support ^^ or we don't. + % + % The other change necessary for this was to define \auxhat: + % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter + % and then to call \auxhat in \setq. + % + \catcode`\^=\other + % + % Special characters. Should be turned off anyway, but... + \catcode`\~=\other + \catcode`\[=\other + \catcode`\]=\other + \catcode`\"=\other + \catcode`\_=\other + \catcode`\|=\other + \catcode`\<=\other + \catcode`\>=\other + \catcode`\$=\other + \catcode`\#=\other + \catcode`\&=\other + \catcode`\%=\other + \catcode`+=\other % avoid \+ for paranoia even though we've turned it off + % + % This is to support \ in node names and titles, since the \ + % characters end up in a \csname. It's easier than + % leaving it active and making its active definition an actual \ + % character. What I don't understand is why it works in the *value* + % of the xrdef. Seems like it should be a catcode12 \, and that + % should not typeset properly. But it works, so I'm moving on for + % now. --karl, 15jan04. + \catcode`\\=\other + % + % Make the characters 128-255 be printing characters. + {% + \count1=128 + \def\loop{% + \catcode\count1=\other + \advance\count1 by 1 + \ifnum \count1<256 \loop \fi + }% + }% + % + % @ is our escape character in .aux files, and we need braces. + \catcode`\{=1 + \catcode`\}=2 + \catcode`\@=0 +} + +\def\readdatafile#1{% +\begingroup + \setupdatafile + \input\jobname.#1 +\endgroup} + + +\message{insertions,} +% including footnotes. + +\newcount \footnoteno + +% The trailing space in the following definition for supereject is +% vital for proper filling; pages come out unaligned when you do a +% pagealignmacro call if that space before the closing brace is +% removed. (Generally, numeric constants should always be followed by a +% space to prevent strange expansion errors.) +\def\supereject{\par\penalty -20000\footnoteno =0 } + +% @footnotestyle is meaningful for info output only. +\let\footnotestyle=\comment + +{\catcode `\@=11 +% +% Auto-number footnotes. Otherwise like plain. +\gdef\footnote{% + \let\indent=\ptexindent + \let\noindent=\ptexnoindent + \global\advance\footnoteno by \@ne + \edef\thisfootno{$^{\the\footnoteno}$}% + % + % In case the footnote comes at the end of a sentence, preserve the + % extra spacing after we do the footnote number. + \let\@sf\empty + \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi + % + % Remove inadvertent blank space before typesetting the footnote number. + \unskip + \thisfootno\@sf + \dofootnote +}% + +% Don't bother with the trickery in plain.tex to not require the +% footnote text as a parameter. Our footnotes don't need to be so general. +% +% Oh yes, they do; otherwise, @ifset (and anything else that uses +% \parseargline) fails inside footnotes because the tokens are fixed when +% the footnote is read. --karl, 16nov96. +% +\gdef\dofootnote{% + \insert\footins\bgroup + % We want to typeset this text as a normal paragraph, even if the + % footnote reference occurs in (for example) a display environment. + % So reset some parameters. + \hsize=\pagewidth + \interlinepenalty\interfootnotelinepenalty + \splittopskip\ht\strutbox % top baseline for broken footnotes + \splitmaxdepth\dp\strutbox + \floatingpenalty\@MM + \leftskip\z@skip + \rightskip\z@skip + \spaceskip\z@skip + \xspaceskip\z@skip + \parindent\defaultparindent + % + \smallfonts \rm + % + % Because we use hanging indentation in footnotes, a @noindent appears + % to exdent this text, so make it be a no-op. makeinfo does not use + % hanging indentation so @noindent can still be needed within footnote + % text after an @example or the like (not that this is good style). + \let\noindent = \relax + % + % Hang the footnote text off the number. Use \everypar in case the + % footnote extends for more than one paragraph. + \everypar = {\hang}% + \textindent{\thisfootno}% + % + % Don't crash into the line above the footnote text. Since this + % expands into a box, it must come within the paragraph, lest it + % provide a place where TeX can split the footnote. + \footstrut + \futurelet\next\fo@t +} +}%end \catcode `\@=11 + +% In case a @footnote appears in a vbox, save the footnote text and create +% the real \insert just after the vbox finished. Otherwise, the insertion +% would be lost. +% Similarly, if a @footnote appears inside an alignment, save the footnote +% text to a box and make the \insert when a row of the table is finished. +% And the same can be done for other insert classes. --kasal, 16nov03. + +% Replace the \insert primitive by a cheating macro. +% Deeper inside, just make sure that the saved insertions are not spilled +% out prematurely. +% +\def\startsavinginserts{% + \ifx \insert\ptexinsert + \let\insert\saveinsert + \else + \let\checkinserts\relax + \fi +} + +% This \insert replacement works for both \insert\footins{foo} and +% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. +% +\def\saveinsert#1{% + \edef\next{\noexpand\savetobox \makeSAVEname#1}% + \afterassignment\next + % swallow the left brace + \let\temp = +} +\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} +\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} + +\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} + +\def\placesaveins#1{% + \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname + {\box#1}% +} + +% eat @SAVE -- beware, all of them have catcode \other: +{ + \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) + \gdef\gobblesave @SAVE{} +} + +% initialization: +\def\newsaveins #1{% + \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% + \next +} +\def\newsaveinsX #1{% + \csname newbox\endcsname #1% + \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts + \checksaveins #1}% +} + +% initialize: +\let\checkinserts\empty +\newsaveins\footins +\newsaveins\margin + + +% @image. We use the macros from epsf.tex to support this. +% If epsf.tex is not installed and @image is used, we complain. +% +% Check for and read epsf.tex up front. If we read it only at @image +% time, we might be inside a group, and then its definitions would get +% undone and the next image would fail. +\openin 1 = epsf.tex +\ifeof 1 \else + % Do not bother showing banner with epsf.tex v2.7k (available in + % doc/epsf.tex and on ctan). + \def\epsfannounce{\toks0 = }% + \input epsf.tex +\fi +\closein 1 +% +% We will only complain once about lack of epsf.tex. +\newif\ifwarnednoepsf +\newhelp\noepsfhelp{epsf.tex must be installed for images to + work. It is also included in the Texinfo distribution, or you can get + it from ftp://tug.org/tex/epsf.tex.} +% +\def\image#1{% + \ifx\epsfbox\undefined + \ifwarnednoepsf \else + \errhelp = \noepsfhelp + \errmessage{epsf.tex not found, images will be ignored}% + \global\warnednoepsftrue + \fi + \else + \imagexxx #1,,,,,\finish + \fi +} +% +% Arguments to @image: +% #1 is (mandatory) image filename; we tack on .eps extension. +% #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. +\newif\ifimagevmode +\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup + \catcode`\^^M = 5 % in case we're inside an example + \normalturnoffactive % allow _ et al. in names + % If the image is by itself, center it. + \ifvmode + \imagevmodetrue + \nobreak\medskip + % Usually we'll have text after the image which will insert + % \parskip glue, so insert it here too to equalize the space + % above and below. + \nobreak\vskip\parskip + \nobreak + \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 + % + % Output the image. + \ifpdf + \dopdfimage{#1}{#2}{#3}% + \else + % \epsfbox itself resets \epsf?size at each figure. + \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi + \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi + \epsfbox{#1.eps}% + \fi + % + \ifimagevmode \medskip \fi % space after the standalone image +\endgroup} + + +% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables, +% etc. We don't actually implement floating yet, we always include the +% float "here". But it seemed the best name for the future. +% +\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish} + +% There may be a space before second and/or third parameter; delete it. +\def\eatcommaspace#1, {#1,} + +% #1 is the optional FLOATTYPE, the text label for this float, typically +% "Figure", "Table", "Example", etc. Can't contain commas. If omitted, +% this float will not be numbered and cannot be referred to. +% +% #2 is the optional xref label. Also must be present for the float to +% be referable. +% +% #3 is the optional positioning argument; for now, it is ignored. It +% will somehow specify the positions allowed to float to (here, top, bottom). +% +% We keep a separate counter for each FLOATTYPE, which we reset at each +% chapter-level command. +\let\resetallfloatnos=\empty +% +\def\dofloat#1,#2,#3,#4\finish{% + \let\thiscaption=\empty + \let\thisshortcaption=\empty + % + % don't lose footnotes inside @float. + % + % BEWARE: when the floats start float, we have to issue warning whenever an + % insert appears inside a float which could possibly float. --kasal, 26may04 + % + \startsavinginserts + % + % We can't be used inside a paragraph. + \par + % + \vtop\bgroup + \def\floattype{#1}% + \def\floatlabel{#2}% + \def\floatloc{#3}% we do nothing with this yet. + % + \ifx\floattype\empty + \let\safefloattype=\empty + \else + {% + % the floattype might have accents or other special characters, + % but we need to use it in a control sequence name. + \indexnofonts + \turnoffactive + \xdef\safefloattype{\floattype}% + }% + \fi + % + % If label is given but no type, we handle that as the empty type. + \ifx\floatlabel\empty \else + % We want each FLOATTYPE to be numbered separately (Figure 1, + % Table 1, Figure 2, ...). (And if no label, no number.) + % + \expandafter\getfloatno\csname\safefloattype floatno\endcsname + \global\advance\floatno by 1 + % + {% + % This magic value for \lastsection is output by \setref as the + % XREFLABEL-title value. \xrefX uses it to distinguish float + % labels (which have a completely different output format) from + % node and anchor labels. And \xrdef uses it to construct the + % lists of floats. + % + \edef\lastsection{\floatmagic=\safefloattype}% + \setref{\floatlabel}{Yfloat}% + }% + \fi + % + % start with \parskip glue, I guess. + \vskip\parskip + % + % Don't suppress indentation if a float happens to start a section. + \restorefirstparagraphindent +} + +% we have these possibilities: +% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap +% @float Foo,lbl & no caption: Foo 1.1 +% @float Foo & @caption{Cap}: Foo: Cap +% @float Foo & no caption: Foo +% @float ,lbl & Caption{Cap}: 1.1: Cap +% @float ,lbl & no caption: 1.1 +% @float & @caption{Cap}: Cap +% @float & no caption: +% +\def\Efloat{% + \let\floatident = \empty + % + % In all cases, if we have a float type, it comes first. + \ifx\floattype\empty \else \def\floatident{\floattype}\fi + % + % If we have an xref label, the number comes next. + \ifx\floatlabel\empty \else + \ifx\floattype\empty \else % if also had float type, need tie first. + \appendtomacro\floatident{\tie}% + \fi + % the number. + \appendtomacro\floatident{\chaplevelprefix\the\floatno}% + \fi + % + % Start the printed caption with what we've constructed in + % \floatident, but keep it separate; we need \floatident again. + \let\captionline = \floatident + % + \ifx\thiscaption\empty \else + \ifx\floatident\empty \else + \appendtomacro\captionline{: }% had ident, so need a colon between + \fi + % + % caption text. + \appendtomacro\captionline{\scanexp\thiscaption}% + \fi + % + % If we have anything to print, print it, with space before. + % Eventually this needs to become an \insert. + \ifx\captionline\empty \else + \vskip.5\parskip + \captionline + % + % Space below caption. + \vskip\parskip + \fi + % + % If have an xref label, write the list of floats info. Do this + % after the caption, to avoid chance of it being a breakpoint. + \ifx\floatlabel\empty \else + % Write the text that goes in the lof to the aux file as + % \floatlabel-lof. Besides \floatident, we include the short + % caption if specified, else the full caption if specified, else nothing. + {% + \atdummies + % + % since we read the caption text in the macro world, where ^^M + % is turned into a normal character, we have to scan it back, so + % we don't write the literal three characters "^^M" into the aux file. + \scanexp{% + \xdef\noexpand\gtemp{% + \ifx\thisshortcaption\empty + \thiscaption + \else + \thisshortcaption + \fi + }% + }% + \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident + \ifx\gtemp\empty \else : \gtemp \fi}}% + }% + \fi + \egroup % end of \vtop + % + % place the captured inserts + % + % BEWARE: when the floats start floating, we have to issue warning + % whenever an insert appears inside a float which could possibly + % float. --kasal, 26may04 + % + \checkinserts +} + +% Append the tokens #2 to the definition of macro #1, not expanding either. +% +\def\appendtomacro#1#2{% + \expandafter\def\expandafter#1\expandafter{#1#2}% +} + +% @caption, @shortcaption +% +\def\caption{\docaption\thiscaption} +\def\shortcaption{\docaption\thisshortcaption} +\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption} +\def\defcaption#1#2{\egroup \def#1{#2}} + +% The parameter is the control sequence identifying the counter we are +% going to use. Create it if it doesn't exist and assign it to \floatno. +\def\getfloatno#1{% + \ifx#1\relax + % Haven't seen this figure type before. + \csname newcount\endcsname #1% + % + % Remember to reset this floatno at the next chap. + \expandafter\gdef\expandafter\resetallfloatnos + \expandafter{\resetallfloatnos #1=0 }% + \fi + \let\floatno#1% +} + +% \setref calls this to get the XREFLABEL-snt value. We want an @xref +% to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we +% first read the @float command. +% +\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% + +% Magic string used for the XREFLABEL-title value, so \xrefX can +% distinguish floats from other xref types. +\def\floatmagic{!!float!!} + +% #1 is the control sequence we are passed; we expand into a conditional +% which is true if #1 represents a float ref. That is, the magic +% \lastsection value which we \setref above. +% +\def\iffloat#1{\expandafter\doiffloat#1==\finish} +% +% #1 is (maybe) the \floatmagic string. If so, #2 will be the +% (safe) float type for this float. We set \iffloattype to #2. +% +\def\doiffloat#1=#2=#3\finish{% + \def\temp{#1}% + \def\iffloattype{#2}% + \ifx\temp\floatmagic +} + +% @listoffloats FLOATTYPE - print a list of floats like a table of contents. +% +\parseargdef\listoffloats{% + \def\floattype{#1}% floattype + {% + % the floattype might have accents or other special characters, + % but we need to use it in a control sequence name. + \indexnofonts + \turnoffactive + \xdef\safefloattype{\floattype}% + }% + % + % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. + \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax + \ifhavexrefs + % if the user said @listoffloats foo but never @float foo. + \message{\linenumber No `\safefloattype' floats to list.}% + \fi + \else + \begingroup + \leftskip=\tocindent % indent these entries like a toc + \let\do=\listoffloatsdo + \csname floatlist\safefloattype\endcsname + \endgroup + \fi +} + +% This is called on each entry in a list of floats. We're passed the +% xref label, in the form LABEL-title, which is how we save it in the +% aux file. We strip off the -title and look up \XRLABEL-lof, which +% has the text we're supposed to typeset here. +% +% Figures without xref labels will not be included in the list (since +% they won't appear in the aux file). +% +\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} +\def\listoffloatsdoentry#1-title\finish{{% + % Can't fully expand XR#1-lof because it can contain anything. Just + % pass the control sequence. On the other hand, XR#1-pg is just the + % page number, and we want to fully expand that so we can get a link + % in pdf output. + \toksA = \expandafter{\csname XR#1-lof\endcsname}% + % + % use the same \entry macro we use to generate the TOC and index. + \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}% + \writeentry +}} + + +\message{localization,} + +% For single-language documents, @documentlanguage is usually given very +% early, just after @documentencoding. Single argument is the language +% (de) or locale (de_DE) abbreviation. +% +{ + \catcode`\_ = \active + \globaldefs=1 +\parseargdef\documentlanguage{\begingroup + \let_=\normalunderscore % normal _ character for filenames + \tex % read txi-??.tex file in plain TeX. + % Read the file by the name they passed if it exists. + \openin 1 txi-#1.tex + \ifeof 1 + \documentlanguagetrywithoutunderscore{#1_\finish}% + \else + \globaldefs = 1 % everything in the txi-LL files needs to persist + \input txi-#1.tex + \fi + \closein 1 + \endgroup % end raw TeX +\endgroup} +% +% If they passed de_DE, and txi-de_DE.tex doesn't exist, +% try txi-de.tex. +% +\gdef\documentlanguagetrywithoutunderscore#1_#2\finish{% + \openin 1 txi-#1.tex + \ifeof 1 + \errhelp = \nolanghelp + \errmessage{Cannot read language file txi-#1.tex}% + \else + \globaldefs = 1 % everything in the txi-LL files needs to persist + \input txi-#1.tex + \fi + \closein 1 +} +}% end of special _ catcode +% +\newhelp\nolanghelp{The given language definition file cannot be found or +is empty. Maybe you need to install it? Putting it in the current +directory should work if nowhere else does.} + +% This macro is called from txi-??.tex files; the first argument is the +% \language name to set (without the "\lang@" prefix), the second and +% third args are \{left,right}hyphenmin. +% +% The language names to pass are determined when the format is built. +% See the etex.log file created at that time, e.g., +% /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log. +% +% With TeX Live 2008, etex now includes hyphenation patterns for all +% available languages. This means we can support hyphenation in +% Texinfo, at least to some extent. (This still doesn't solve the +% accented characters problem.) +% +\catcode`@=11 +\def\txisetlanguage#1#2#3{% + % do not set the language if the name is undefined in the current TeX. + \expandafter\ifx\csname lang@#1\endcsname \relax + \message{no patterns for #1}% + \else + \global\language = \csname lang@#1\endcsname + \fi + % but there is no harm in adjusting the hyphenmin values regardless. + \global\lefthyphenmin = #2\relax + \global\righthyphenmin = #3\relax +} + +% Helpers for encodings. +% Set the catcode of characters 128 through 255 to the specified number. +% +\def\setnonasciicharscatcode#1{% + \count255=128 + \loop\ifnum\count255<256 + \global\catcode\count255=#1\relax + \advance\count255 by 1 + \repeat +} + +\def\setnonasciicharscatcodenonglobal#1{% + \count255=128 + \loop\ifnum\count255<256 + \catcode\count255=#1\relax + \advance\count255 by 1 + \repeat +} + +% @documentencoding sets the definition of non-ASCII characters +% according to the specified encoding. +% +\parseargdef\documentencoding{% + % Encoding being declared for the document. + \def\declaredencoding{\csname #1.enc\endcsname}% + % + % Supported encodings: names converted to tokens in order to be able + % to compare them with \ifx. + \def\ascii{\csname US-ASCII.enc\endcsname}% + \def\latnine{\csname ISO-8859-15.enc\endcsname}% + \def\latone{\csname ISO-8859-1.enc\endcsname}% + \def\lattwo{\csname ISO-8859-2.enc\endcsname}% + \def\utfeight{\csname UTF-8.enc\endcsname}% + % + \ifx \declaredencoding \ascii + \asciichardefs + % + \else \ifx \declaredencoding \lattwo + \setnonasciicharscatcode\active + \lattwochardefs + % + \else \ifx \declaredencoding \latone + \setnonasciicharscatcode\active + \latonechardefs + % + \else \ifx \declaredencoding \latnine + \setnonasciicharscatcode\active + \latninechardefs + % + \else \ifx \declaredencoding \utfeight + \setnonasciicharscatcode\active + \utfeightchardefs + % + \else + \message{Unknown document encoding #1, ignoring.}% + % + \fi % utfeight + \fi % latnine + \fi % latone + \fi % lattwo + \fi % ascii +} + +% A message to be logged when using a character that isn't available +% the default font encoding (OT1). +% +\def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}} + +% Take account of \c (plain) vs. \, (Texinfo) difference. +\def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi} + +% First, make active non-ASCII characters in order for them to be +% correctly categorized when TeX reads the replacement text of +% macros containing the character definitions. +\setnonasciicharscatcode\active +% +% Latin1 (ISO-8859-1) character definitions. +\def\latonechardefs{% + \gdef^^a0{~} + \gdef^^a1{\exclamdown} + \gdef^^a2{\missingcharmsg{CENT SIGN}} + \gdef^^a3{{\pounds}} + \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} + \gdef^^a5{\missingcharmsg{YEN SIGN}} + \gdef^^a6{\missingcharmsg{BROKEN BAR}} + \gdef^^a7{\S} + \gdef^^a8{\"{}} + \gdef^^a9{\copyright} + \gdef^^aa{\ordf} + \gdef^^ab{\guillemetleft} + \gdef^^ac{$\lnot$} + \gdef^^ad{\-} + \gdef^^ae{\registeredsymbol} + \gdef^^af{\={}} + % + \gdef^^b0{\textdegree} + \gdef^^b1{$\pm$} + \gdef^^b2{$^2$} + \gdef^^b3{$^3$} + \gdef^^b4{\'{}} + \gdef^^b5{$\mu$} + \gdef^^b6{\P} + % + \gdef^^b7{$^.$} + \gdef^^b8{\cedilla\ } + \gdef^^b9{$^1$} + \gdef^^ba{\ordm} + % + \gdef^^bb{\guilletright} + \gdef^^bc{$1\over4$} + \gdef^^bd{$1\over2$} + \gdef^^be{$3\over4$} + \gdef^^bf{\questiondown} + % + \gdef^^c0{\`A} + \gdef^^c1{\'A} + \gdef^^c2{\^A} + \gdef^^c3{\~A} + \gdef^^c4{\"A} + \gdef^^c5{\ringaccent A} + \gdef^^c6{\AE} + \gdef^^c7{\cedilla C} + \gdef^^c8{\`E} + \gdef^^c9{\'E} + \gdef^^ca{\^E} + \gdef^^cb{\"E} + \gdef^^cc{\`I} + \gdef^^cd{\'I} + \gdef^^ce{\^I} + \gdef^^cf{\"I} + % + \gdef^^d0{\DH} + \gdef^^d1{\~N} + \gdef^^d2{\`O} + \gdef^^d3{\'O} + \gdef^^d4{\^O} + \gdef^^d5{\~O} + \gdef^^d6{\"O} + \gdef^^d7{$\times$} + \gdef^^d8{\O} + \gdef^^d9{\`U} + \gdef^^da{\'U} + \gdef^^db{\^U} + \gdef^^dc{\"U} + \gdef^^dd{\'Y} + \gdef^^de{\TH} + \gdef^^df{\ss} + % + \gdef^^e0{\`a} + \gdef^^e1{\'a} + \gdef^^e2{\^a} + \gdef^^e3{\~a} + \gdef^^e4{\"a} + \gdef^^e5{\ringaccent a} + \gdef^^e6{\ae} + \gdef^^e7{\cedilla c} + \gdef^^e8{\`e} + \gdef^^e9{\'e} + \gdef^^ea{\^e} + \gdef^^eb{\"e} + \gdef^^ec{\`{\dotless i}} + \gdef^^ed{\'{\dotless i}} + \gdef^^ee{\^{\dotless i}} + \gdef^^ef{\"{\dotless i}} + % + \gdef^^f0{\dh} + \gdef^^f1{\~n} + \gdef^^f2{\`o} + \gdef^^f3{\'o} + \gdef^^f4{\^o} + \gdef^^f5{\~o} + \gdef^^f6{\"o} + \gdef^^f7{$\div$} + \gdef^^f8{\o} + \gdef^^f9{\`u} + \gdef^^fa{\'u} + \gdef^^fb{\^u} + \gdef^^fc{\"u} + \gdef^^fd{\'y} + \gdef^^fe{\th} + \gdef^^ff{\"y} +} + +% Latin9 (ISO-8859-15) encoding character definitions. +\def\latninechardefs{% + % Encoding is almost identical to Latin1. + \latonechardefs + % + \gdef^^a4{\euro} + \gdef^^a6{\v S} + \gdef^^a8{\v s} + \gdef^^b4{\v Z} + \gdef^^b8{\v z} + \gdef^^bc{\OE} + \gdef^^bd{\oe} + \gdef^^be{\"Y} +} + +% Latin2 (ISO-8859-2) character definitions. +\def\lattwochardefs{% + \gdef^^a0{~} + \gdef^^a1{\ogonek{A}} + \gdef^^a2{\u{}} + \gdef^^a3{\L} + \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} + \gdef^^a5{\v L} + \gdef^^a6{\'S} + \gdef^^a7{\S} + \gdef^^a8{\"{}} + \gdef^^a9{\v S} + \gdef^^aa{\cedilla S} + \gdef^^ab{\v T} + \gdef^^ac{\'Z} + \gdef^^ad{\-} + \gdef^^ae{\v Z} + \gdef^^af{\dotaccent Z} + % + \gdef^^b0{\textdegree} + \gdef^^b1{\ogonek{a}} + \gdef^^b2{\ogonek{ }} + \gdef^^b3{\l} + \gdef^^b4{\'{}} + \gdef^^b5{\v l} + \gdef^^b6{\'s} + \gdef^^b7{\v{}} + \gdef^^b8{\cedilla\ } + \gdef^^b9{\v s} + \gdef^^ba{\cedilla s} + \gdef^^bb{\v t} + \gdef^^bc{\'z} + \gdef^^bd{\H{}} + \gdef^^be{\v z} + \gdef^^bf{\dotaccent z} + % + \gdef^^c0{\'R} + \gdef^^c1{\'A} + \gdef^^c2{\^A} + \gdef^^c3{\u A} + \gdef^^c4{\"A} + \gdef^^c5{\'L} + \gdef^^c6{\'C} + \gdef^^c7{\cedilla C} + \gdef^^c8{\v C} + \gdef^^c9{\'E} + \gdef^^ca{\ogonek{E}} + \gdef^^cb{\"E} + \gdef^^cc{\v E} + \gdef^^cd{\'I} + \gdef^^ce{\^I} + \gdef^^cf{\v D} + % + \gdef^^d0{\DH} + \gdef^^d1{\'N} + \gdef^^d2{\v N} + \gdef^^d3{\'O} + \gdef^^d4{\^O} + \gdef^^d5{\H O} + \gdef^^d6{\"O} + \gdef^^d7{$\times$} + \gdef^^d8{\v R} + \gdef^^d9{\ringaccent U} + \gdef^^da{\'U} + \gdef^^db{\H U} + \gdef^^dc{\"U} + \gdef^^dd{\'Y} + \gdef^^de{\cedilla T} + \gdef^^df{\ss} + % + \gdef^^e0{\'r} + \gdef^^e1{\'a} + \gdef^^e2{\^a} + \gdef^^e3{\u a} + \gdef^^e4{\"a} + \gdef^^e5{\'l} + \gdef^^e6{\'c} + \gdef^^e7{\cedilla c} + \gdef^^e8{\v c} + \gdef^^e9{\'e} + \gdef^^ea{\ogonek{e}} + \gdef^^eb{\"e} + \gdef^^ec{\v e} + \gdef^^ed{\'\i} + \gdef^^ee{\^\i} + \gdef^^ef{\v d} + % + \gdef^^f0{\dh} + \gdef^^f1{\'n} + \gdef^^f2{\v n} + \gdef^^f3{\'o} + \gdef^^f4{\^o} + \gdef^^f5{\H o} + \gdef^^f6{\"o} + \gdef^^f7{$\div$} + \gdef^^f8{\v r} + \gdef^^f9{\ringaccent u} + \gdef^^fa{\'u} + \gdef^^fb{\H u} + \gdef^^fc{\"u} + \gdef^^fd{\'y} + \gdef^^fe{\cedilla t} + \gdef^^ff{\dotaccent{}} +} + +% UTF-8 character definitions. +% +% This code to support UTF-8 is based on LaTeX's utf8.def, with some +% changes for Texinfo conventions. It is included here under the GPL by +% permission from Frank Mittelbach and the LaTeX team. +% +\newcount\countUTFx +\newcount\countUTFy +\newcount\countUTFz + +\gdef\UTFviiiTwoOctets#1#2{\expandafter + \UTFviiiDefined\csname u8:#1\string #2\endcsname} +% +\gdef\UTFviiiThreeOctets#1#2#3{\expandafter + \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname} +% +\gdef\UTFviiiFourOctets#1#2#3#4{\expandafter + \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname} + +\gdef\UTFviiiDefined#1{% + \ifx #1\relax + \message{\linenumber Unicode char \string #1 not defined for Texinfo}% + \else + \expandafter #1% + \fi +} + +\begingroup + \catcode`\~13 + \catcode`\"12 + + \def\UTFviiiLoop{% + \global\catcode\countUTFx\active + \uccode`\~\countUTFx + \uppercase\expandafter{\UTFviiiTmp}% + \advance\countUTFx by 1 + \ifnum\countUTFx < \countUTFy + \expandafter\UTFviiiLoop + \fi} + + \countUTFx = "C2 + \countUTFy = "E0 + \def\UTFviiiTmp{% + \xdef~{\noexpand\UTFviiiTwoOctets\string~}} + \UTFviiiLoop + + \countUTFx = "E0 + \countUTFy = "F0 + \def\UTFviiiTmp{% + \xdef~{\noexpand\UTFviiiThreeOctets\string~}} + \UTFviiiLoop + + \countUTFx = "F0 + \countUTFy = "F4 + \def\UTFviiiTmp{% + \xdef~{\noexpand\UTFviiiFourOctets\string~}} + \UTFviiiLoop +\endgroup + +\begingroup + \catcode`\"=12 + \catcode`\<=12 + \catcode`\.=12 + \catcode`\,=12 + \catcode`\;=12 + \catcode`\!=12 + \catcode`\~=13 + + \gdef\DeclareUnicodeCharacter#1#2{% + \countUTFz = "#1\relax + \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% + \begingroup + \parseXMLCharref + \def\UTFviiiTwoOctets##1##2{% + \csname u8:##1\string ##2\endcsname}% + \def\UTFviiiThreeOctets##1##2##3{% + \csname u8:##1\string ##2\string ##3\endcsname}% + \def\UTFviiiFourOctets##1##2##3##4{% + \csname u8:##1\string ##2\string ##3\string ##4\endcsname}% + \expandafter\expandafter\expandafter\expandafter + \expandafter\expandafter\expandafter + \gdef\UTFviiiTmp{#2}% + \endgroup} + + \gdef\parseXMLCharref{% + \ifnum\countUTFz < "A0\relax + \errhelp = \EMsimple + \errmessage{Cannot define Unicode char value < 00A0}% + \else\ifnum\countUTFz < "800\relax + \parseUTFviiiA,% + \parseUTFviiiB C\UTFviiiTwoOctets.,% + \else\ifnum\countUTFz < "10000\relax + \parseUTFviiiA;% + \parseUTFviiiA,% + \parseUTFviiiB E\UTFviiiThreeOctets.{,;}% + \else + \parseUTFviiiA;% + \parseUTFviiiA,% + \parseUTFviiiA!% + \parseUTFviiiB F\UTFviiiFourOctets.{!,;}% + \fi\fi\fi + } + + \gdef\parseUTFviiiA#1{% + \countUTFx = \countUTFz + \divide\countUTFz by 64 + \countUTFy = \countUTFz + \multiply\countUTFz by 64 + \advance\countUTFx by -\countUTFz + \advance\countUTFx by 128 + \uccode `#1\countUTFx + \countUTFz = \countUTFy} + + \gdef\parseUTFviiiB#1#2#3#4{% + \advance\countUTFz by "#10\relax + \uccode `#3\countUTFz + \uppercase{\gdef\UTFviiiTmp{#2#3#4}}} +\endgroup + +\def\utfeightchardefs{% + \DeclareUnicodeCharacter{00A0}{\tie} + \DeclareUnicodeCharacter{00A1}{\exclamdown} + \DeclareUnicodeCharacter{00A3}{\pounds} + \DeclareUnicodeCharacter{00A8}{\"{ }} + \DeclareUnicodeCharacter{00A9}{\copyright} + \DeclareUnicodeCharacter{00AA}{\ordf} + \DeclareUnicodeCharacter{00AB}{\guillemetleft} + \DeclareUnicodeCharacter{00AD}{\-} + \DeclareUnicodeCharacter{00AE}{\registeredsymbol} + \DeclareUnicodeCharacter{00AF}{\={ }} + + \DeclareUnicodeCharacter{00B0}{\ringaccent{ }} + \DeclareUnicodeCharacter{00B4}{\'{ }} + \DeclareUnicodeCharacter{00B8}{\cedilla{ }} + \DeclareUnicodeCharacter{00BA}{\ordm} + \DeclareUnicodeCharacter{00BB}{\guillemetright} + \DeclareUnicodeCharacter{00BF}{\questiondown} + + \DeclareUnicodeCharacter{00C0}{\`A} + \DeclareUnicodeCharacter{00C1}{\'A} + \DeclareUnicodeCharacter{00C2}{\^A} + \DeclareUnicodeCharacter{00C3}{\~A} + \DeclareUnicodeCharacter{00C4}{\"A} + \DeclareUnicodeCharacter{00C5}{\AA} + \DeclareUnicodeCharacter{00C6}{\AE} + \DeclareUnicodeCharacter{00C7}{\cedilla{C}} + \DeclareUnicodeCharacter{00C8}{\`E} + \DeclareUnicodeCharacter{00C9}{\'E} + \DeclareUnicodeCharacter{00CA}{\^E} + \DeclareUnicodeCharacter{00CB}{\"E} + \DeclareUnicodeCharacter{00CC}{\`I} + \DeclareUnicodeCharacter{00CD}{\'I} + \DeclareUnicodeCharacter{00CE}{\^I} + \DeclareUnicodeCharacter{00CF}{\"I} + + \DeclareUnicodeCharacter{00D0}{\DH} + \DeclareUnicodeCharacter{00D1}{\~N} + \DeclareUnicodeCharacter{00D2}{\`O} + \DeclareUnicodeCharacter{00D3}{\'O} + \DeclareUnicodeCharacter{00D4}{\^O} + \DeclareUnicodeCharacter{00D5}{\~O} + \DeclareUnicodeCharacter{00D6}{\"O} + \DeclareUnicodeCharacter{00D8}{\O} + \DeclareUnicodeCharacter{00D9}{\`U} + \DeclareUnicodeCharacter{00DA}{\'U} + \DeclareUnicodeCharacter{00DB}{\^U} + \DeclareUnicodeCharacter{00DC}{\"U} + \DeclareUnicodeCharacter{00DD}{\'Y} + \DeclareUnicodeCharacter{00DE}{\TH} + \DeclareUnicodeCharacter{00DF}{\ss} + + \DeclareUnicodeCharacter{00E0}{\`a} + \DeclareUnicodeCharacter{00E1}{\'a} + \DeclareUnicodeCharacter{00E2}{\^a} + \DeclareUnicodeCharacter{00E3}{\~a} + \DeclareUnicodeCharacter{00E4}{\"a} + \DeclareUnicodeCharacter{00E5}{\aa} + \DeclareUnicodeCharacter{00E6}{\ae} + \DeclareUnicodeCharacter{00E7}{\cedilla{c}} + \DeclareUnicodeCharacter{00E8}{\`e} + \DeclareUnicodeCharacter{00E9}{\'e} + \DeclareUnicodeCharacter{00EA}{\^e} + \DeclareUnicodeCharacter{00EB}{\"e} + \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}} + \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}} + \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}} + \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}} + + \DeclareUnicodeCharacter{00F0}{\dh} + \DeclareUnicodeCharacter{00F1}{\~n} + \DeclareUnicodeCharacter{00F2}{\`o} + \DeclareUnicodeCharacter{00F3}{\'o} + \DeclareUnicodeCharacter{00F4}{\^o} + \DeclareUnicodeCharacter{00F5}{\~o} + \DeclareUnicodeCharacter{00F6}{\"o} + \DeclareUnicodeCharacter{00F8}{\o} + \DeclareUnicodeCharacter{00F9}{\`u} + \DeclareUnicodeCharacter{00FA}{\'u} + \DeclareUnicodeCharacter{00FB}{\^u} + \DeclareUnicodeCharacter{00FC}{\"u} + \DeclareUnicodeCharacter{00FD}{\'y} + \DeclareUnicodeCharacter{00FE}{\th} + \DeclareUnicodeCharacter{00FF}{\"y} + + \DeclareUnicodeCharacter{0100}{\=A} + \DeclareUnicodeCharacter{0101}{\=a} + \DeclareUnicodeCharacter{0102}{\u{A}} + \DeclareUnicodeCharacter{0103}{\u{a}} + \DeclareUnicodeCharacter{0104}{\ogonek{A}} + \DeclareUnicodeCharacter{0105}{\ogonek{a}} + \DeclareUnicodeCharacter{0106}{\'C} + \DeclareUnicodeCharacter{0107}{\'c} + \DeclareUnicodeCharacter{0108}{\^C} + \DeclareUnicodeCharacter{0109}{\^c} + \DeclareUnicodeCharacter{0118}{\ogonek{E}} + \DeclareUnicodeCharacter{0119}{\ogonek{e}} + \DeclareUnicodeCharacter{010A}{\dotaccent{C}} + \DeclareUnicodeCharacter{010B}{\dotaccent{c}} + \DeclareUnicodeCharacter{010C}{\v{C}} + \DeclareUnicodeCharacter{010D}{\v{c}} + \DeclareUnicodeCharacter{010E}{\v{D}} + + \DeclareUnicodeCharacter{0112}{\=E} + \DeclareUnicodeCharacter{0113}{\=e} + \DeclareUnicodeCharacter{0114}{\u{E}} + \DeclareUnicodeCharacter{0115}{\u{e}} + \DeclareUnicodeCharacter{0116}{\dotaccent{E}} + \DeclareUnicodeCharacter{0117}{\dotaccent{e}} + \DeclareUnicodeCharacter{011A}{\v{E}} + \DeclareUnicodeCharacter{011B}{\v{e}} + \DeclareUnicodeCharacter{011C}{\^G} + \DeclareUnicodeCharacter{011D}{\^g} + \DeclareUnicodeCharacter{011E}{\u{G}} + \DeclareUnicodeCharacter{011F}{\u{g}} + + \DeclareUnicodeCharacter{0120}{\dotaccent{G}} + \DeclareUnicodeCharacter{0121}{\dotaccent{g}} + \DeclareUnicodeCharacter{0124}{\^H} + \DeclareUnicodeCharacter{0125}{\^h} + \DeclareUnicodeCharacter{0128}{\~I} + \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}} + \DeclareUnicodeCharacter{012A}{\=I} + \DeclareUnicodeCharacter{012B}{\={\dotless{i}}} + \DeclareUnicodeCharacter{012C}{\u{I}} + \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}} + + \DeclareUnicodeCharacter{0130}{\dotaccent{I}} + \DeclareUnicodeCharacter{0131}{\dotless{i}} + \DeclareUnicodeCharacter{0132}{IJ} + \DeclareUnicodeCharacter{0133}{ij} + \DeclareUnicodeCharacter{0134}{\^J} + \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}} + \DeclareUnicodeCharacter{0139}{\'L} + \DeclareUnicodeCharacter{013A}{\'l} + + \DeclareUnicodeCharacter{0141}{\L} + \DeclareUnicodeCharacter{0142}{\l} + \DeclareUnicodeCharacter{0143}{\'N} + \DeclareUnicodeCharacter{0144}{\'n} + \DeclareUnicodeCharacter{0147}{\v{N}} + \DeclareUnicodeCharacter{0148}{\v{n}} + \DeclareUnicodeCharacter{014C}{\=O} + \DeclareUnicodeCharacter{014D}{\=o} + \DeclareUnicodeCharacter{014E}{\u{O}} + \DeclareUnicodeCharacter{014F}{\u{o}} + + \DeclareUnicodeCharacter{0150}{\H{O}} + \DeclareUnicodeCharacter{0151}{\H{o}} + \DeclareUnicodeCharacter{0152}{\OE} + \DeclareUnicodeCharacter{0153}{\oe} + \DeclareUnicodeCharacter{0154}{\'R} + \DeclareUnicodeCharacter{0155}{\'r} + \DeclareUnicodeCharacter{0158}{\v{R}} + \DeclareUnicodeCharacter{0159}{\v{r}} + \DeclareUnicodeCharacter{015A}{\'S} + \DeclareUnicodeCharacter{015B}{\'s} + \DeclareUnicodeCharacter{015C}{\^S} + \DeclareUnicodeCharacter{015D}{\^s} + \DeclareUnicodeCharacter{015E}{\cedilla{S}} + \DeclareUnicodeCharacter{015F}{\cedilla{s}} + + \DeclareUnicodeCharacter{0160}{\v{S}} + \DeclareUnicodeCharacter{0161}{\v{s}} + \DeclareUnicodeCharacter{0162}{\cedilla{t}} + \DeclareUnicodeCharacter{0163}{\cedilla{T}} + \DeclareUnicodeCharacter{0164}{\v{T}} + + \DeclareUnicodeCharacter{0168}{\~U} + \DeclareUnicodeCharacter{0169}{\~u} + \DeclareUnicodeCharacter{016A}{\=U} + \DeclareUnicodeCharacter{016B}{\=u} + \DeclareUnicodeCharacter{016C}{\u{U}} + \DeclareUnicodeCharacter{016D}{\u{u}} + \DeclareUnicodeCharacter{016E}{\ringaccent{U}} + \DeclareUnicodeCharacter{016F}{\ringaccent{u}} + + \DeclareUnicodeCharacter{0170}{\H{U}} + \DeclareUnicodeCharacter{0171}{\H{u}} + \DeclareUnicodeCharacter{0174}{\^W} + \DeclareUnicodeCharacter{0175}{\^w} + \DeclareUnicodeCharacter{0176}{\^Y} + \DeclareUnicodeCharacter{0177}{\^y} + \DeclareUnicodeCharacter{0178}{\"Y} + \DeclareUnicodeCharacter{0179}{\'Z} + \DeclareUnicodeCharacter{017A}{\'z} + \DeclareUnicodeCharacter{017B}{\dotaccent{Z}} + \DeclareUnicodeCharacter{017C}{\dotaccent{z}} + \DeclareUnicodeCharacter{017D}{\v{Z}} + \DeclareUnicodeCharacter{017E}{\v{z}} + + \DeclareUnicodeCharacter{01C4}{D\v{Z}} + \DeclareUnicodeCharacter{01C5}{D\v{z}} + \DeclareUnicodeCharacter{01C6}{d\v{z}} + \DeclareUnicodeCharacter{01C7}{LJ} + \DeclareUnicodeCharacter{01C8}{Lj} + \DeclareUnicodeCharacter{01C9}{lj} + \DeclareUnicodeCharacter{01CA}{NJ} + \DeclareUnicodeCharacter{01CB}{Nj} + \DeclareUnicodeCharacter{01CC}{nj} + \DeclareUnicodeCharacter{01CD}{\v{A}} + \DeclareUnicodeCharacter{01CE}{\v{a}} + \DeclareUnicodeCharacter{01CF}{\v{I}} + + \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}} + \DeclareUnicodeCharacter{01D1}{\v{O}} + \DeclareUnicodeCharacter{01D2}{\v{o}} + \DeclareUnicodeCharacter{01D3}{\v{U}} + \DeclareUnicodeCharacter{01D4}{\v{u}} + + \DeclareUnicodeCharacter{01E2}{\={\AE}} + \DeclareUnicodeCharacter{01E3}{\={\ae}} + \DeclareUnicodeCharacter{01E6}{\v{G}} + \DeclareUnicodeCharacter{01E7}{\v{g}} + \DeclareUnicodeCharacter{01E8}{\v{K}} + \DeclareUnicodeCharacter{01E9}{\v{k}} + + \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}} + \DeclareUnicodeCharacter{01F1}{DZ} + \DeclareUnicodeCharacter{01F2}{Dz} + \DeclareUnicodeCharacter{01F3}{dz} + \DeclareUnicodeCharacter{01F4}{\'G} + \DeclareUnicodeCharacter{01F5}{\'g} + \DeclareUnicodeCharacter{01F8}{\`N} + \DeclareUnicodeCharacter{01F9}{\`n} + \DeclareUnicodeCharacter{01FC}{\'{\AE}} + \DeclareUnicodeCharacter{01FD}{\'{\ae}} + \DeclareUnicodeCharacter{01FE}{\'{\O}} + \DeclareUnicodeCharacter{01FF}{\'{\o}} + + \DeclareUnicodeCharacter{021E}{\v{H}} + \DeclareUnicodeCharacter{021F}{\v{h}} + + \DeclareUnicodeCharacter{0226}{\dotaccent{A}} + \DeclareUnicodeCharacter{0227}{\dotaccent{a}} + \DeclareUnicodeCharacter{0228}{\cedilla{E}} + \DeclareUnicodeCharacter{0229}{\cedilla{e}} + \DeclareUnicodeCharacter{022E}{\dotaccent{O}} + \DeclareUnicodeCharacter{022F}{\dotaccent{o}} + + \DeclareUnicodeCharacter{0232}{\=Y} + \DeclareUnicodeCharacter{0233}{\=y} + \DeclareUnicodeCharacter{0237}{\dotless{j}} + + \DeclareUnicodeCharacter{02DB}{\ogonek{ }} + + \DeclareUnicodeCharacter{1E02}{\dotaccent{B}} + \DeclareUnicodeCharacter{1E03}{\dotaccent{b}} + \DeclareUnicodeCharacter{1E04}{\udotaccent{B}} + \DeclareUnicodeCharacter{1E05}{\udotaccent{b}} + \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}} + \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}} + \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}} + \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}} + \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}} + \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}} + \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}} + \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}} + + \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}} + \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}} + + \DeclareUnicodeCharacter{1E20}{\=G} + \DeclareUnicodeCharacter{1E21}{\=g} + \DeclareUnicodeCharacter{1E22}{\dotaccent{H}} + \DeclareUnicodeCharacter{1E23}{\dotaccent{h}} + \DeclareUnicodeCharacter{1E24}{\udotaccent{H}} + \DeclareUnicodeCharacter{1E25}{\udotaccent{h}} + \DeclareUnicodeCharacter{1E26}{\"H} + \DeclareUnicodeCharacter{1E27}{\"h} + + \DeclareUnicodeCharacter{1E30}{\'K} + \DeclareUnicodeCharacter{1E31}{\'k} + \DeclareUnicodeCharacter{1E32}{\udotaccent{K}} + \DeclareUnicodeCharacter{1E33}{\udotaccent{k}} + \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}} + \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}} + \DeclareUnicodeCharacter{1E36}{\udotaccent{L}} + \DeclareUnicodeCharacter{1E37}{\udotaccent{l}} + \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}} + \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}} + \DeclareUnicodeCharacter{1E3E}{\'M} + \DeclareUnicodeCharacter{1E3F}{\'m} + + \DeclareUnicodeCharacter{1E40}{\dotaccent{M}} + \DeclareUnicodeCharacter{1E41}{\dotaccent{m}} + \DeclareUnicodeCharacter{1E42}{\udotaccent{M}} + \DeclareUnicodeCharacter{1E43}{\udotaccent{m}} + \DeclareUnicodeCharacter{1E44}{\dotaccent{N}} + \DeclareUnicodeCharacter{1E45}{\dotaccent{n}} + \DeclareUnicodeCharacter{1E46}{\udotaccent{N}} + \DeclareUnicodeCharacter{1E47}{\udotaccent{n}} + \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}} + \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}} + + \DeclareUnicodeCharacter{1E54}{\'P} + \DeclareUnicodeCharacter{1E55}{\'p} + \DeclareUnicodeCharacter{1E56}{\dotaccent{P}} + \DeclareUnicodeCharacter{1E57}{\dotaccent{p}} + \DeclareUnicodeCharacter{1E58}{\dotaccent{R}} + \DeclareUnicodeCharacter{1E59}{\dotaccent{r}} + \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}} + \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}} + \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}} + \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}} + + \DeclareUnicodeCharacter{1E60}{\dotaccent{S}} + \DeclareUnicodeCharacter{1E61}{\dotaccent{s}} + \DeclareUnicodeCharacter{1E62}{\udotaccent{S}} + \DeclareUnicodeCharacter{1E63}{\udotaccent{s}} + \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}} + \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}} + \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}} + \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}} + \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}} + \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}} + + \DeclareUnicodeCharacter{1E7C}{\~V} + \DeclareUnicodeCharacter{1E7D}{\~v} + \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}} + \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}} + + \DeclareUnicodeCharacter{1E80}{\`W} + \DeclareUnicodeCharacter{1E81}{\`w} + \DeclareUnicodeCharacter{1E82}{\'W} + \DeclareUnicodeCharacter{1E83}{\'w} + \DeclareUnicodeCharacter{1E84}{\"W} + \DeclareUnicodeCharacter{1E85}{\"w} + \DeclareUnicodeCharacter{1E86}{\dotaccent{W}} + \DeclareUnicodeCharacter{1E87}{\dotaccent{w}} + \DeclareUnicodeCharacter{1E88}{\udotaccent{W}} + \DeclareUnicodeCharacter{1E89}{\udotaccent{w}} + \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}} + \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}} + \DeclareUnicodeCharacter{1E8C}{\"X} + \DeclareUnicodeCharacter{1E8D}{\"x} + \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}} + \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}} + + \DeclareUnicodeCharacter{1E90}{\^Z} + \DeclareUnicodeCharacter{1E91}{\^z} + \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}} + \DeclareUnicodeCharacter{1E93}{\udotaccent{z}} + \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}} + \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}} + \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}} + \DeclareUnicodeCharacter{1E97}{\"t} + \DeclareUnicodeCharacter{1E98}{\ringaccent{w}} + \DeclareUnicodeCharacter{1E99}{\ringaccent{y}} + + \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}} + \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}} + + \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}} + \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}} + \DeclareUnicodeCharacter{1EBC}{\~E} + \DeclareUnicodeCharacter{1EBD}{\~e} + + \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}} + \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}} + \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}} + \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}} + + \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}} + \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}} + + \DeclareUnicodeCharacter{1EF2}{\`Y} + \DeclareUnicodeCharacter{1EF3}{\`y} + \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}} + + \DeclareUnicodeCharacter{1EF8}{\~Y} + \DeclareUnicodeCharacter{1EF9}{\~y} + + \DeclareUnicodeCharacter{2013}{--} + \DeclareUnicodeCharacter{2014}{---} + \DeclareUnicodeCharacter{2018}{\quoteleft} + \DeclareUnicodeCharacter{2019}{\quoteright} + \DeclareUnicodeCharacter{201A}{\quotesinglbase} + \DeclareUnicodeCharacter{201C}{\quotedblleft} + \DeclareUnicodeCharacter{201D}{\quotedblright} + \DeclareUnicodeCharacter{201E}{\quotedblbase} + \DeclareUnicodeCharacter{2022}{\bullet} + \DeclareUnicodeCharacter{2026}{\dots} + \DeclareUnicodeCharacter{2039}{\guilsinglleft} + \DeclareUnicodeCharacter{203A}{\guilsinglright} + \DeclareUnicodeCharacter{20AC}{\euro} + + \DeclareUnicodeCharacter{2192}{\expansion} + \DeclareUnicodeCharacter{21D2}{\result} + + \DeclareUnicodeCharacter{2212}{\minus} + \DeclareUnicodeCharacter{2217}{\point} + \DeclareUnicodeCharacter{2261}{\equiv} +}% end of \utfeightchardefs + + +% US-ASCII character definitions. +\def\asciichardefs{% nothing need be done + \relax +} + +% Make non-ASCII characters printable again for compatibility with +% existing Texinfo documents that may use them, even without declaring a +% document encoding. +% +\setnonasciicharscatcode \other + + +\message{formatting,} + +\newdimen\defaultparindent \defaultparindent = 15pt + +\chapheadingskip = 15pt plus 4pt minus 2pt +\secheadingskip = 12pt plus 3pt minus 2pt +\subsecheadingskip = 9pt plus 2pt minus 2pt + +% Prevent underfull vbox error messages. +\vbadness = 10000 + +% Don't be so finicky about underfull hboxes, either. +\hbadness = 2000 + +% Following George Bush, get rid of widows and orphans. +\widowpenalty=10000 +\clubpenalty=10000 + +% Use TeX 3.0's \emergencystretch to help line breaking, but if we're +% using an old version of TeX, don't do anything. We want the amount of +% stretch added to depend on the line length, hence the dependence on +% \hsize. We call this whenever the paper size is set. +% +\def\setemergencystretch{% + \ifx\emergencystretch\thisisundefined + % Allow us to assign to \emergencystretch anyway. + \def\emergencystretch{\dimen0}% + \else + \emergencystretch = .15\hsize + \fi +} + +% Parameters in order: 1) textheight; 2) textwidth; +% 3) voffset; 4) hoffset; 5) binding offset; 6) topskip; +% 7) physical page height; 8) physical page width. +% +% We also call \setleading{\textleading}, so the caller should define +% \textleading. The caller should also set \parskip. +% +\def\internalpagesizes#1#2#3#4#5#6#7#8{% + \voffset = #3\relax + \topskip = #6\relax + \splittopskip = \topskip + % + \vsize = #1\relax + \advance\vsize by \topskip + \outervsize = \vsize + \advance\outervsize by 2\topandbottommargin + \pageheight = \vsize + % + \hsize = #2\relax + \outerhsize = \hsize + \advance\outerhsize by 0.5in + \pagewidth = \hsize + % + \normaloffset = #4\relax + \bindingoffset = #5\relax + % + \ifpdf + \pdfpageheight #7\relax + \pdfpagewidth #8\relax + % if we don't reset these, they will remain at "1 true in" of + % whatever layout pdftex was dumped with. + \pdfhorigin = 1 true in + \pdfvorigin = 1 true in + \fi + % + \setleading{\textleading} + % + \parindent = \defaultparindent + \setemergencystretch +} + +% @letterpaper (the default). +\def\letterpaper{{\globaldefs = 1 + \parskip = 3pt plus 2pt minus 1pt + \textleading = 13.2pt + % + % If page is nothing but text, make it come out even. + \internalpagesizes{607.2pt}{6in}% that's 46 lines + {\voffset}{.25in}% + {\bindingoffset}{36pt}% + {11in}{8.5in}% +}} + +% Use @smallbook to reset parameters for 7x9.25 trim size. +\def\smallbook{{\globaldefs = 1 + \parskip = 2pt plus 1pt + \textleading = 12pt + % + \internalpagesizes{7.5in}{5in}% + {-.2in}{0in}% + {\bindingoffset}{16pt}% + {9.25in}{7in}% + % + \lispnarrowing = 0.3in + \tolerance = 700 + \hfuzz = 1pt + \contentsrightmargin = 0pt + \defbodyindent = .5cm +}} + +% Use @smallerbook to reset parameters for 6x9 trim size. +% (Just testing, parameters still in flux.) +\def\smallerbook{{\globaldefs = 1 + \parskip = 1.5pt plus 1pt + \textleading = 12pt + % + \internalpagesizes{7.4in}{4.8in}% + {-.2in}{-.4in}% + {0pt}{14pt}% + {9in}{6in}% + % + \lispnarrowing = 0.25in + \tolerance = 700 + \hfuzz = 1pt + \contentsrightmargin = 0pt + \defbodyindent = .4cm +}} + +% Use @afourpaper to print on European A4 paper. +\def\afourpaper{{\globaldefs = 1 + \parskip = 3pt plus 2pt minus 1pt + \textleading = 13.2pt + % + % Double-side printing via postscript on Laserjet 4050 + % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. + % To change the settings for a different printer or situation, adjust + % \normaloffset until the front-side and back-side texts align. Then + % do the same for \bindingoffset. You can set these for testing in + % your texinfo source file like this: + % @tex + % \global\normaloffset = -6mm + % \global\bindingoffset = 10mm + % @end tex + \internalpagesizes{673.2pt}{160mm}% that's 51 lines + {\voffset}{\hoffset}% + {\bindingoffset}{44pt}% + {297mm}{210mm}% + % + \tolerance = 700 + \hfuzz = 1pt + \contentsrightmargin = 0pt + \defbodyindent = 5mm +}} + +% Use @afivepaper to print on European A5 paper. +% From romildo@urano.iceb.ufop.br, 2 July 2000. +% He also recommends making @example and @lisp be small. +\def\afivepaper{{\globaldefs = 1 + \parskip = 2pt plus 1pt minus 0.1pt + \textleading = 12.5pt + % + \internalpagesizes{160mm}{120mm}% + {\voffset}{\hoffset}% + {\bindingoffset}{8pt}% + {210mm}{148mm}% + % + \lispnarrowing = 0.2in + \tolerance = 800 + \hfuzz = 1.2pt + \contentsrightmargin = 0pt + \defbodyindent = 2mm + \tableindent = 12mm +}} + +% A specific text layout, 24x15cm overall, intended for A4 paper. +\def\afourlatex{{\globaldefs = 1 + \afourpaper + \internalpagesizes{237mm}{150mm}% + {\voffset}{4.6mm}% + {\bindingoffset}{7mm}% + {297mm}{210mm}% + % + % Must explicitly reset to 0 because we call \afourpaper. + \globaldefs = 0 +}} + +% Use @afourwide to print on A4 paper in landscape format. +\def\afourwide{{\globaldefs = 1 + \afourpaper + \internalpagesizes{241mm}{165mm}% + {\voffset}{-2.95mm}% + {\bindingoffset}{7mm}% + {297mm}{210mm}% + \globaldefs = 0 +}} + +% @pagesizes TEXTHEIGHT[,TEXTWIDTH] +% Perhaps we should allow setting the margins, \topskip, \parskip, +% and/or leading, also. Or perhaps we should compute them somehow. +% +\parseargdef\pagesizes{\pagesizesyyy #1,,\finish} +\def\pagesizesyyy#1,#2,#3\finish{{% + \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi + \globaldefs = 1 + % + \parskip = 3pt plus 2pt minus 1pt + \setleading{\textleading}% + % + \dimen0 = #1\relax + \advance\dimen0 by \voffset + % + \dimen2 = \hsize + \advance\dimen2 by \normaloffset + % + \internalpagesizes{#1}{\hsize}% + {\voffset}{\normaloffset}% + {\bindingoffset}{44pt}% + {\dimen0}{\dimen2}% +}} + +% Set default to letter. +% +\letterpaper + + +\message{and turning on texinfo input format.} + +% 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 + +% 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, +% where something hairier probably needs to be done. +% +% #1 is what to print if we are indeed using \tt; #2 is what to print +% otherwise. Since all the Computer Modern typewriter fonts have zero +% interword stretch (and shrink), and it is reasonable to expect all +% typewriter fonts to have this, we can check that font parameter. +% +\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} + +% Same as above, but check for italic font. Actually this also catches +% non-italic slanted fonts since it is impossible to distinguish them from +% italic fonts. But since this is only used by $ and it uses \sl anyway +% this is not a problem. +\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} + +% Turn off all special characters except @ +% (and those which the user can use as if they were ordinary). +% Most of these we simply print from the \tt font, but for some, we can +% use math or other variants that look better in normal text. + +\catcode`\"=\active +\def\activedoublequote{{\tt\char34}} +\let"=\activedoublequote +\catcode`\~=\active +\def~{{\tt\char126}} +\chardef\hat=`\^ +\catcode`\^=\active +\def^{{\tt \hat}} + +\catcode`\_=\active +\def_{\ifusingtt\normalunderscore\_} +\let\realunder=_ +% Subroutine for the previous macro. +\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } + +\catcode`\|=\active +\def|{{\tt\char124}} +\chardef \less=`\< +\catcode`\<=\active +\def<{{\tt \less}} +\chardef \gtr=`\> +\catcode`\>=\active +\def>{{\tt \gtr}} +\catcode`\+=\active +\def+{{\tt \char 43}} +\catcode`\$=\active +\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix + +% If a .fmt file is being used, characters that might appear in a file +% name cannot be active until we have parsed the command line. +% So turn them off again, and have \everyjob (or @setfilename) turn them on. +% \otherifyactive is called near the end of this file. +\def\otherifyactive{\catcode`+=\other \catcode`\_=\other} + +% Used sometimes to turn off (effectively) the active characters even after +% parsing them. +\def\turnoffactive{% + \normalturnoffactive + \otherbackslash +} + +\catcode`\@=0 + +% \backslashcurfont outputs one backslash character in current font, +% as in \char`\\. +\global\chardef\backslashcurfont=`\\ +\global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work + +% \realbackslash is an actual character `\' with catcode other, and +% \doublebackslash is two of them (for the pdf outlines). +{\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}} + +% In texinfo, backslash is an active character; it prints the backslash +% in fixed width font. +\catcode`\\=\active +@def@normalbackslash{{@tt@backslashcurfont}} +% 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. +@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 +} + +% Make _ and + \other characters, temporarily. +% This is canceled by @fixbackslash. +@otherifyactive + +% If a .fmt file is being used, we don't want the `\input texinfo' to show up. +% That is what \eatinput is for; after that, the `\' should revert to printing +% a backslash. +% +@gdef@eatinput input texinfo{@fixbackslash} +@global@let\ = @eatinput + +% On the other hand, perhaps the file did not have a `\input texinfo'. Then +% the first `\' in the file would cause an error. This macro tries to fix +% that, assuming it is called before the first `\' could plausibly occur. +% Also turn back on active characters that might appear in the input +% file name, in case not using a pre-dumped format. +% +@gdef@fixbackslash{% + @ifx\@eatinput @let\ = @normalbackslash @fi + @catcode`+=@active + @catcode`@_=@active +} + +% Say @foo, not \foo, in error messages. +@escapechar = `@@ + +% These look ok in all fonts, so just make them not special. +@catcode`@& = @other +@catcode`@# = @other +@catcode`@% = @other + +@c Finally, make ` and ' active, so that txicodequoteundirected and +@c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we +@c don't make ` and ' active, @code will not get them as active chars. +@c Do this last of all since we use ` in the previous @catcode assignments. +@catcode`@'=@active +@catcode`@`=@active +@markupsetuplqdefault +@markupsetuprqdefault + +@c Local variables: +@c eval: (add-hook 'write-file-hooks 'time-stamp) +@c page-delimiter: "^\\\\message" +@c time-stamp-start: "def\\\\texinfoversion{" +@c time-stamp-format: "%:y-%02m-%02d.%02H" +@c time-stamp-end: "}" +@c End: + +@c vim:sw=2: + +@ignore + arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 +@end ignore |