From eb7ac943ed743035358e3cd2036743428a16f147 Mon Sep 17 00:00:00 2001 From: Kalle Olavi Niemitalo Date: Wed, 27 Dec 2006 19:14:57 +0200 Subject: [PATCH] doc: Backslashify dashes in long options to prevent —. --- doc/bittorrent.txt | 2 +- doc/exmode.txt | 2 +- doc/faq.txt | 4 ++-- doc/mailcap.txt | 2 +- doc/manual.txt | 2 +- doc/small.txt | 28 ++++++++++++++-------------- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/bittorrent.txt b/doc/bittorrent.txt index f1ebb522..5bf637cd 100644 --- a/doc/bittorrent.txt +++ b/doc/bittorrent.txt @@ -5,7 +5,7 @@ This chapter provides a small manual for using the implemented BitTorrent client. The BitTorrent client is provided as an optional add-on for ELinks, and needs to be enabled at compile time. To build ELinks with BitTorrent support be sure to either pass -`--enable-bittorrent` to `./configure` or change the value of +`\--enable-bittorrent` to `./configure` or change the value of `CONFIG_BITTORRENT` to `yes` in `features.conf`. Using the BitTorrent Client diff --git a/doc/exmode.txt b/doc/exmode.txt index fb26fa85..d35a62a9 100644 --- a/doc/exmode.txt +++ b/doc/exmode.txt @@ -6,7 +6,7 @@ Are you a vim-controls nerd who wants to see them everywhere? Welcome. Actually ELinks doesn't shine in this area yet very much. Heck, the famous hjkl foursome is still occupied by some feeble managers in the default keymap (we have that in our monumental TODO lists). Still, if you know what to touch -during the compilation (`--enable-exmode`), you can get at least some familiar +during the compilation (`\--enable-exmode`), you can get at least some familiar reply to the mighty ``:'' (colon) grip. diff --git a/doc/faq.txt b/doc/faq.txt index 4123bea4..f7ff4b24 100644 --- a/doc/faq.txt +++ b/doc/faq.txt @@ -34,7 +34,7 @@ The reason why normal cut and paste does not work is that ELinks requests all mouse event info even if it is compiled without GPM. Therefore it is necessary to hold down the Shift key when cutting or pasting text. If you do not need to use the mouse for navigation you can disable mouse support by passing -`--disable-mouse` to configure. +`\--disable-mouse` to configure. [[move]] @@ -110,7 +110,7 @@ First, you must enable it in the `feature.conf` file before compiling. Second, you must run ELinks on a terminal that supports 256 colours: - link:http://dickey.his.com/xterm/xterm.html[Thomas Dickey's XTerm], - revision 111. XTerm must be compiled with `--enable-256-color`. + revision 111. XTerm must be compiled with `\--enable-256-color`. - Recent versions of link:http://www.chiark.greenend.org.uk/~sgtatham/putty/[PuTTY]. diff --git a/doc/mailcap.txt b/doc/mailcap.txt index 5ad015a0..5980f402 100644 --- a/doc/mailcap.txt +++ b/doc/mailcap.txt @@ -21,7 +21,7 @@ on most UNIX systems--usually in /etc/mailcap--so this makes it possible for ELinks to know how to handle a great variety of file formats with little configuration. To be able to use mailcap, it has to be compiled into ELinks. This is the default. If you don't need mailcap support, just configure ELinks -with the flag: --disable-mailcap. +with the flag: \--disable-mailcap. Parameters to Mailcap Entries diff --git a/doc/manual.txt b/doc/manual.txt index 9cdbc3a5..ee3af56e 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -8,7 +8,7 @@ Welcome! This is the entry point for the humble ELinks manual. It is by no means complete, it is not even very homogeneous and it should eventually be superseded by a complete ELinks Book. Until this happens you may also find it necessary to refer to the manual page for a very quick reference, or the -built-in documentation available via the --long-help and --config-help ELinks +built-in documentation available via the \--long-help and \--config-help ELinks command-line arguments. The built-in documentation is sure to be up-to-date. There was a complete (or, for the most part complete) manual for Links 0.82 at diff --git a/doc/small.txt b/doc/small.txt index 035874de..6ee41705 100644 --- a/doc/small.txt +++ b/doc/small.txt @@ -41,11 +41,11 @@ You can disable bookmarks, globhist and more, too, if you want to. [NOTE] .Notes =============================================================================== - - --disable-backtrace disables internal backtrace code. - - --disable-nls disables i18n support. - - --enable-fastmem disables internal `malloc()` debugging and use `alloca()` + - \--disable-backtrace disables internal backtrace code. + - \--disable-nls disables i18n support. + - \--enable-fastmem disables internal `malloc()` debugging and use `alloca()` wherever possible. - - --enable-small forces to remove some text descriptions in options and + - \--enable-small forces to remove some text descriptions in options and keybind stuff (regain 30Kb). =============================================================================== @@ -54,15 +54,15 @@ options: `-----------------------`------------------------------------------------------ Option Description ------------------------------------------------------------------------------- ---without-zlib removes libz dependency (compression) ---without-bzlib removes libbz2 dependency (compression) ---disable-xbel removes expat dependency (XBEL bookmarks support) ---without-lua removes liblua dependency (Lua scripting) ---without-gnutls removes libtls dependency (SSL support) ---without-openssl removes libssl dependency (SSL support) ---without-x removes libx11 dependency (restoring terminal title) ---without-spidermonkey removes libjs dependency (JavaScript) ---without-gpm removes libgpm dependency (mouse/console) +\--without-zlib removes libz dependency (compression) +\--without-bzlib removes libbz2 dependency (compression) +\--disable-xbel removes expat dependency (XBEL bookmarks support) +\--without-lua removes liblua dependency (Lua scripting) +\--without-gnutls removes libtls dependency (SSL support) +\--without-openssl removes libssl dependency (SSL support) +\--without-x removes libx11 dependency (restoring terminal title) +\--without-spidermonkey removes libjs dependency (JavaScript) +\--without-gpm removes libgpm dependency (mouse/console) ------------------------------------------------------------------------------- It seems GCC 2.95.x do not generate as small binaries as GCC 3.2.x with same @@ -82,7 +82,7 @@ Here are some results using gcc 2.95.3, dietlibc-0.23, and previous flags: Whow ! Around 200kb :) [NOTE] -.Details about the `--enable-small` configure option effects: +.Details about the `\--enable-small` configure option effects: ============================================================================== - it disables long descriptions of options; - it disables textual descriptions of keybinding options;