/MirOS/dist/jupp/joe-3.1jupp30.tgz
[alioth/jupp.git] / joe.txt
diff --git a/joe.txt b/joe.txt
index 5cea0c7..9f39fb5 100644 (file)
--- a/joe.txt
+++ b/joe.txt
@@ -35,13 +35,13 @@ Description
      Although JOE is actually six different editors, it still\r
      requires only one executable, but one with six different\r
      names.  The name of the editor with an "rc" appended gives\r
-     the name of JOE's initialization file, which determines the\r
+     the name of JOE's initialisation file, which determines the\r
      personality of the editor.\r
 \r
      JUPP is free software; you can distribute it and/or modify\r
      it under the terms of the GNU General Public License, Ver-\r
      sion 1, as published by the Free Software Foundation.\r
-     (main.c contains more detailled exceptions.) I have no plans\r
+     (main.c contains more detailed exceptions.) I have no plans\r
      for turning JOE into a commercial or share-ware product. See\r
      the source code for exact authorship and licencing informa-\r
      tion. JOE is available over the Internet from http://joe-\r
@@ -61,6 +61,12 @@ Usage
      sections of files or devices.  See the section Filenames\r
      below for details.\r
 \r
+     On cygwin32 systems, the special option -CYGhack is replaced\r
+     by anything that comes past it (and separating whitespace)\r
+     on the command line as one option (to work around a Cygwin\r
+     bug as it cannot correctly be passed a UNC pathname with\r
+     spaces as one argument from Explorer at all).\r
+\r
      Once you are in the editor, you can type in text and use\r
      special control-character sequences to perform other editing\r
      tasks.  To find out what the control-character sequences\r
