{ "mode": "man", "parameter": "mc", "section": "joe", "url": "https://www.chedong.com/phpMan.php/man/mc/joe/json", "generated": "2026-06-14T05:36:41Z", "synopsis": "mc [-abcCdfhPstuUVx] [-l log] [dir1 [dir2]] [-e [file] ...] [-v file]", "sections": { "NAME": { "content": "mc - Visual shell for Unix-like systems.\n", "subsections": [] }, "Syntax": { "content": "", "subsections": [ { "name": "joe [global-options] [ [local-options] filename ]...", "content": "" }, { "name": "jstar [global-options] [ [local-options] filename ]...", "content": "" }, { "name": "jmacs [global-options] [ [local-options] filename ]...", "content": "" }, { "name": "rjoe [global-options] [ [local-options] filename ]...", "content": "" }, { "name": "jpico [global-options] [ [local-options] filename ]...", "content": "" } ] }, "Description": { "content": "JOE is a powerful console screen editor. It has a \"mode-less\" user interface which is similar\nto many user-friendly PC editors. Users of Micro-Pro´s WordStar or Borland´s \"Turbo\" lan‐\nguages will feel at home. JOE is a full featured UNIX screen-editor though, and has many fea‐\ntures for editing programs and text.\n\nJOE also emulates several other editors. JSTAR is a close imitation of WordStar with many\n\"JOE\" extensions. JPICO is a close imitation of the Pine mailing system´s PICO editor, but\nwith many extensions and improvements. JMACS is a GNU-EMACS imitation. RJOE is a restricted\nversion of JOE, which allows you to edit only the files specified on the command line.\n\nAlthough JOE is actually five different editors, it still requires only one executable, but\none with five different names. The name of the editor with an \"rc\" appended gives the name of\nJOE´s initialization file, which determines the personality of the editor.\n\nJOE is free software; you can distribute it and/or modify it under the terms of the GNU Gen‐\neral Public License as published by the Free Software Foundation. JOE is available over the\nInternet from http://www.sourceforge.net/projects/joe-editor.\n", "subsections": [] }, "Usage": { "content": "To start the editor, type joe followed by zero or more names of files you want to edit. Each\nfile name may be preceded by a local option setting (see the local options table which fol‐\nlows). Other global options, which apply to the editor as a whole, may also be placed on the\ncommand line (see the global options table which follows). If you are editing a new file, you\ncan either give the name of the new file when you invoke the editor, or in the editor when\nyou save the new file. A modified syntax for file names is provided to allow you to edit pro‐\ngram output, standard input/output, or sections of files or devices. See the section File‐\nnames below for details.\n\nOnce you are in the editor, you can type in text and use special control-character sequences\nto perform other editing tasks. To find out what the control-character sequences are, read\nthe rest of this man page or type ^K H for help in the editor.\n\nNow for some obscure computer-lore:\n\nThe ^ means that you hold down the Control key while pressing the following key (the same way\nthe Shift key works for uppercase letters). A number of control-key sequences are duplicated\non other keys, so that you don´t need to press the control key: Esc will work in place of ^[,\nDel will work in place of ^?, Backspace will work in place of ^H, Tab will work in place of\n^I, Return or Enter will work in place of ^M and Linefeed will work in place of ^J. Some key‐\nboards may give you trouble with some control keys. ^, ^^ and ^@ can usually be entered\nwithout pressing shift (i.e., try ^-, ^6 and ^2). Other keyboards may reassign these to other\nkeys. Try: ^., ^, and ^/. ^Space can usually be used in place of ^@. ^\\ and ^] are inter‐\npreted by many communication programs, including telnet and kermit. Usually you just hit the\nkey twice to get it to pass through the communication program.\n\nOn some keyboards, holding the Alt key down while pressing another key is the same as typing\nEsc before typing the other key.\n\nOnce you have typed ^K H, the first help window appears at the top of the screen. You can\ncontinue to enter and edit text while the help window is on. To page through other topics,\nhit Esc , and Esc . (that is, Esc , and Esc .). Use ^K H to dismiss the help window.\n\nYou can customize the keyboard layout, the help screens and a number of behavior defaults by\ncopying JOE´s initialization file (usually /etc/joe/joerc) to .joerc in your home directory\nand then by modifying it. See the section joerc below.\n\nTo have JOE used as your default editor for e-mail and News, you need to set the EDITOR and\nVISUAL environment variables in your shell initialization file (.cshrc or .profile) to refer\nto JOE (JOE usually resides as /usr/bin/joe).\n\nThere are a number of other obscure invocation parameters which may have to be set, particu‐\nlarly if your terminal screen is not updating as you think it should. See the section Envi‐\nronment variables below.\n", "subsections": [ { "name": "Command Line Options", "content": "These options can also be specified in the joerc file. Local options can be set depending on\nthe file-name extension. Programs (.c, .h or .p extension) usually have autoindent enabled.\nWordwrap is enabled on other files, but rc files have it disabled.\n\nAn option is enabled when it´s given like this:\n\n\n\n-wordwrap\n\n\n\nAn option is disabled when it´s given like this:\n\n\n\n--wordwrap\n\n\n\nSome options take arguments. Arguments are given like this:\n\n\n\n-lmargin 5\n\n\n\nThe following global options may be specified on the command line:\n\n• asis\nCharacters with codes above 127 will be sent to the terminal as-is, instead of as inverse\nof the corresponding character below 128. If this does not work, check your terminal\nserver. This option has no effect if UTF-8 encoding is used.\n\n\n• assume256color\nAssume ANSI-like terminal emulator supports 256 colors even if termcap entry says it\ndoesn´t.\n\n\n• assumecolor\nAssume ANSI-like terminal emulator supports color even if termcap entry says it doesn´t.\n\n\n• textcolor color\nSet color for text.\n\n\n• statuscolor color\nSet color for status bar.\n\n\n• helpcolor color\nSet color for help.\n\n\n• menucolor color\nSet color for menus.\n\n\n• promptcolor color\nSet color for prompts.\n\n\n• msgcolor color\nSet color for messages.\n\n\n• autoswap\nAutomatically swap ^K B with ^K K if necessary to mark a legal block during block\ncopy/move commands.\n\n\n• backpath path\nSets path to a directory where all backup files are to be stored. If this is unset (the\ndefault) backup files are stored in the directory containing the file.\n\n\n• baud nnn\nSet the baud rate for the purposes of terminal screen optimization (overrides value re‐\nported by stty). JOE inserts delays for baud rates below 19200, which bypasses tty\nbuffering so that typeahead will interrupt the screen output. Scrolling commands will not\nbe used for 38400 baud and above. This is useful for X-terms and other console ttys which\nreally aren´t going over a serial line.\n\n\n• beep\nEnable beeps when edit commands return errors, for example when the cursor goes past ex‐\ntremes.\n\n\n• breaklinks\nWhen enabled, JOE first deletes the file before writing it in order to break hard-links\nand symbolic-links.\n\n\n• breakhardlinks\nWhen enabled, and the file is not a symbolic links, JOE first deletes the file before\nwriting it in order to break hard-links.\n\n\n• brpaste\nWhen JOE starts, send command to the terminal emulator that enables \"bracketed paste\nmode\" (but only if the terminal seems to have the ANSI command set). In this mode, text\npasted into the window is bracketed with ESC [ 2 0 0 ~ and ESC [ 2 0 1 ~.\n\n\n• columns nnn\nSet number of columns in terminal emulator (in case termcap entry is wrong). This is only\nuseful on old system which don´t have the \"get window size\" ioctl.\n\n\n• csmode\nEnable continued search mode: Successive ^K Fs repeat the current search instead of\nprompting for a new one.\n\n\n• dopadding\nEnable JOE to send padding NULs to the terminal (for very old terminals).\n\n\n• exask\nWhen set, ^K X prompts for a new name before saving the file.\n\n\n• floatmouse\nWhen set, mouse clicks can position the cursor beyond the ends of lines.\n\n\n• guesscrlf\nWhen set, JOE tries to guess the file format MS-DOS or UNIX.\n\n\n• guessindent\nWhen set, JOE tries to guess the indentation character and indentation step based on the\ncontents of the file. The algorithm is to find the greatest common factor of the three\nmost common indentations found in the file.\n\n\n• guessnonutf8\nWhen set, enable guessing of non-UTF-8 files in UTF-8 locales.\n\n\n• guessutf8\nWhen set, enable guessing of UTF-8 files in non-UTF-8 locales.\n\n\n• guessutf16\nWhen set, enable guessing of UTF-16 files. If a UTF-16BE or UTF-16LE file is detected, it\nis converted to UTF-8 during load, and converted back to UTF-16 during save.\n\n\n• helpon\nWhen set, start off with the on-line help enabled.\n\n\n• helpisutf8\nWhen set, the help text in the joerc file is assumed to be UTF-8.\n\n\n• icase\nSearch is case insensitive by default when set.\n\n\n• joestate\nEnable reading and writing of ~/.joestate file\n\n\n• joexterm\nSet this if xterm was configured with --paste64 option for better mouse support.\n\n\n• keepup\nThe column number on the status line is updated constantly when this is set, otherwise it\nis updated only once a second.\n\n\n• language language\nSets language for aspell.\n\n\n• lightoff\nAutomatically turn off ^K B ^K K highlighting after a block operation.\n\n\n• lines nnn\nSet number of lines in terminal emulator (in case termcap entry is wrong). This is only\nuseful on old system which don´t have the \"get window size\" ioctl.\n\n\n• marking\nEnable marking mode: highlights between ^K B and cursor.\n\n\n• menuabove\nPut menus above prompt instead of below them.\n\n\n• menuexplorer\nStay in menu when a directory is selected (otherwise the directory is added to the path\nand the cursor jumps back to the prompt).\n\n\n• menujump\nJump into the file selection menu when Tab Tab is hit.\n\n\n• mid\nIf this option is set and the cursor moves off the window, the window will be scrolled so\nthat the cursor is in the center. This option is forced on slow terminals which don´t\nhave scrolling commands.\n\n\n• left nn\nThis sets the number of columns the screen scrolls to the left when cursor moves past the\nleft edge or when the crawll command is issued. If nn is negative, then it´s the fraction\nof the screen to scroll. For example, -2 means scroll 1/2 the screen.\n\n\n• right nn\nThis sets the number of columns the screen scrolls to the right when cursor moves past\nthe right edge or when the crawlr command is issued. If nn is negative, then it´s the\nfraction of the screen to scroll. For example, -3 means scroll 1/3 the screen.\n\n\n• mouse\nEnable xterm mouse support.\n\n\n• nobackups\nDisable backup files.\n\n\n• nocurdir\nDisable current-directory prefix in prompts.\n\n\n• noexmsg\nDisable exiting message (\"File not changed so no update needed\")\n\n\n• nolinefeeds\nDisable sending linefeeds to preserve screen history in terminal emulator´s scroll-back\nbuffer (only relevant when notite mode is enabled).\n\n\n• nolocks\nDisable EMACS compatible file locks.\n\n\n• nomodcheck\nDisable periodic file modification check.\n\n\n• nonotice\nThis option prevents the copyright notice from being displayed when the editor starts.\n\n\n• nosta\nThis option eliminates the top-most status line. It´s nice for when you only want to see\nyour text on the screen or if you´re using a vt52.\n\n\n• notagsmenu\nDisable selection menu for tags search with multiple results.\n\n\n• notite\nDisable ti and te termcap sequences which are usually set up to save and restore the ter‐\nminal screen contents when JOE starts and exits.\n\n\n• pastehack\nIf keyboard input comes in as one block assume it´s a mouse paste and disable autoindent\nand wordwrap.\n\n\n• noxon\nDisable ^S and ^Q flow control, possibly allowing ^S and ^Q to be used as editor keys.\n\n\n• orphan\nOrphan extra files given on the command line instead of creating windows for them (the\nfiles are loaded, but you need to use switch-buffer commands to access them).\n\n\n• pg nnn\nSet number of lines to keep during Page Up and Page Down (use -1 for 1/2 window size).\n\n\n• regex\nUse standard regular expression syntax by default, instead of the JOE syntax (where spe‐\ncial characters have their meaning only when preceded with backslash).\n\n\n• restore\nSet to have cursor positions restored to last positions of previously edited files.\n\n\n• rtbutton\nSwap left and right mouse buttons.\n\n\n• searchprompting\nShow previous search string in search command (like in PICO).\n\n\n• skiptop nnn\nWhen set to N, the first N lines of the terminal screen are not used by JOE and are in‐\nstead left with their original contents. This is useful for programs which call JOE to\nleave a message for the user.\n\n\n• square\nEnable rectangular block mode.\n\n\n• transpose\nTranspose rows with columns in all menus.\n\n\n• title\nDisplay context (titles) in status line. When enabled this shows the first line of the\nfunction that the cursor is in on the status line. The syntax file context.jsf identi‐\nfies which lines are title lines.\n\n\n• type\nSelect file type, overriding the automatically determined type. The file types are de‐\nfined in the ftyperc file.\n\n\n• undokeep nnn\nSets number of undo records to keep (0 means infinite).\n\n\n• usetabs\nSet to allow rectangular block operations to use tabs.\n\n\n• wrap\nEnable search to wrap to beginning of file.\n\n\n\n\nThe following local options may be specified on the command line:\n\n• +nnn\nThe cursor starts on the specified line.\n\n\n• autoindent\nEnable auto-indent mode. When you hit Enter on an indented line, the indentation is du‐\nplicated onto the new line.\n\n\n• ccomment\nEnable ^G skipping of C-style comments /.../\n\n\n• cpara characters\nSets list of characters which can indent paragraphs.\n\n\n• cnotpara characters\nSets list of characters which begin lines which are definitely not part of paragraphs.\n\n\n• cppcomment\nEnable ^G skipping of C++-style comments // ...\n\n\n• crlf\nJOE uses CR-LF as the end of line sequence instead of just LF. This is for editing MS-DOS\nor VMS files.\n\n\n• encoding encoding\nSet file encoding (like utf-8 or 8859-1).\n\n\n• flowed\nSet to force an extra space after each line of a paragraph but the last.\n\n\n• force\nWhen set, a final newline is appended to the file if there isn´t one when the file is\nsaved.\n\n\n• french\nWhen set, only one space is inserted after periods in paragraph reformats instead of two.\n\n\n• hex\nEnable hex-dump mode.\n\n\n• highlight\nEnable syntax highlighting.\n\n\n• highlightercontext\nEnable use of syntax file to identify comments and strings which should be skipped over\nduring ^G matching.\n\n\n• indentc nnn\nSets the indentation character for shift left and shift right (^K , and ^K .). Use 32 for\nSpace, 9 for Tab.\n\n\n• indentfirst\nWhen set, the smart home key jumps to the indentation point first, otherwise it jumps to\ncolumn 1 first.\n\n\n• istep nnn\nSets indentation step.\n\n\n• linums\nEnable line number display.\n\n\n• lmargin\nSet left margin.\n\n\n• lmsg\nDefine left-side status bar message.\n\n\n• overwrite\nEnable overtype mode. Typing overwrites existing characters instead of inserting before\nthem.\n\n\n• picture\nEnable \"picture\" mode- allows cursor to go past ends of lines.\n\n\n• poundcomment\n^G ignores # ... comments.\n\n\n• purify\nFix indentation if necessary before shifting or smart backspace. For example, if indenta‐\ntion uses a mix of tabs and spaces, and indentc is space, then indentation will be con‐\nverted to all spaces before the shifting operation.\n\n\n• rdonly\nSet read-only mode.\n\n\n• rmargin nnn\nSet right margin.\n\n\n• rmsg string\nDefine right-side status bar message.\n\n\n• semicomment\n^G ignores ; ... comments.\n\n\n• singlequoted\n^G ignores ´...´\n\n\n• smartbacks\nEnable smart backspace and tab. When this mode is set backspace and tab indent or unin‐\ndent based on the values of the istep and indentc options.\n\n\n• smarthome\nHome key first moves cursor to beginning of line, then if hit again, to the first\nnon-blank character.\n\n\n• smsg string\nDefine status command format when cursor is on a character.\n\n\n• spaces\nInsert spaces when Tab key is hit.\n\n\n• syntax syntax\nSet syntax for syntax highlighting.\n\n\n• tab nnn\nSet tab stop width.\n\n\n• textdelimiters word delimiter list\nGive list of word delimiters which ^G will step through.\n\n\n\nFor example, \"begin=end:if=elif=else=endif\" means that ^G will jump between the matching if,\nelif, else and endif.\n\n• vhdlcomment\n^G ignores -- ... comments\n\n\n• wordwrap\nJOE wraps the previous word when you type past the right margin.\n\n\n• zmsg string\nDefine status command format when cursor is at end of file.\n\n\n• xmsg string\nDefine startup message (usually the copyright notice).\n\n\n• aborthint string\nGive the key sequence to show in prompts for abort (usually ^C).\n\n\n• helphint string\nGive the key sequence to show in prompts for help (usually ^K H).\n\n\n\n" }, { "name": "Colors and attributes", "content": "Combine attributes and up to one foreground color and one background color to create argu‐\nments for color options like textcolor. For example: bold+bggreen+blue\n\n• Attributes: bold, inverse, blink, dim, underline, and italic\n\n• Foreground colors: white, cyan, magenta, blue, yellow, green, red, or black\n\n• Background colors: bgwhite, bgcyan, bgmagenta, bgblue, bgyellow, bggreen, bgred or\nbgblack\n\n\n\nWith a 16 color or 256 color terminal emulator (export TERM=xterm-16color), these brighter\nthan normal colors become available:\n\n• Foreground: WHITE, CYAN, MAGENTA, BLUE, YELLOW, GREEN, RED or BLACK\n\n• Background: bgWHITE, bgCYAN, bgMAGENTA, bgBLUE, bgYELLOW, bgGREEN, bgRED or\nbgBLACK\n\n\n\nWith a 256 color terminal emulator (export TERM=xterm-256color), these become available:\n\n• fgRGB and bgRGB, where R, G and B rand from 0 - 5. So: fg500 is bright red.\n\n• fgNN and bgNN give shades of grey, where the intensity, NN, ranges from 0 - 23.\n\n\n" }, { "name": "Status line definition strings", "content": "-lmsg defines the left-justified string and -rmsg defines the right-justified string. The\nfirst character of -rmsg is the background fill character.\n\n-smsg defines the status command (^K Space). -zmsg defines it when the cursor is at the end\nof the file. The last character of smsg or zmsg is the fill character.\n\nThe following escape sequences can be used in these strings:\n\n\n\n%t 12 hour time\n%u 24 hour time\n%T O for overtype mode, I for insert mode\n%W W if wordwrap is enabled\n%I A if autoindent is enabled\n%X Rectangle mode indicator\n%n File name\n%m ´(Modified)´ if file has been changed\n%* ´*´ if file has been changed\n%R Read-only indicator\n%r Row (line) number\n%c Column number\n%o Byte offset into file\n%O Byte offset into file in hex\n%a Ascii value of character under cursor\n%A Ascii value of character under cursor in hex\n%w Width of character under cursor\n%p Percent of file cursor is at\n%l No. lines in file\n%k Entered prefix keys\n%S ´*SHELL*´ if there is a shell running in window\n%M Macro recording message\n%y Syntax\n%e Encoding\n%x Context (first non-indented line going backwards)\n%dd day\n%dm month\n%dY year\n%Ename% value of environment variable\n%Tname% value of option (ON or OFF for Boolean options)\n\n\n\nThese formatting escape sequences may also be given:\n\n\n\n\\i Inverse\n\\u Underline\n\\b Bold\n\\d Dim\n\\f Blink\n\\l Italic\n\n\n" }, { "name": "Basic Editing", "content": "When you type characters into the editor, they are normally inserted into the file being\nedited (or appended to the file if the cursor is at the end of the file). This is the normal\noperating mode of the editor. If you want to replace some existing text, you have to delete\nthe old text before or after you type in the replacement text. The Backspace key can be used\nfor deleting text: move the cursor to right after the text you want to delete and hit\nBackspace a number of times.\n\nHit the Enter or Return key to insert a line-break. For example, if the cursor was in the\nmiddle of a line and you hit Enter, the line would be split into two lines with the cursor\nappearing at the beginning of the second line. Hit Backspace at the beginning of a line to\neliminate a line-break.\n\nUse the arrow keys to move around the file. If your keyboard doesn´t have arrow keys (or if\nthey don´t work for some reason), use ^F to move forwards (right), ^B to move backwards\n(left), ^P to move to the previous line (up), and ^N to move to the next line (down). The\nright and left arrow keys simply move forwards or backwards one character at a time through\nthe text: if you´re at the beginning of a line and you press left-arrow, you will end up at\nthe end of the previous line. The up and down arrow keys move forwards and backwards by\nenough characters so that the cursor appears in the same column that it was in on the origi‐\nnal line.\n\nIf you want to indent the text you enter, you can use the Tab key. This inserts a special\ncontrol character which makes the characters which follow it begin at the next tab stop. Tab\nstops normally occur every 8 columns, but this can be changed with the ^T D command. PASCAL\nand C programmers often set tab stops on every 4 columns.\n\nIf for some reason your terminal screen gets messed up (for example, if you receive a mail\nnotice from biff), you can have the editor refresh the screen by hitting ^R.\n\nThere are many other keys for deleting text and moving around the file. For example, hit ^D\nto delete the character the cursor is on instead of deleting backwards like Backspace. ^D\nwill also delete a line-break if the cursor is at the end of a line. Type ^Y to delete the\nentire line the cursor is on or ^J to delete just from the cursor to the end of the line.\n\nHit ^A to move the cursor to the beginning of the line it´s on. Hit ^E to move the cursor to\nthe end of the line. Hit ^U or ^V for scrolling the cursor up or down 1/2 a screen´s worth.\n\"Scrolling\" means that the text on the screen moves, but the cursor stays at the same place\nrelative to the screen. Hit ^K U or ^K V to move the cursor to the beginning or the end of\nthe file. Look at the help screens in the editor to find even more delete and movement com‐\nmands.\n\nIf you make a mistake, you can hit ^ to \"undo\" it. On most keyboards you hit just ^- to get\n^, but on some you might have to hold both the Shift and Control keys down at the same time\nto get it. If you \"undo\" too much, you can \"redo\" the changes back into existence by hitting\n^^ (type this with just ^6 on most keyboards).\n" }, { "name": "Cursor position history", "content": "If you were editing in one place within the file, and you then temporarily had to look or\nedit some other place within the file, you can get back to the original place by hitting ^K\n-. This command actually returns you to the last place you made a change in the file. You can\nstep through a history of places with ^K - and ^K =, in the same way you can step through the\nhistory of changes with the \"undo\" and \"redo\" commands.\n" }, { "name": "Save and exit", "content": "When you are done editing the file, hit ^K X to exit the editor. You will be prompted for a\nfile name if you hadn´t already named the file you were editing.\n\nWhen you edit a file, you actually edit only a copy of the file. So if you decide that you\ndon´t want the changes you made to a file during a particular edit session, you can hit ^C to\nexit the editor without saving them.\n\nIf you edit a file and save the changes, a backup copy of that file is created in the current\ndirectory, with a ~ appended to the name, which contains the original version of the file.\n" }, { "name": "File operations", "content": "You can hit ^K D to save the current file (possibly under a different name from what the file\nwas called originally). After the file is saved, you can hit ^K E to edit a different file.\n\nIf you want to save only a selected section of the file, see the section on Blocks below.\n\nIf you want to include another file in the file you´re editing, use ^K R to insert it.\n" }, { "name": "Filenames", "content": "Wherever JOE expects you to enter a file name, whether on the command line or in prompts\nwithin the editor, you may also type:\n\n• !command\n\n\n\nTo read or write data to or from a shell command. For example, use joe ´´!ls´´ to get a copy of\nyour directory listing to edit or from within the editor use ^K D !mail jhallen@world.std.com\nto send the file being edited to me.\n\n• >>filename\n\n\n\nUse this to have JOE append the edited text to the end of the file \"filename.\"\n\n• filename,START,SIZE\n\n\n\nUse this to access a fixed section of a file or device. START and SIZE may be entered in dec‐\nimal (ex.: 123) octal (ex.: 0777) or hexadecimal (ex.: 0xFF). For example, use joe\n/dev/fd0,508,2 to edit bytes 508 and 509 of the first floppy drive in Linux.\n\n• -\n\n\n\nUse this to get input from the standard input or to write output to the standard output. For\nexample, you can put JOE in a pipe of commands: quota -v | joe | mail root, if you want to\ncomplain about your low quota.\n" }, { "name": "Using JOE in a shell script", "content": "JOE used to use /dev/tty to access the terminal. This caused a problem with idle-session\nkillers (they would kill JOE because the real tty device was not being accessed for a long\ntime), so now JOE only uses /dev/tty if you need to pipe a file into JOE, as in:\n\n\n\necho \"hi\" | joe\n\n\n\nIf you want to use JOE in a shell script which has its stdin/stdout redirected, but you do\nnot need to pipe to it, you should simply redirect JOE´s stdin/stdout to /dev/tty:\n\n\n\njoe filename /dev/tty\n\n\n" }, { "name": "Word wrap and formatting", "content": "If you type past the right edge of the screen in a C or PASCAL language file, the screen will\nscroll to the right to follow the cursor. If you type past the right edge of the screen in a\nnormal file (one whose name doesn´t end in .c, .h or .p), JOE will automatically wrap the\nlast word onto the next line so that you don´t have to hit Enter. This is called word-wrap\nmode. Word-wrap can be turned on or off with the ^T W command. JOE´s initialization file is\nusually set up so that this mode is automatically turned on for all non-program files. See\nthe section below on the joerc file to change this and other defaults.\n\nAside for Word-wrap mode, JOE does not automatically keep paragraphs formatted like some\nword-processors. Instead, if you need a paragraph to be reformatted, hit ^K J. This command\n\"fills in\" the paragraph that the cursor is in, fitting as many words in a line as is possi‐\nble. A paragraph, in this case, is a block of text separated above and below by a blank line.\n\nThe margins which JOE uses for paragraph formatting and word-wrap can be set with the ^T L\nand ^T R commands. If the left margin is set to a value other than 1, then when you start\ntyping at the beginning of a line, the cursor will immediately jump to the left margin.\n\nThere are a number of options which control the paragraph reformatter and word wrapper:\n\n• The cpara option provides a list of characters which can indent a paragraph. For example,\nin e-mail quoted matter is indicated by > at the beginnings of line, so this character\nshould be in the cpara list.\n\n• The cnotpara option provides a list of characters which, if they are the first non-white‐\nspace character of a line, indicate that the line is not to be included as part of a\nparagraph for formatting. For example, lines beginning with ´.´ in nroff can not be para‐\ngraph lines.\n\n• Autoindent mode affects the formatter. If autoindent is disabled, only the first line\nwill be indented. If autoindent is enabled, the entire paragraph is indented.\n\n• french determines how many spaces are inserted after periods.\n\n• When flowed is enabled, a space is inserted after each but the last line of the para‐\ngraph. This indicates that the lines belong together as a single paragraph in some pro‐\ngrams.\n\n• When overtype is enabled, the word wrapper will not insert lines.\n\n\n" }, { "name": "Centering", "content": "If you want to center a line within the margins, use the ^K A command.\n" }, { "name": "Spell checker", "content": "Hit Esc N to check the spelling of the word the cursor is on using the aspell program (or is‐\npell program if you modify the joerc file). Hit Esc L to check the highlighted block or the\nentire file if no block is highlighted.\n\nJOE passes the language and character encoding to the spell checker. To change the language,\nhit ^T V. For example, use enUS for English.\n" }, { "name": "Overtype mode", "content": "Sometimes it´s tiresome to have to delete old text before or after you insert new text. This\nhappens, for example, when you are changing a table and you want to maintain the column posi‐\ntion of the right side of the table.\nWhen this occurs, you can put the editor in overtype mode with ^T T.\nWhen the editor is in this mode, the characters you type in replace existing characters, in\nthe way an idealized typewriter would. Also, Backspace simply moves left instead of deleting\nthe character to the left, when it´s not at the end or beginning of a line. Overtype mode is\nnot the natural way of dealing with text electronically, so you should go back to insert-mode\nas soon as possible by typing ^T T again.\n\nIf you need to insert while you´re in overtype mode, hit ^@. This inserts a single Space into\nthe text.\n" }, { "name": "Control and Meta characters", "content": "Each character is represented by a number. For example, the number for ´A´ is 65 and the num‐\nber for ´1´ is 49. All of the characters which you normally see have numbers in the range of\n32 - 126 (this particular arbitrary assignment between characters and numbers is called the\nASCII character set). The numbers outside of this range, from 0 to 255, aren´t usually dis‐\nplayed, but sometimes have other special meanings. The number 10, for example, is used for\nthe line-breaks. You can enter these special, non-displayed control characters by first hit‐\nting ^Q and then hitting a character in the range @ A B C ... X Y Z [ ^ ] \\ to get the num‐\nber 0 - 31, and ? to get 127. For example, if you hit ^Q J, you´ll insert a line-break char‐\nacter, or if you hit ^Q I, you´ll insert a Tab character (which does the same thing the Tab\nkey does). A useful control character to enter is 12 (^Q L), which causes most printers to\nadvance to the top of the page. You´ll notice that JOE displays this character as an under‐\nlined L. You can enter the characters above 127, the meta characters, by first hitting ^\\.\nThis adds 128 to the next (possibly control) character entered. JOE displays characters above\n128 in inverse-video. Some foreign languages, which have more letters than English, use the\nmeta characters for the rest of their alphabet. You have to put the editor in asis mode to\nhave these passed untranslated to the terminal.\n\nNote: JOE now normally passes all 8-bits to the terminal unless the locale is set to C or\nPOSIX. If the locale is C or POSIX, then the asis flag determines if meta characters are\nshown in inverse video or passed directly to the terminal.\n\nNote: In older version of JOE, you had to use Esc ´´ to enter control characters.\n" }, { "name": "Character sets and UTF-8", "content": "JOE natively handles two classes of character sets: UTF-8 and byte coded (like ISO-8859-1).\nFor these character sets, the file is loaded as-is into memory, and is exactly preserved dur‐\ning save, even if it contains UTF-8 coding errors.\n\nIt can not yet natively handle other major classes such as UTF-16 or GB2312. There are other\nrestrictions: character sets must use LF (0x0A) or CR-LF (0x0D - 0x0A) as line terminators,\nspace must be 0x20 and tab must be 0x09. Basically, the files must be UNIX or MS-DOS compati‐\nble text files.\n\nThis means EBCDIC will not work properly (but you would need to handle fixed record length\nlines anyway) and character sets which use CR terminated lines (MACs) will not yet work.\n\nJOE now supports UTF-16 (both big endian and little endian). It supports UTF-16 by converting\nto UTF-8 during load, and converting back to UTF-16 during save.\n\nThe terminal and the file can have different encodings. JOE will translate between the two.\nCurrently, one of the two must be UTF-8 for translation to work.\n\nThe character set for the terminal and the default character set assumed for files is deter‐\nmined by the ´LCALL´ environment variable (and if that´s not set, LCCTYPE and LANG are also\nchecked).\n\nFor example, if LCALL is set to:\n\n\n\ndeDE\n\n\n\nThen the character set will be ISO-8859-1.\n\nIf LCALL is set to:\n\n\n\ndeDE.UTF-8\n\n\n\nThe character set will be UTF-8.\n\nHit ^T E to change the coding for the file. Hit Tab Tab at this prompt to get a list of\navailable codings. There are a number of built-in character sets, plus you can install char‐\nacter sets in the ~/.joe/charmaps and /usr/share/joe/charmaps directories.\n\nCheck: /usr/share/i18n/charmaps for example character set files. Only byte oriented character\nsets will work. Also, the file should not be gzipped (all of the charmap files in\n/usr/share/i18n/charmaps on my computer were compressed). The parser is very bad, so basi‐\ncally the file has to look exactly like the example one in /usr/share/joe/charmaps.\n\nYou can hit ^K Space to see the current character set.\n\nYou can hit ^Q x to enter a Unicode character if the file coding is UTF-8.\n" } ] }, "Prompts": { "content": "Most prompts record a history of the responses you give them. You can hit up and down arrow\nto step through these histories.\n\nPrompts are actually single line windows with no status line, so you can use any editing com‐\nmand that you normally use on text within the prompts. The prompt history is actually just\nother lines of the same \"prompt file\". Thus you can can search backwards though the prompt\nhistory with the normal ^K F command if you want.\n\nSince prompts are windows, you can also switch out of them with ^K P and ^K N.\n", "subsections": [ { "name": "Completion and selection menus", "content": "You can hit Tab in just about any prompt to request JOE to complete the word you are typing.\nIf JOE beeps, there are either no completions or many. As with the \"bash\" shell, hit Tab\ntwice to bring up a list of all the possibilities. This list is actually a menu, but by de‐\nfault, the cursor does not jump into it since it is usually easier to just type in your se‐\nlection. You can, however, jump into the menu window with ^K P (move to previous window) and\nuse the arrow keys and to make your selection. Also in a menu, you can hit the first\nletter of any of the items to make the cursor jump directly to it. The ^T option menu works\nlike this.\n\nIf the menu is too large to fit in the window, you can hit Page Up and Page Down to scroll it\n(even if you have not jumped into it).\n\nTab completion works in the search and replace prompts as well. In this case, JOE tries to\ncomplete the word based on the contents of the buffer. If you need search for the Tab charac‐\nter itself, you can enter it with ^Q Tab.\n\nAlso, you can hit Esc Enter in a text window to request JOE to complete the word you are typ‐\ning. As with the search prompt, JOE tries to complete the word based on the contents of the\nbuffer. It will bring up a menu of possibilities if you hit Esc Enter twice.\n" }, { "name": "Where am I?", "content": "Hit ^K Space to have JOE report the line number, column number, and byte number on the last\nline of the screen. The number associated with the character the cursor is on (its ASCII\ncode) is also shown. You can have the line number and/or column number always displayed on\nthe status line by placing the appropriate escape sequences in the status line setup strings.\nEdit the joerc file for details.\n" }, { "name": "What if I hit ^K by accident?", "content": "Hit the space bar. This runs an innocuous command (it shows the line number on the status\nbar).\n" }, { "name": "Temporarily suspending the editor", "content": "If you need to temporarily stop the editor and go back to the shell, hit ^K Z. You might want\nto do this to stop whatever you´re editing and answer an e-mail message or read this man\npage, for example. You have to type fg or exit (you´ll be told which when you hit ^K Z) to\nreturn to the editor.\n" }, { "name": "Searching for text", "content": "Hit ^K F to have the editor search forwards or backwards for a text fragment (string) for\nyou. You will be prompted for the text to search for. After you hit Enter, you are prompted\nto enter options.\nYou can just hit Enter again to have the editor immediately search forwards for the text, or\nyou can enter one or more of these options:\n\n• b\n\n\n\n\nSearch backwards instead of forwards.\n\n• i\n\n\n\n\nTreat uppercase and lower case letters as the same when searching. Normally uppercase and\nlowercase letters are considered to be different.\n\n• nnn\n\n\n\n\n(where nnn is a number) If you enter a number, JOE searches for the Nth occurrence of the\ntext. This is useful for going to specific places in files structured in some regular manner.\n\n• r\n\n\n\n\nReplace text. If you enter the r option, then you will be further prompted for replacement\ntext. Each time the editor finds the search text, you will be prompted as to whether you want\nto replace the found search text with the replacement text. You hit: y to replace the text\nand then find the next occurrence, n to not replace this text, but to then find the next oc‐\ncurrence, r to replace all of the remaining occurrences of the search text in the remainder\nof the file without asking for confirmation (subject to the nnn option above), or ^C to stop\nsearching and replacing.\n\nYou can also hit B or Backspace to back up to the previously found text (if it had been re‐\nplaced, the replacement is undone).\n\n• a\n\n\n\n\nThe search covers all loaded buffers. So to replace all instances of \"foo\" with \"bar\" in all\n.c files in the current directory:\n\n\n\njoe *.c\n^K F\nfoo \nra \nbar \n\n\n\n• e\n\n\n\n\nThe search covers all files in the grep or make error list. You can use a UNIX command to\ngenerate a list of files and search and replace through the list. So to replace all instances\nof \"foo\" with \"bar\" in all .c files which begin with f. You can also use \"ls\" and \"find\" in‐\nstead of grep to create the file list.\n\n\n\nEsc G\ngrep -n foo f*.c \n^K F\nfoo \nre \nbar \n\n\n\n• x\n\n\n\n\nJOE will use the standard syntax for regular expressions if this option is given. In the\nstandard syntax, these characters have their special meanings directly, and do not have to be\nescaped with backslash: ., *, +, ?, {, }, (, ), |, ^, $ and [.\n\n• y\n\n\n\n\nJOE will use the JOE syntax for regular expressions instead of the standard syntax. This\noverrides the \"-regex\" option.\n\n• v\n\n\n\n\nJOE will send debug information about the regular expression to the startup log. The log can\nbe viewed with the showlog command.\n\nYou can hit ^L to repeat the previous search.\n\nYou can hit ^K H at the search and replace options prompt to bring up a list of all search\nand replace options.\n" }, { "name": "Regular Expressions", "content": "A number of special character sequences may be entered as search text:\n\n• \\*\n\n\n\n\nThis finds zero or more of the item to the left. For example, if you give AB\\*C as the search\ntext, JOE will try to find an A followed by any number of Bs, and then a C.\n\n• \\+\n\n\n\n\nThis finds one or more of the item to the left. For example, if you give AB\\+C as the search\ntext, JOE will try to find an A followed by one or more Bs, and then a C.\n\n• \\?\n\n\n\n\nThis indicates that the item to the left is optional. For example, if you give AB\\?C as the\nsearch text, JOE will find AC or ABC.\n\n• \\{min,max}\n\n\n\n\nThis indicates that JOE should try to find a string with a specific number of occurrences of\nthe item to the left. For example, AX\\{2,5}B will match these strings: AXXB, AXXXB, AXXXXB,\nand AXXXXXB. Min can be left out to indicate 0 occurrences. Max (and the comma) can be left\nout to indicate any number of occurrences.\n\n• \\.\n\n\n\n\nThis finds exactly one character. For example, if you give A\\.B as the search text, JOE will\nfind AXB, but not AB or AXXB.\n\n• \\!\n\n\n\n\nThis works like ., but matches a balanced C-language expression. For example, if you search\nfor malloc(\\!\\*), then JOE will find all function calls to malloc, even if there was a )\nwithin the parenthesis.\n\n• \\|\n\n\n\n\nThis finds the item on the left or the item on the right. For example, if you give A\\|B as\nthe search text, JOE will try to find either an A or a B.\n\n• \\( \\)\n\n\n\n\nUse these to group characters together. For example, if you search for \\(foo\\)\\+, then JOE\nwill find strings like \"foo\", and \"foofoofoo\".\n\n• ^ \\$\n\n\n\n\nThese match the beginnings and endings of lines. For example, if you give ^test\\$, then JOE\nwith find test on a line by itself.\n\n• \\\\\\\n\n\n\n\nThese match the beginnings and endings of words. For example, if you give \\is\\\\, then JOE\nwill find the word \"is\" but will not find the \"is\" in \"this\".\n\n• \\[...]\n\n\n\n\nThis matches any single character which appears within the brackets. For example, if \\[Tt]his\nis entered as the search string, then JOE finds both This and this. Ranges of characters can\nbe entered within the brackets. For example, \\[A-Z] finds any uppercase letter. If the first\ncharacter given in the brackets is ^, then JOE tries to find any character not given in the\nthe brackets. To include - itself, include it as the last or first character (possibly after\n^).\n\n• \\\\\n\n\n\n\nMatches a single \\.\n\n• \\n\n\n\n\n\nThis finds the special end-of-line or line-break character.\n\nA number of special character sequences may also be given in the replacement string:\n\n• \\&\n\n\n\n\nThis gets replaced by the text which matched the search string. For example, if the search\nstring was \\\\*\\\\, which matches words, and you give \"\\&\", then JOE will put quote marks\naround words.\n\n• \\1 - \\9\n\n\n\n\nThese get replaced with the text which matched the Nth grouping; the text within the Nth set\nof \\( \\).\n\n• \\l, \\u\n\n\n\n\nConvert the next character of the replacement text to lowercase or uppercase.\n\n• \\L, \\U\n\n\n\n\nConvert all following replacement text to lowercase or uppercase. Conversion stops when \\E is\nencountered.\n\n• \\\\\n\n\n\n\nUse this if you need to put a \\ in the replacement string.\n\n• \\n\n\n\n\n\nUse this if you need to put a line-break in the replacement string.\n\nSome examples:\n\nSuppose you have a list of addresses, each on a separate line, which starts with \"Address:\"\nand has each element separated by commas. Like so:\n\nAddress: S. Holmes, 221b Baker St., London, England\n\nIf you wanted to rearrange the list, to get the country first, then the city, then the per‐\nson´s name, and then the address, you could do this:\n\nType ^K F to start the search, and type:\n\nAddress:\\(\\.\\*\\),\\(\\.\\*\\),\\(\\.\\*\\),\\(\\.\\*\\)\\$\n\nto match \"Address:\", the four comma-separated elements, and then the end of the line. When\nasked for options, you would type r to replace the string, and then type:\n" }, { "name": "Address:\\4,\\3,\\1,\\2", "content": "To shuffle the information the way you want it. After hitting return, the search would begin,\nand the sample line would be changed to:\n\nAddress: England, London, S. Holmes, 221b Baker St.\n" }, { "name": "Escape sequences", "content": "JOE understands the following escape sequences withing search and replacement strings:\n\n• \\x{10ffff}\n\n\n\n\nThis matches a specific Unicode code point given in hexadecimal.\n\n• \\xFF\n\n\n\n\nThis matches a specific character specified in hexadecimal.\n\n• \\377\n\n\n\n\nThis matches a specific character specified in octal.\n\n• \\p{Ll}\n\n\n\n\nThis matches any character in the named Unicode category or block.\n\nThe block names, such as \"Latin-1 Supplement\" or \"Arabic\" can be found here:\n\nUnicode Blocks ftp://ftp.unicode.org/Public/8.0.0/ucd/Blocks.txt\n\nThe category names such as \"Ll\" can be found here:\n\nUnicode Categories ftp://ftp.unicode.org/Public/5.1.0/ucd/UCD.html#GeneralCategoryValues\n\nNote that a single letter matches all of the category names which start with that letter. For\nexample, \\p{N} (any number) include \\p{Nd} (decimal digit), \\p{Nl} (letter number) and \\p{No}\n(other number).\n\n• \\d\n\n\n\n\nThis matches any Unicode digit. This is the same as \\p{Nd}.\n\n• \\D\n\n\n\n\nThis matches anything except for a Unicode digit. This is the same as \\[^\\p{Nd}].\n\n• \\w\n\n\n\n\nThis matches any word character. This is the same as \\[^\\p{C}\\p{P}\\p{Z}].\n\n• \\W\n\n\n\n\nThis matches anything except for a word character. This is the same as \\[\\p{C}\\p{P}\\p{Z}].\n\n• \\s\n\n\n\n\nThis matches any space character. This is the same as \\[\\t\\r\\f\\n\\p{Z}].\n\n• \\S\n\n\n\n\nThis matches anything except for a spacing character. This is the same as \\[^\\t\\r\\f\\n\\p{Z}].\n\n• \\i\n\n\n\n\nThis matches an identifier start character. This is the same as \\[\\p{L}\\p{Pc}\\p{Nl}].\n\n• \\I\n\n\n\n\nThis matches anything except for an identifier start character. This is the same as\n\\[^\\p{L}\\p{Pc}\\p{Nl}].\n\n• \\c\n\n\n\n\nThis matches an identifier continuation character. This is the same as\n\\[\\i\\p{Mn}\\p{Mc}\\p{Nd}\\x{200c}\\x{200d}].\n\n• \\C\n\n\n\n\nThis matches anything except for an identifier continuation character. This is the same as\n\\[^\\i\\p{Mn}\\p{Mc}\\p{Nd}\\x{200c}\\x{200d}].\n\n• \\t Tab\n\n• \\n Newline\n\n• \\r Carriage return\n\n• \\b Backspace\n\n• \\a Alert\n\n• \\f Formfeed\n\n• \\e Escape\n\n• \\\\ Backslash\n\n\n" }, { "name": "Incremental search", "content": "Use Esc S to start an increment search forwards, or Esc R to start an incremental search\nbackwards. As you type the search string, the cursor will jump to the first text that matches\nthe regular expression you have entered so far.\n\nHit Esc S or Esc R again to find the next occurrence of the text or to switch the direction\nof the search.\n\n^S, ^\\ and ^L have the same effect as Esc S. ^R has the same effect as Esc R. These keys are\nto support JMACS.\n\nHit Backspace to undo the last incremental search action. The last action could be a repeat\nof a previous search or the entering of a new character.\n\nUse ^Q to insert control characters into the search text. Previously, ` could also be used\nfor this.\n\nHit any other key to exit the increment search.\n" }, { "name": "Goto matching delimiter", "content": "Hit ^G to jump between matching delimiters. This works on both character delimiters (like ´(´\nand ´)´) and word delimiters for languages like Pascal and Verilog which use \"begin\" and\n\"end\" to delimit blocks. It also works for matching start and end tags in XML. If a word is\nnot known, ^G starts a search with the word moved into the search prompt.\n\nFor ^G to work on word delimiters, the cursor must be positioned on the first letter of the\nword. So in XML, if the cursor is on the < in , it will jump to the >. But if it is one\nthe ´f´, it will jump to the matching . Likewise, in C, ^G will jump between #if, #else\nand #endif, but you need to position the cursor on the letter, not the ´#´.\n\n^G is smart enough to skip delimiters found in quoted or commented-out matter. You need to\ntell JOE how your language indicates this: see the ftyperc file for examples of how this is\ndone.\n\nThe are a number of options which control the behavior of ^G. These options control which\nkinds of comments ^G can skip over:\n\n• ccomment\n\n• cppcomment\n\n• pountcomment\n\n• semicomment\n\n• vhdlcomment\n\n\n\nThese options determine which kinds of strings ^G can skip over:\n\n• singlequoted\n\n• doublequoted\n\n\n\nThis option allows an annotated syntax file to determine which text can be counted as com‐\nments or strings which can be skipped over by ^G:\n\n• highlightercontext\n\n\n\nThis option enables the use of syntax files to identify comments and strings which should be\nskipped over during ^G matching. The syntax file states should be annotated with the string\nand comment keywords for this to work.\n\n• textdelimiters\n\n\n\nThis option provides a list of word delimiters to match. For example, \"be‐\ngin=end:if=elif=else=endif\" means that ^G will jump between the matching if, elif, else and\nendif. It will also jump between begin and end.\n\n^G has a built-in table for matching character delimiters- it knows that ( goes with ).\n\n^G has a built-in parser to handle start/end tag matching for XML.\n" } ] }, "Regions": { "content": "If you want to move, copy, save or delete a specific section of text, you can do it with\nhighlighted blocks. First, move the cursor to the start of the section of text you want to\nwork on, and press ^K B. Then move the cursor to the character just after the end of the text\nyou want to affect and press ^K K. The text between the ^K B and ^K K should become high‐\nlighted. Now you can move your cursor to someplace else in your document and press ^K M to\nmove the highlighted text there.\nYou can press ^K C to make a copy of the highlighted text and insert it to where the cursor\nis positioned. ^K Y to deletes the highlighted text. ^K W, writes the highlighted text to a\nfile.\n\nA very useful command is ^K /, which filters a block of text through a UNIX command. For ex‐\nample, if you select a list of words with ^K B and ^K K, and then type ^K / sort, the list of\nwords will be sorted. Another useful UNIX command for ^K /, is tr. If you type ^K / tr a-z\nA-Z, then all of the letters in the highlighted block will be converted to uppercase.\n", "subsections": [ { "name": "How do I deselect a highlighted region?", "content": "After you are finished with some region operations, you can just leave the highlighting on if\nyou don´t mind it (but don´t accidentally hit ^K Y). If it really bothers you, however, just\nhit ^K B ^K K, to turn the highlighting off.\n\nBeginning with JOE 4.2, you can hit ^C to cancel the region selection.\n" }, { "name": "New ways of selecting regions", "content": "The classic way is to hit ^K B at the beginning and ^K K at the end. These set pointers\ncalled markb and markk. Once these are set you can jump to markb with Esc B and jump to markk\nwith Esc K.\n\nNew way: hit Ctrl-Right Arrow to start selecting rightward. Each time you hit Ctrl-Right Ar‐‐\nrow, the block is extended one more to the right. This uses a simple macro: \"beginmark‐\ning,rtarw,togglemarking\".\n\nUnfortunately, there is no standard way to get the keysequence given by the terminal emulator\nwhen you hit Ctrl-Right Arrow. Instead you have to determine this sequence yourself and enter\nit directly in the joerc file. Some examples are given for Xterm and gnome-terminal. Hit ^Q\nCtrl-Right Arrow within JOE to have the sequence shown on your screen. Note that Putty uses\nEsc Esc [ C which will not appear with ^Q Right Arrow (also Esc Esc is the set bookmark com‐\nmand, so you need to unbind it to do this in Putty).\n\nAlso you can hit Ctrl-Delete to cut and Ctrl-Insert to paste if the sequence for these keys\nare known.\n\nThe mouse can also be used to select text if mouse support is enabled in JOE.\n" }, { "name": "Indenting program blocks", "content": "Auto-indent mode is toggled with the ^T I command. The joerc file is normally set up so that\nfiles with names ending with .p, .c or .h have auto-indent mode enabled. When auto-indent\nmode is enabled and you hit Enter, the cursor will be placed in the same column that the\nfirst non-whitespace character was on in the original line.\n\nYou can use the ^K , and ^K . commands to shift a block of text to the left or right. If no\nhighlighting is set when you give these commands, the program block (as indicated by indenta‐\ntion) that the cursor is located in will be selected, and will be moved by subsequent ^K ,\nand ^K . commands.\n\nThe number of columns these commands shift by and the character used for shifting can be set\nthrough the istep and indentc options. These options are available in the ^T menu. Also, ^T =\ncan be used to quickly select from a number of common values for indentation step and charac‐\nter.\n\nJOE has a number of additional options related to indenting programs:\n\n• smartbacks\nEnable smart backspace and tab. When this mode is set Backspace and Tab indent or unin‐\ndent based on the values of the istep and indentc options.\n\n\n• smarthome\nThe Home and ^A keys first move the cursor to the beginning of the line, then if hit\nagain, to the first non-blank character.\n\n\n• indentfirst\nSmart home goes to first non-blank character first, instead of going to the beginning of\nthe line first.\n\n\n• purify\nFix indentation if necessary before shifting or smart backspace. For example, if indenta‐\ntion uses a mix of tabs and spaces, and indentc is space, then indentation will be con‐\nverted to all spaces before the shifting operation.\n\n\n• guessindent\nWhen set, JOE tries to guess the indentation character and indentation step based on the\ncontents of the file. The algorithm is to find the greatest common factor of the three\nmost common indentations found in the file.\n\n\n\n" }, { "name": "Rectangle mode", "content": "Type ^T X to have ^K B and ^K K select rectangular blocks instead of stream-of-text blocks.\nThis is also known as columnar mode. This mode is useful for moving, copying, deleting or\nsaving columns of text. You can also filter columns of text with the ^K / command- if you\nwant to sort a column, for example. The insert file command, ^K R is also affected.\n\nWhen rectangle mode is selected, overtype mode is also useful (^T T). When overtype mode is\nselected, rectangles will replace existing text instead of getting inserted before it. Also\nthe delete block command (^K Y) will clear the selected rectangle with Spaces and Tabs in‐\nstead of deleting it. Overtype mode is especially useful for the filter block command (^K /),\nsince it will maintain the original width of the selected column.\n" }, { "name": "Picture mode", "content": "Use ^T P to enter or exit picture mode. Picture mode helps with ASCII drawings.\n\nPicture mode controls how JOE handles the case where the cursor is past the ends of lines.\nThis happens when you use the up or down arrow keys to move the cursor from the end of a long\nline to a short line.\n\nIf you attempt to type a character in this case:\n\nIf picture mode is off, the cursor will jump to the end of the line and insert it there.\n\nIf picture mode is on, the line is filled with spaces so that the character can be inserted\nat the cursor position.\n" } ] }, "Windows": { "content": "You can edit more than one file at the same time or edit two or more different places of the\nsame file. To do this, hit ^K O, to split the screen into two windows. Use ^K P or ^K N to\nmove the cursor into the top window or the lower window. Use ^K E to edit a new file in one\nof the windows. A window will go away when you save the file with ^K X or abort the file with\n^C. If you abort a file which exists in two windows, one of the window goes away, not the\nfile.\n\nYou can hit ^K O within a window to create even more windows. If you have too many windows on\nthe screen, but you don´t want to eliminate them, you can hit ^K I. This will show only the\nwindow the cursor is in, or if there was only one window on the screen to begin with, try to\nfit all hidden windows on the screen. If there are more windows than can fit on the screen,\nyou can hit ^K N on the bottom-most window or ^K P on the top-most window to get to them.\n\nIf you gave more than one file name to JOE on the command line, each file will be placed in a\ndifferent window.\n\nYou can change the height of the windows with the ^K G and ^K T commands.\n", "subsections": [ { "name": "Windowing system model", "content": "JOE has an unusual model for its windowing system. Basically you have a ring of windows, but\nonly a section of this ring may fit on the screen. The windows not on the screen still exist,\nthey are just scrolled off. When you hit ^K N on the bottom window of the screen, it scrolls\nfurther windows from the ring onto the screen, possibly letting the top window scroll out of\nview.\n\nNative JOE tries to keep each loaded buffer in a window, so users can find all of the buffers\nby scrolling through the windows. The explode command (^K I) either expands all windows to\nthe size of the screen so that only one window can fit on the screen, or shrinks them all as\nmuch as possible to fit many on the screen.\n\nOn the other hand, JOE supports \"orphan\" buffers- files loaded into the editor, but which are\nnot in a window. ^C normally closes a window and discards the buffer that was in it. If you\nhit ^C on the last remaining window, it will normally exit the editor. However, if there are\norphan buffers, ^C will instead load them into this final window to give you a chance to ex‐\nplicitly discard them. If the orphan option is given on the command line, as in joe -orphan\n*.c, then JOE only loads the first file into a window and leaves all the rest as orphans.\n\norphan also controls whether the edit command ^K E creates a new window for a newly loaded\nfile, or reuses the current window (orphaning its previous occupant).\n\nThe bufed command prompts for a name of a buffer to switch into a window. Its completion list\nwill show all buffers, including orphans and buffers which appear in other windows. Esc V and\nEsc U (nbuf and pbuf commands) allow you to cycle through all buffers within a single window.\n\nWindows maintain a stack of occupants to support the pop-up shell window feature. When a\npop-up window is dismissed, the previous buffer is returned to the window.\n" }, { "name": "Scratch buffers", "content": "Scratch buffers are buffers which JOE does not worry about trying to preserve. JOE will not\nask to save modified scratch buffers. Pop-up shell windows, the startup log and compile and\ngrep message windows are scratch buffers. You can create your own scratch buffer with the\nscratch command.\n\nThe following commands load scratch buffers:\n\n• showlog Show startup log\n\n• mwind Show message window (compile / grep messages from Esc C and Esc G commands).\n\n\n" }, { "name": "Keyboard macros", "content": "Macros allow you to record a series of keystrokes and replay them with the press of two keys.\nThis is useful to automate repetitive tasks. To start a macro recording, hit ^K [ followed by\na number from 0 to 9. The status line will display (Macro n recording...). Now, type in the\nseries of keystrokes that you want to be able to repeat. The commands you type will have\ntheir usual effects. Hit ^K ] to stop recording the macro. Hit ^K followed by the number you\nrecorded the macro in to execute one iteration of the key-strokes.\n\nFor example, if you want to put \"\" in front of a number of lines, you can type:\n\n^K [ 0 ^A down arrow\\ ^K ]\n\nWhich starts the macro recording, moves the cursor to the beginning of the line, inserts\n\"\", moves the cursor down one line, and then ends the recording. Since we included the\nkey-strokes needed to position the cursor on the next line, we can repeatedly use this macro\nwithout having to move the cursor ourselves, something you should always keep in mind when\nrecording a macro.\n" }, { "name": "Keyboard macro subroutines", "content": "If you find that the macro you are recording itself has a repeated set of key-strokes in it,\nyou can record a macro within the macro, as long as you use a different macro number. Also\nyou can execute previously recorded macros from within new macros.\n" }, { "name": "Query suspend", "content": "If your macro includes a prompt for user input, and you want the user to fill in the prompt\nevery time the macro is executed, hit ^K ? at the point in the macro recording where the user\naction is required. Keyboard input will not be recorded at this point. When the user com‐\npletes the prompt, macro recording will continue.\n\nWhen the macro is executed, the macro player will pause at the point where ^K ? was entered\nto allow user input. When the user completes the prompt, the player continues with the rest\nof the macro.\n" }, { "name": "Repeat", "content": "You can use the repeat command, ^K \\, to repeat a macro, or any other edit command or even a\nnormal character, a specified number of times. Hit ^K \\, type in the number of times you want\nthe command repeated and press Enter. The next edit command you now give will be repeated\nthat many times. For example, to delete the next 20 lines of text, type:\n\n^K \\ 20return^Y\n" }, { "name": "Macros and commands", "content": "A macro is a comma separated list of commands. When the macro is executed, each command is\nexecuted until either the end of the list is reached, or one of the commands fails (non-zero\nreturn value from the command). Failed commands beep if you have beeps enabled (^T B).\n\nHit Esc D to insert the current set of keyboard macros as text into the current buffer. For\nexample, the \"\" insert macro above looks like this:\n\n\n\nhome,\"\",dnarw ^K 0 Macro 0\n\n\n\nYou could insert this into your .joerc file and change the key sequence (the K 0) to some‐\nthing more permanent.\n" }, { "name": "Define your own", "content": "You can bind macros to key sequences or define your own named macros in the joerc file. For\nexample, this will define a macro called foo:\n\n\n\n:def foo eof,bol\n\n\n\nfoo will position the cursor at the beginning of the last line of the file. eof jumps to the\nend of the file. bol jumps to the beginning of a line. Once a macro has been named this way\nit will show up in the completion list of the Esc X command prompt.\n" }, { "name": "Command prompt", "content": "You can execute a macro directly by typing it into the command prompt. Hit Esc X to bring up\nthe command prompt. Hit Tab at this prompt for a completion list of all available commands.\n\nHere is a complete list of commands.\n\nMacro don´´t stop modifier\nSometimes, you expect commands to sometimes fail, but want the rest of the commands in the\nlist to be executed anyway. To mark a command which is allowed to fail, postfix it with ´!´.\nFor example, here a macro which hits down page in the window above:\n\n\n\nprevw,pgdn!,nextw\n\n\n\nIf prevw fails, the macro is aborted as usual. Even if pgdn fails (already at end of buffer),\nnextw will be executed so that the cursor is returned to the original window.\n" }, { "name": "Macro repeat argument modifiers", "content": "Repeat arguments can be specified with ^K \\. When a command is executed with a repeat argu‐\nment, it is repeatedly executed the specified number of times. If the repeat argument is neg‐\native, an opposite command (if one exists) is executed instead. For example, if you repeat\n\"rtarw\" -3 times, \"ltarw\" will be repeated 3 times. If a negative argument is given for a\ncommand which does not have an opposite, the repeat argument is ignored.\n\nNormally, if a repeat argument is specified for a macro, the macro is simply repeated the\ngiven number of times. If a negative argument is given, the argument is ignored.\n\nSometimes you want to allow negative arguments for macros and have their behavior modified.\nTo do this, postfix each command within the macro which should be switched to its opposite\nfor negative arguments with ´-´. For example, here is the page down other window macro:\n\n\n\nprevw,pgdn-!,nextw\n\n\n\nNow if you execute this with an argument of -2, it will be repeated twice, but pgup will be\nexecuted instead of pgdn. (note that several postfix modifiers can be placed after each com‐\nmand).\n\nSometimes when a repeat argument is given to macro, you want only one of the commands in the\nlist to be repeated, not the entire macro. This can be indicated as follows:\n\n\n\nprevw,pgdn#!,nextw\n\n\n\nIf this is executed with an argument of 2, prevw is executed once, pgdn is executed twice,\nand nextw is executed once.\n\nFinally, even more complex semantics can be expressed with the \"if\" command:\n\n\n\nif~,\"arg<0\",then,\nltarw,\nelse,\nrtarw,\nendif\n\n\n\nWhen the macro is executed, the \"arg\" math variable is set to the given repeat argument. The\n\"argset\" variable is set to true if the user set an argument, even if it´s 1. If no argument\nwas given, argset is false.\n\nIf any command in the list is postfixed with ~ (if above), the macro is not repeated, even if\nthere is an argument. ´arg´ is still set to the given repeat count, however.\n\n´´psh´´/´´query´´ interaction\nThe ´psh´ command saves the ^K B and ^K K positions on a stack. When the macro completes, (or\nwhen the ´pop´ command is called) the positions are restored.\n\nThe ´query´ command suspends macro execution until the current dialog is complete. It also\nsuspends the automatic ´pop´ which happens at the end of a macro- so if the macro ends in a\ndialog you often want to call ´query´ to prevent the ^K B ^K K positions from being restored\ntoo early.\n" }, { "name": "Tags search", "content": "If you are editing a large C program with many source files, you can use the ctags program to\ngenerate a tags file. This file contains a list of program symbols and the files and posi‐\ntions where the symbols are defined.\n\nFirst, create the tags file with the \"ctags\" program. For example:\n\n\n\nctags *.c *.h\n\n\n\nThis will create a file called \"tags\" in the current directory.\n\nJOE looks for the \"tags\" file in the current directory. If there is none, it will try to open\nthe file specified by the TAGS environment variable.\n\nPaths in the tags file are always relative to location of the tags file itself.\n\nThe tags file contains a list of identifier definition locations in one of these formats:\n\n\n\nidentifier filename /search-expression/[;comments]\n\nidentifier filename ?search-expression?[;comments]\n\nidentifier filename line-number[;comments]\n\n\n\nSome versions of ctags include class-names in the identifiers:\n\n\n\nclass::member\n\n\n\nIn this case, JOE will match on any of these strings:\n\n\n\nmember\n::member\nclass::member\n\n\n\nSome versions of ctags include a filename in the identifier:\n\n\n\nfilename:identifier\n\n\n\nIn this case JOE will only find the identifier if the buffer name matches the filename.\n\nThe search-expression is a vi regular expression, but JOE only supports the following special\ncharacters:\n\n\n\n^ at the beginning means expression starts at beginning of line\n\n$ at the end means expression ends at end of line\n\n\\x quote x (suppress meaning of /, ?, ^ or $)\n\n\n\nType ^K ; to bring up a tags search prompt. If the cursor had been on an identifier, the\nprompt is pre-loaded with it. Tab completion works in this prompt (it uses the tags file to\nfind completions).\n\nWhen you hit Enter, the tags search commences:\n\nIf there is one and only one match, JOE will jump directly to the definition.\n\nIf there are multiple matches, then the behavior is controlled by the notagsmenu option. If\nnotagsmenu is enabled JOE jumps to the first definition. If you hit ^K ; again before hitting\nany other keys, JOE jumps to the next definition, and so on. The \"tagjump\" command also per‐\nforms this function.\n\nIf notagsmenu is disabled, JOE brings up a menu of all the matches. You select the one you\nwant and JOE jumps to it. If you hit ^K ; again before hitting any other keys, the same menu\nre-appears with the cursor left in the original location.\n\nYou can hit ^K - to move the cursor back to the original location before the tags search (of‐\nten ^C will work as well).\n\nSince ^K ; loads the definition file into the current window, you probably want to split the\nwindow first with ^K O, to have both the original file and the definition file loaded.\n" } ] }, "Calculator": { "content": "JOE has a built-in calculator which can be invoked with Esc M.\n", "subsections": [ { "name": "Math functions", "content": "sin, cos, tan, exp, sqrt, cbrt, ln, log, asin, acos, atan, sinh, cosh, tanh, asinh, acosh,\natanh, int, floor, ceil, abs, erf, erfc, j0, j1, y0, y1\n" }, { "name": "Variables", "content": "• e\nSet to ´e´\n\n\n• pi\nSet to ´pi´\n\n\n• top\nSet to line number of top window line\n\n\n• lines\nSet to number of lines in file\n\n\n• line\nSet to current line number\n\n\n• col\nSet to current column number\n\n\n• byte\nSet to current byte number\n\n\n• size\nSet to buffer size\n\n\n• height\nSet to window height\n\n\n• width\nSet to window width\n\n\n• char\nSet to ASCII val of character under cursor\n\n\n• markv\nTrue if there is a valid block set (^KB ... ^KK)\n\n\n• rdonly\nTrue if file is read-only\n\n\n• arg\nCurrent repeat argument\n\n\n• argset\nTrue if a repeat argument was given\n\n\n• isshell\nTrue if executed in an active shell window\n\n\n• nowindows\nNo. buffer windows on the screen\n\n\n• ans\nResult of previous expression\n\n\n\n" }, { "name": "Commands", "content": "• hex\nHex display mode\n\n\n• dec\nDecimal display mode\n\n\n• ins\nInsert ´ans´ into buffer\n\n\n• sum\nSum of numbers in block\n\n\n• cnt\nCount numbers in block\n\n\n• avg\nAverage value of numbers in block\n\n\n• dev\nStandard deviation of numbers in block\n\n\n• eval\nEvaluate math expressions in block (or whole file if no block set).\n\n\n• joe(...)\nExecute a JOE macro (argument in same format as joerc file macros). Return value of JOE\nmacro is returned (for macro success, return true (non-zero)).\n\n\n\n\nFor example:\n\n\n\njoe(sys,\"[ 1 == 1 ]\",rtn)\n\n\n\n([ 1 == 1 ]) is a shell command. \"[\" is a synonym for the \"test\" UNIX command.\n\nReturns true.\n\nRemember: argument for JOE macro command \"if\" is a math expression. So for example, the\nmacro:\n\n\n\nif,\"joe(sys,\\\"[ 1 == 1 ]\\\",rtn)\",then,\"TRUE\",endif\n\n\n\nTypes TRUE into the buffer.\n" }, { "name": "Operators:", "content": "• !x\nLogical not of x.\n\n\n• x\nRaise x to power of y.\n\n\n• a*b\nMultiply.\n\n\n• a/b\nDivide.\n\n\n• a%b\nModulus.\n\n\n• a+b\nAdd.\n\n\n• a-b\nSubtract.\n\n\n• ab\nTrue if a is greater than b.\n\n\n• a>=b\nTrue if a is greater than or equal to b.\n\n\n• a==b\nTrue if a equals b.\n\n\n• a!=b\nTrue if a does not equal b.\n\n\n• a&&b\nTrue if both a and b are true.\n\n\n• a||b\nTrue if ether a or b are true.\n\n\n• a?b:c\nIf a is true return b, otherwise return c.\n\n\n• a=b\nAssign b to a.\n\n\n• a:b\nExecute a, then execute b.\n\n\n\n\n&&, || and ? : work as in C and sh as far as side effects: if the\n\nleft side of && is false, the right side is not evaluated.\nis expression separator.\n" }, { "name": "Shell windows", "content": "Hit ^K ´´ to run a command shell in one of JOE´s windows. When the cursor is at the end of a\nshell window (use ^K V if it´s not), whatever you type is passed to the shell instead of the\nbuffer. Any output from the shell or from commands executed in the shell is appended to the\nshell window (the cursor will follow this output if it´s at the end of the shell window).\nThis command is useful for recording the results of shell commands- for example the output of\nmake, the result of grepping a set of files for a string, or directory listings from FTP ses‐\nsions. Besides typeable characters, the keys ^C, Backspace, Del, Return and ^D are passed to\nthe shell. Type the shell exit command to stop recording shell output. If you press ^C in a\nshell window, when the cursor is not at the end of the window, the shell is killed.\n\nIf you use Bash, you can hit: ^Q Up Arrow and ^Q Down Arrow to scroll through Bash´s history\nbuffer. Other keys work as well: try ^Q ^A to go to beginning of line or ^Q ^E to go to end\nof line. Unfortunately JOE only emulates a dumb terminal, so you have to use a lot of imagi‐\nnation to do any editing beyond hitting backspace.\n\nIn general, any character quoted with ^Q is sent to the shell.\n\nAlso sent to the shell: Tab, Backspace, Enter, ^C and ^D.\n" }, { "name": "Pop-up shell windows", "content": "Hit F1 - F4 to open and switch between shell windows.\n\nPop-up shell windows use a full terminal emulator so that when you type \"man ls\" it´s format‐\nted correctly (it works well enough so that some interactive programs can be used). Even so,\nthe shell window is still an edit buffer.\n\nThe old shell window (with no terminal emulation) still exists: use ^K ´´ to invoke it as\nusual. This is useful to see control sequences emitted by a program.\n\nMore of the keys get passed to the running program in pop-up shell windows compared with the\nolder one. There is a :vtshell section of the joerc file to control which ones. In particular\narrow keys and Ctrl-C are passed to the program. It means you can easily step through bash\nhistory with the arrow keys, or abort programs the normal way with Ctrl-C.\n\nOn the other hand, loss of Ctrl-C means it´s less obvious how to close the window. One way is\nto move the cursor off of the shell data entry point (with Ctrl-P), and then hit Ctrl-C. An‐\nother is to hit ^K Q. Finally, you can type ´pop´ at the command prompt.\n\nIf you need to pass a key to the shell that JOE normally uses, quote it. For example, if you\ninvoke \"emacs -nw\" in the shell window, you can exit it with:\n\n\n\n^Q ^X ^C\n\n\n\nTo quickly position the cursor back to the point where data is entered into the shell, hit ^K\nV.\n\nWhen you open a shell window, a JOE-specific startup-script is sourced. It´s located in\n/etc/joe/shell.sh (also /etc/joe/shell.csh). It contains some aliases which allow you to con‐\ntrol JOE with fake shell commands. I have these commands so far:\n\n• clear\nerase shell window (delete buffer contents)\n\n\n• joe file\nedit a file in JOE\n\n\n• math 1+2\nevaluate equation using JOE´s calculator\n\n\n• cd xyz\nchange directory, keep JOE up to date\n\n\n• markb\nsame as ^KB\n\n\n• markk\nsame as ^KK\n\n\n• mark command\nexecute shell command, mark it´s output\n\n\n• parse command\nexecute shell command, parse it´s output for file names and line numbers (for find or\ngrep)\n\n\n• parser comman\nexecute shell command, parse it´s output for errors (for gcc)\n\n\n• release\nrelease parsed errors\n\n\n• pop\ndismiss shell window (same as ^K Q)\n\n\n\n\nThese work by emitting an escape sequence recognized by the terminal emulator: Esc {\njoemacro }. When this is received, the macro is executed. For security, only macros defined\nin the joerc file which begin with \"shell\" can be executed this way.\n" }, { "name": "Use cases", "content": "Pop-up shell windows have a number of nice use cases:\n\n• Use it to browse manual pages\n\nHit F1 and type \"man fopen\". Use ´b´ (´u´) and space to control more (or less) while\nviewing the manual. You can leave the manual on the screen in one window while editing in\nanother window.\n\n• Use it to switch directories\n\nHit F1 and navigate to the directory while using cd. Once you are in the right place, hit\n^K E to load a file (or type \"edit file\" from the shell).\n\n• Use it in conjunction with the error parser to find files\n\nHit F1 and navigate to a directory. Use grep or find (or both) to generate a list of\nfiles):\n\n\n\n\n\nparse grep -n FIXME *.c\n\n\n\nOr:\n\n\n\nmarkb; find . | xargs grep -n FIXME; markk; parse\n\n\n\n(Note that you can´t say this:\n\n\n\nparse find . | xargs grep -n FIXME\n\n\n\n...the issue is that only the words to the left of the pipe symbol are passed as arguments to\nthe parse command).\n\nNow use ^P to position the cursor on one of the lines of the list. Hit Esc Space to have JOE\nedit the file and jump to the specified line (also you can use Esc - and Esc = to step\nthrough the list).\n\n• Use it in conjunction with search and replace to edit many files\n\nOnce JOE has a list of files (from above), use search and replace with the ´e´ option to\nvisit all of them:\n\n\n\n\n\n^K F\nFind: \nOptions: re\nReplace: \n\n\n\n• Build your project\n\n\n\nEasily capture errors from a build with:\n\n\n\nparserr make\n\n\n\nHit Esc = and Esc - to step through the errors.\n" }, { "name": "How it works..", "content": "• There is a new mode \"ansi\". (Esc X mode ansi). When this mode is enabled, the screen up‐\ndater hides escape sequences which are in the buffer. Otherwise you get a big mess from\nthe sequences surrounding colored output from ´ls´.\n\n• There is a new built-in syntax: \"ansi\". (^T Y ansi). This syntax parses the ANSI color\ncontrol sequences so that text gets colored.\n\n• There is a terminal emulator to interpret control sequences from the shell program. It\nemulates a terminal by modifying the contents of an edit buffer.\n\n• When the edit window is resized we tell the shell by issuing the TIOCSSIZE or TIOCSWINSZ\nioctl. This way, the program running in the shell knows the window size.\n\n\n" }, { "name": "Compiler and grep/find parsers", "content": "JOE has two parsers which can be used to generate the error list (list of file names / line\nnumbers).\n\nThe \"parserr\" command parses the entire buffer, or if the block is set, just the highighted\nblock for compiler error messages. The messages should be in this format:\n\n\n\n file.name line-number : \n\n\n\nThe file name needs to be made of numbers, letters, ´/´, ´.´ and ´-´. It must have at leat\none ´.´ in it. There needs to be a colon somewhere after the line number. Lines not in this\nformat are ignored.\n\nThe \"gparse´ command parses the entire buffer, or if the block is set, just the highlighted\nblock for a list of filenames or filenames with line numbers from \"grep -n\", \"find\" and simi‐\nlar programs.\n\n\n\nfilename\n\nfilename:\n\nfilename:line-number:\n\n\n\nOnce JOE has the error list, there are a number of things you can do with it:\n\n• Visit the files/locations in the list with Esc - and Esc =\n\n• Search and replace across all files in the list by using the ´e´ search and replace op‐\ntion.\n\n• Clear the list by using the \"release\" command.\n\n\n\nAlso, you can use Esc Space (´jump´ command) to parse the line the cursor is on and jump to\nthe parsed filename and line number. ´jump´ uses the grep/find parser unless ´parserr´ had\nbeen previously issued in the buffer.\n" }, { "name": "Grep-find", "content": "Hit Esc G to bring up the prompt. Enter a command which results in file names with line num‐\nbers, for example: ´grep -n fred *.c´. This will list all instances of ´fred´ in the *.c\nfiles. You need the ´-n´ to get the line numbers.\n\nNow you can hit Esc Space on one of the lines to jump to the selected file. Also, you can use\nEsc = and Esc - to step through each line.\n" }, { "name": "Compile", "content": "Hit Esc C to save all modified files and then bring up the compile prompt. Enter the command\nyou want to use for the compiler (typically \"make -w\"). The compiler will run in a shell win‐\ndow. When it´s complete, the results are parsed.\n\nThe ´-w´ flag should be given to \"make\" so that it prints messages whenever it changes direc‐\ntories. The message are in this format:\n\n\n\nmake[1]: Entering directory `/home/jhallen/joe-editor-mercurial/joe´\n\n\n\nIf there are any errors or warnings from the compiler you can hit Esc Space on one of the\nlines to jump to the selected file. Also, you can use Esc = and Esc - to step through each\nline.\n" }, { "name": "Syntax highlighting", "content": "To enable highlight use ^T H.\n\nTo select the syntax, use ^T Y. You can hit Tab Tab at the prompt for a completion list.\n\nJOE tries to determine the syntax to use based on the name and contents of the file. The con‐\nfiguration file /etc/joe/ftyperc contains the definitions.\n\nEach syntax is defined by a file located /usr/share/joe/syntax/.\n" }, { "name": "How JOE syntax highlighting works", "content": "from c.jsf http://joe-editor.hg.sourceforge.net/hgweb/joe-editor/joe-editor/file/tip/syn‐\ntax/c.jsf.in, slightly modified\n\nA deterministic state machine that performs lexical analysis of the target language is pro‐\nvided in a syntax file. (This is the \"assembly language\" of syntax highlighting. A separate\nprogram could in principal be used to convert a regular expression NFA syntax into this for‐\nmat).\n\nEach state begins with:\n\n\n\n: \n\n\n\nname\\ is the state´s name.\n\ncolor-name\\ is the color used for characters eaten by the state (really a symbol for a user\ndefinable color).\n\ncontext\\ tells JOE if the current character is part of a comment or a string. This allows JOE\nto skip over comments and strings when matching characters such as parentheses. To use this\nfeature, the highlightercontext option must be applied to the files highlighted by the cor‐\nresponding syntax. To apply the option, add it to ftyperc for those file entries.\n\nThe valid contexts are:\n\n• comment This character is part of a comment. Example: /* comment */\n\n• string This character is part of a string. Examples: \"string\" ´c´ ´string´\n\n\n\nThe comment and string delimiters themselves should be marked with the appropriate context.\nThe context is considered to be part of the color, so the recolor=-N and recolormark options\napply the context to previous characters.\n\nThe first state defined is the initial state.\n\nWithin a state, define transitions (jumps) to other states. Each jump has the form:\n\n\n\n [