@@ -92,17 +98,23 @@ Usage
      topics, hit ^[, and ^[. (that is, ESC , and ESC .).  Use ^K\r
      H to dismiss the help window.\r
 \r
-     You can customize the keyboard layout, the help screens and\r
+     You can customise the keyboard layout, the help screens and\r
      a number of behavior defaults by copying JOE's initialisa-\r
      tion file (joerc in the same directory as the binary resides\r
      in) to .joerc in your home directory and then by modifying\r
-     it. See the section joerc below.\r
+     it. See the section joerc below. The filename is actually\r
+     .namerc where name is the argv[0] the editor is called with.\r
+\r
+     Custom syntax files are loaded from .jupp/syntax/name.jsf in\r
+     your home directory and .jupp/charmaps/name holds custom\r
+     charmaps (name here is the name of the syntax or charmap).\r
 \r
      To have JOE used as your default editor for e-mail and News,\r
      you need to set the EDITOR and VISUAL environment variables\r
-     in your shell initialization file (.cshrc or .profile) to\r
+     in your shell initialisation file (.cshrc or .profile) to\r
      refer to JOE (the joe binary usually resides as\r
      C:\Programme\jupp32\joe.exe).\r
+\r
      There are a number of other obscure invocation parameters\r
      which may have to be set, particularly if your terminal\r
      screen is not updating as you think it should.  See the sec-\r
@@ -125,7 +137,7 @@ Command Line Options
 \r
      -baud nnn\r
           Set the baud rate for the purposes of terminal screen\r
-          optimization.  Joe inserts delays for baud rates below\r
+          optimisation.  Joe inserts delays for baud rates below\r
           19200, which bypasses tty buffering so that typeahead\r
           will interrupt the screen output.  Scrolling commands\r
           will not be used for 38400 baud.  This is useful for\r
@@ -190,6 +202,7 @@ Command Line Options
 \r
      -nobackups\r
           This option prevents backup files.\r
+\r
      -nonotice\r
           This option prevent the copyright notice from being\r
           displayed when the editor starts.\r
@@ -221,12 +234,7 @@ Command Line Options
      Each of these options may be specified in the joerc file as\r
      well.  In addition, the NOXON, BAUD, LINES, COLUMNS and\r
      DOPADDING options may be specified with environment vari-\r
-     ables.\r
-\r
-     The JOETERM environment variable may be set to override the\r
-     regular TERM environment variable for specifying your termi-\r
-     nal type.\r
-\r
+     ables. See the section Environment variables below.\r
      The following options may be specified before each filename\r
      on the command line:\r
 \r
@@ -384,7 +392,7 @@ Editing Tasks
      .c, .h or .p), JOE will automatically wrap the last word\r
      onto the next line so that you don't have to hit Return.\r
      This is called word-wrap mode.  Word-wrap can be turned on\r
-     or off with the ^T W command.  JOE's initialization file is\r
+     or off with the ^T W command.  JOE's initialisation file is\r
      usually set up so that this mode is automatically turned on\r
      for all non-program files.  See the section below on the\r
      joerc file to change this and other defaults.\r
@@ -414,7 +422,7 @@ Editing Tasks
      position of the right side of the table. When this occurs,\r
      you can put the editor in over-type mode with ^T T. When the\r
      editor is in this mode, the characters you type in replace\r
-     existing characters, in the way an idealized typewriter\r
+     existing characters, in the way an idealised typewriter\r
      would.  Also, Backspace simply moves left instead of delet-\r
      ing the character to the left, when it's not at the end or\r
      beginning of a line.  Over-type mode is not the natural way\r
@@ -748,7 +756,6 @@ Editing Tasks
      fied number of times.  Hit ^K \, type in the number of times\r
      you want the command repeated and press Return.  The next\r
      edit command you now give will be repeated that many times.\r
-\r
      For example, to delete the next 20 lines of text, type:\r
 \r
      ^K  20<return>^Y\r
@@ -838,6 +845,27 @@ Environment variables
      The xterm-xfree86 terminal allows automatic entering and\r
      leaving of the bracketed paste mode.\r
 \r
+     The JOETERM environment variable may be set to override the\r
+     regular TERM environment variable for specifying your termi-\r
+     nal type.\r
+\r
+     JOE uses two character maps for its operation: the terminal\r
+     I/O character map, which determines how characters are sent\r
+     to the terminal and whether the %a/%A message specifiers use\r
+     Unicode, and the file encoding, which can be specified per\r
+     file using the -encoding option and changed with the ^T E\r
+     command, and which defaults to the terminal I/O character\r
+     map, which, in turn, is determined from the current locale,\r
+     if the system supports such, otherwise the LC_ALL, LC_CTYPE\r
+     and LANG environment variables (if they contain a period,\r
+     only the part after it and before an optional "at sign" is\r
+     used); on cygwin32 before 1.7.2, the codepage is used\r
+     instead if the POSIX locale environment variables are empty;\r
+     the environment variable JOECHARMAP can be used to manually\r
+     force one overriding all methods described above, and can be\r
+     used together with -encoding to specify a different default\r
+     file character map.\r
+\r
      JOE normally expects that flow control between the computer\r
      and your terminal to use ^S/^Q handshaking (I.E., if the\r
      computer is sending characters too fast for your terminal,\r
@@ -876,7 +904,6 @@ Filenames
           octal (ex.: 0777) or hexadecimal (ex.: 0xFF).  For\r
           example, use joe /dev/fd0,508,2 to edit bytes 508 and\r
           509 of the first floppy drive in Linux.\r
-\r
      -    Use this to get input from the standard input or to\r
           write output to the standard output.  For example, you\r
           can put joe in a pipe of commands: quota -v | joe - |\r
@@ -885,11 +912,11 @@ Filenames
 \r
 The joerc file\r
      ^T options, the help screens and the key-sequence to editor\r
-     command bindings are all defined in JOE's initialization\r
+     command bindings are all defined in JOE's initialisation\r
      file. If you make a copy of this file (which resides in the\r
      same directory as the binary) to $HOME/.joerc, you can cus-\r
      tomise these settings to your liking. The syntax of the ini-\r
-     tialization file should be fairly obvious, and there are\r
+     tialisation file should be fairly obvious, and there are\r
      further instruction in it.\r
 \r
 Acknowledgments\r