mcedit.1.in 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589
  1. .TH MCEDIT 1 "@DATE_OF_MAN_PAGE@" "MC Version @DISTR_VERSION@" "GNU Midnight Commander"
  2. .SH NAME
  3. mcedit \- Internal file editor of GNU Midnight Commander.
  4. .SH USAGE
  5. .B mcedit
  6. [\-bcCdfhstVx?] [+lineno] file
  7. .PP
  8. .B mcedit
  9. [\-bcCdfhstVx?] file:lineno[:]
  10. .SH DESCRIPTION
  11. .LP
  12. mcedit is a link to
  13. .BR mc ,
  14. the main GNU Midnight Commander executable. Executing GNU Midnight
  15. Commander under this name requests staring the internal editor and
  16. opening the
  17. .I file
  18. specified on the command line. The editor is based on the terminal
  19. version of
  20. .B cooledit
  21. \- standalone editor for X Window System.
  22. .SH OPTIONS
  23. .TP
  24. .I "+lineno"
  25. Go to the line specified by number (do not put a space between the
  26. .I "+"
  27. sign and the number).
  28. .TP
  29. .I "\-b"
  30. Force black and white display.
  31. .TP
  32. .I "\-c"
  33. Force ANSI color mode on terminals that don't seem to have color
  34. support.
  35. .TP
  36. .I "\-C <keyword>=<fgcolor>,<bgcolor>,<attributes>:<keyword>= ..."
  37. Specify a different color set. See the
  38. .B Colors
  39. section in mc(1) for more information.
  40. .TP
  41. .I "\-d"
  42. Disable mouse support.
  43. .TP
  44. .I "\-f"
  45. Display the compiled\-in search path for GNU Midnight Commander data
  46. files.
  47. .TP
  48. .I "\-t"
  49. Force using termcap database instead of terminfo. This option is only
  50. applicable if GNU Midnight Commander was compiled with S\-Lang library
  51. with terminfo support.
  52. .TP
  53. .I "\-V"
  54. Display the version of the program.
  55. .TP
  56. .I "\-x"
  57. Force xterm mode. Used when running on xterm\-capable terminals (two
  58. screen modes, and able to send mouse escape sequences).
  59. .SH FEATURES
  60. The internal file editor is a full\-featured full screen editor. It can
  61. edit files up to 64 megabytes. It is possible to edit binary files.
  62. The features it presently supports are: block copy, move, delete, cut,
  63. paste; key for key undo; pull\-down menus; file insertion; macro
  64. commands; regular expression search and replace (and our own
  65. scanf\-printf search and replace); shift\-arrow text highlighting (if
  66. supported by the terminal); insert\-overwrite toggle; word wrap;
  67. autoindent; tunable tab size; syntax highlighting for various file
  68. types; and an option to pipe text blocks through shell commands like
  69. indent and ispell.
  70. .SH KEYS
  71. The editor is easy to use and can be used without learning. The
  72. pull\-down menu is invoked by pressing F9. You can learn other keys from
  73. the menu and from the button bar labels.
  74. .PP
  75. In addition to that, Shift combined with arrows does text highlighting
  76. (if supported by the terminal):
  77. .B Ctrl\-Ins
  78. copies to the file
  79. .BR ~/.cache/mc/mcedit/mcedit.clip ,
  80. .B Shift\-Ins
  81. pastes from
  82. .BR ~/.cache/mc/mcedit/mcedit.clip ,
  83. .B Shift\-Del
  84. cuts to
  85. .BR ~/.cache/mc/mcedit/mcedit.clip ,
  86. and
  87. .B Ctrl\-Del
  88. deletes highlighted text. Mouse highlighting also works on some
  89. terminals. To use the standard mouse support provided by your terminal,
  90. hold the Shift key. Please note that the mouse support in the terminal
  91. doesn't share the clipboard with
  92. .BR mcedit .
  93. .PP
  94. The completion key (usually
  95. .B "Meta\-Tab"
  96. or
  97. .BR "Escape Tab" )
  98. completes the word under the cursor using the words used earlier in the
  99. file.
  100. .PP
  101. To define a macro, press
  102. .B Ctrl\-R
  103. and then type out the keys you want to be executed. Press
  104. .B Ctrl\-R
  105. again when finished. You can then assign the macro to any key you like
  106. by pressing that key. The macro is executed when you press
  107. .B Ctrl\-A
  108. and then the assigned key. The macro is also executed if you press
  109. Meta, Ctrl, or Esc and the assigned key, provided that the key is not
  110. used for any other function. The macro commands are stored in the file
  111. .BR ~/.local/share/mc/mcedit/mcedit.macros .
  112. Do NOT edit this file if you are going to use macros again in the same
  113. editing session, because
  114. .B mcedit
  115. caches macro key defines in memory.
  116. .B mcedit
  117. now overwrites a macro if a macro with the same key already exists,
  118. so you won't have to edit this file. You will also have to restart
  119. other running editors for macros to take effect.
  120. .P
  121. .B F19
  122. will format C, C++, Java or HTML code when it is highlighted. An executable
  123. file called
  124. .B ~/.local/share/mc/mcedit/edit.indent.rc
  125. will be created for you from the default template. Feel free to edit it
  126. if you need.
  127. .PP
  128. .B C\-p
  129. will run ispell on a block of text in a similar way. The script file
  130. will be called
  131. .BR ~/.local/share/mc/mcedit/edit.spell.rc .
  132. .PP
  133. If some keys don't work, you can use
  134. .B Learn Keys
  135. in the
  136. .B Options
  137. menu.
  138. .SH CODE NAVIGATION
  139. .B mcedit
  140. can be used to navigation through code with tags files created by etags
  141. or ctags commands. If there is no file TAGS code navigation would not work.
  142. In example, in case of exuberant\-ctags for C language command will be:
  143. .PP
  144. ctags \-e \-\-language\-force=C \-R ./
  145. .PP
  146. .B Meta\-Enter
  147. show list box to select item under cursor (cusor should stand at end of
  148. word).
  149. .PP
  150. .B Meta\-Minus
  151. where minus is symbol "\-" go to previous function in navigation list (like a browser
  152. Back).
  153. .PP
  154. .B Meta\-Equal
  155. where equal is symbol "=" go to next function in navigation list (like a browser
  156. Forward).
  157. .PP
  158. .SH SYNTAX HIGHLIGHTING
  159. .B mcedit
  160. supports syntax highlighting. This means that keywords and contexts
  161. (like C comments, string constants, etc) are highlighted in different
  162. colors. The following section explains the format of the file
  163. .BR ~/.local/share/mc/mcedit/Syntax .
  164. If this file is missing, system\-wide
  165. .B @prefix@/share/mc/syntax/Syntax
  166. is used.
  167. The file
  168. .B ~/.local/share/mc/mcedit/Syntax
  169. is rescanned on opening of a any new editor file. The file contains
  170. rules for highlighting, each of which is given on a separate line, and
  171. define which keywords will be highlighted to what color.
  172. .PP
  173. The file is divided into sections, each beginning with a line with the
  174. .B file
  175. command. The sections are normally put into separate files using the
  176. .B include
  177. command.
  178. .PP
  179. The
  180. .B file
  181. command has three arguments. The first argument is a regular expression
  182. that is applied to the file name to determine if the following section
  183. applies to the file. The second argument is the description of the file
  184. type. It is used in
  185. .BR cooledit ;
  186. future versions of
  187. .B mcedit
  188. may use it as well. The third optional argument is a regular expression
  189. to match the first line of text of the file. The rules in the following
  190. section apply if either the file name or the first line of text matches.
  191. .PP
  192. A section ends with the start of another section. Each section is
  193. divided into contexts, and each context contains rules. A context is a
  194. scope within the text that a particular set of rules belongs to. For
  195. instance, the text within a C style comment (i.e. between
  196. .B /*
  197. and
  198. .BR */ )
  199. has its own color. This is a context, although it has no further rules
  200. inside it because there is probably nothing that we want highlighted
  201. within a C comment.
  202. .PP
  203. A trivial C programming section might look like this:
  204. .PP
  205. .nf
  206. file .\\*\\\\.c C\\sProgram\\sFile (#include|/\\\\\\*)
  207. wholechars abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_
  208. # default colors
  209. define comment brown
  210. context default
  211. keyword whole if yellow
  212. keyword whole else yellow
  213. keyword whole for yellow
  214. keyword whole while yellow
  215. keyword whole do yellow
  216. keyword whole switch yellow
  217. keyword whole case yellow
  218. keyword whole static yellow
  219. keyword whole extern yellow
  220. keyword { brightcyan
  221. keyword } brightcyan
  222. keyword '*' green
  223. # C comments
  224. context /\\* \\*/ comment
  225. # C preprocessor directives
  226. context linestart # \\n red
  227. keyword \\\\\\n brightred
  228. # C string constants
  229. context " " green
  230. keyword %d brightgreen
  231. keyword %s brightgreen
  232. keyword %c brightgreen
  233. keyword \\\\" brightgreen
  234. .fi
  235. .PP
  236. Each context starts with a line of the form:
  237. .PP
  238. .B context
  239. .RB [ exclusive ]
  240. .RB [ whole | wholeright | wholeleft ]
  241. .RB [ linestart ]
  242. .I delim
  243. .RB [ linestart ]
  244. .I delim
  245. .RI [ foreground ]
  246. .RI [ background ]
  247. .RI [ attributes ]
  248. .PP
  249. The first context is an exception. It must start with the command
  250. .PP
  251. .B context default
  252. .RI [ foreground ]
  253. .RI [ background ]
  254. .RI [ attributes ]
  255. .PP
  256. otherwise
  257. .B mcedit
  258. will report an error. The
  259. .B linestart
  260. option specifies that
  261. .I delim
  262. must start at the beginning of a line. The
  263. .B whole
  264. option tells that
  265. .I delim
  266. must be a whole word. To specify that a word must begin on the word
  267. boundary only on the left side, you can use the
  268. .B wholeleft
  269. option, and similarly a word that must end on the word boundary is specified by
  270. .BR wholeright .
  271. .PP
  272. The set of characters that constitute a whole word can be changed at any
  273. point in the file with the
  274. .B wholechars
  275. command. The left and right set of characters can be set separately
  276. with
  277. .PP
  278. .B wholechars
  279. .RB [ left | right ]
  280. .I characters
  281. .PP
  282. The
  283. .B exclusive
  284. option causes the text between the delimiters to be highlighted, but not
  285. the delimiters themselves.
  286. .PP
  287. Each rule is a line of the form:
  288. .PP
  289. .B keyword
  290. .RB [ whole | wholeright | wholeleft ]
  291. .RB [ linestart ]
  292. .I string foreground
  293. .RI [ background ]
  294. .RI [ attributes ]
  295. .PP
  296. Context or keyword strings are interpreted, so that you can include tabs
  297. and spaces with the sequences \\t and \\s. Newlines and backslashes are
  298. specified with \\n and \\\\ respectively. Since whitespace is used as a
  299. separator, it may not be used as is. Also, \\* must be used to specify
  300. an asterisk. The * itself is a wildcard that matches any length of
  301. characters. For example,
  302. .PP
  303. .nf
  304. keyword '*' green
  305. .fi
  306. .PP
  307. colors all C single character constants green. You also could use
  308. .PP
  309. .nf
  310. keyword "*" green
  311. .fi
  312. .PP
  313. to color string constants, but the matched string would not be allowed
  314. to span across multiple newlines. The wildcard may be used within
  315. context delimiters as well, but you cannot have a wildcard as the last
  316. or first character.
  317. .PP
  318. Important to note is the line
  319. .PP
  320. .nf
  321. keyword \\\\\\n brightgreen
  322. .fi
  323. .PP
  324. This line defines a keyword containing the backslash and newline
  325. characters. Since the keywords are matched before the context
  326. delimiters, this keyword prevents the context from ending at the end of
  327. the lines that end in a backslash, thus allowing C preprocessor
  328. directive to continue across multiple lines.
  329. .PP
  330. The possible colors are: black, gray, red, brightred, green,
  331. brightgreen, brown, yellow, blue, brightblue, magenta, brightmagenta,
  332. cyan, brightcyan, lightgray and white. The special keyword "default" means
  333. the terminal's default. Another special keyword "base" means mc's main
  334. colors, it is useful as a placeholder if you want to specify attributes
  335. without modifying the background color. When 256 colors are available,
  336. they can be specified either as color16 to color255, or as rgb000 to rgb555
  337. and gray0 to gray23.
  338. .PP
  339. If the syntax file is shared with
  340. .BR cooledit ,
  341. it is possible to specify different colors for
  342. .B mcedit
  343. and
  344. .B cooledit
  345. by separating them with a slash, e.g.
  346. .PP
  347. .nf
  348. keyword #include red/Orange
  349. .fi
  350. .PP
  351. .B mcedit
  352. uses the color before the slash. See cooledit(1) for supported
  353. .B cooledit
  354. colors.
  355. .PP
  356. Attributes can be any of bold, underline, reverse and blink, appended by a
  357. plus sign if more than one are desired.
  358. .PP
  359. Comments may be put on a separate line starting with the hash sign (#).
  360. .PP
  361. If you are describing case insensitive language you need to use
  362. .B caseinsensitive
  363. derective. It should be specified at the begining of syntax file.
  364. .PP
  365. Because of the simplicity of the implementation, there are a few
  366. intricacies that will not be dealt with correctly but these are a minor
  367. irritation. On the whole, a broad spectrum of quite complicated
  368. situations are handled with these simple rules. It is a good idea to
  369. take a look at the syntax file to see some of the nifty tricks you can
  370. do with a little imagination. If you cannot get by with the rules I
  371. have coded, and you think you have a rule that would be useful, please
  372. email me with your request. However, do not ask for regular expression
  373. support, because this is flatly impossible.
  374. .PP
  375. A useful hint is to work with as much as possible with the things you
  376. can do rather than try to do things that this implementation cannot deal
  377. with. Also remember that the aim of syntax highlighting is to make
  378. programming less prone to error, not to make code look pretty.
  379. .PP
  380. The syntax highlighting can be toggled using Ctrl\-s shortcut.
  381. .SH COLORS
  382. The default colors may be changed by appending to the
  383. .B MC_COLOR_TABLE
  384. environment variable. Foreground and background colors pairs may be
  385. specified for example with:
  386. .PP
  387. .nf
  388. MC_COLOR_TABLE="$MC_COLOR_TABLE:\\
  389. editnormal=lightgray,black:\\
  390. editbold=yellow,black:\\
  391. editmarked=black,cyan"
  392. .fi
  393. .SH OPTIONS
  394. Most options can now be set from the editors options dialog box. See
  395. the
  396. .B Options
  397. menu. The following options are defined in
  398. .B ~/.config/mc/ini
  399. and have obvious counterparts in the dialog box. You can modify them to
  400. change the editor behavior, by editing the file. Unless specified, a 1
  401. sets the option to on, and a 0 sets it to off, as is usual.
  402. .TP
  403. .I use_internal_edit
  404. This option is ignored when invoking
  405. .BR mcedit .
  406. .TP
  407. .I editor_tab_spacing
  408. Interpret the tab character as being of this length.
  409. Default is 8. You should avoid using
  410. other than 8 since most other editors and text viewers
  411. assume a tab spacing of 8. Use
  412. .B editor_fake_half_tabs
  413. to simulate a smaller tab spacing.
  414. .TP
  415. .I editor_fill_tabs_with_spaces
  416. Never insert a tab space. Rather insert spaces (ascii 20h) to fill to the
  417. desired tab size.
  418. .TP
  419. .I editor_return_does_auto_indent
  420. Pressing return will tab across to match the indentation
  421. of the first line above that has text on it.
  422. .TP
  423. .I editor_backspace_through_tabs
  424. Make a single backspace delete all the space to the left
  425. margin if there is no text between the cursor and the left
  426. margin.
  427. .TP
  428. .I editor_fake_half_tabs
  429. This will emulate a half tab for those who want to program
  430. with a tab spacing of 4, but do not want the tab size changed
  431. from 8 (so that the code will be formatted the same when displayed
  432. by other programs). When editing between text and the left
  433. margin, moving and tabbing will be as though a tab space were
  434. 4, while actually using spaces and normal tabs for an optimal fill.
  435. When editing anywhere else, a normal tab is inserted.
  436. .TP
  437. .I editor_option_save_mode
  438. Possible values 0, 1 and 2. The save mode (see the options menu also)
  439. allows you to change the method of saving a file. Quick save (0) saves
  440. the file by immediately, truncating the disk file to zero length (i.e.
  441. erasing it) and the writing the editor contents to the file. This
  442. method is fast, but dangerous, since a system error during a file save
  443. will leave the file only partially written, possibly rendering the data
  444. irretrievable. When saving, the safe save (1) option enables creation
  445. of a temporary file into which the file contents are first written. In
  446. the event of an problem, the original file is untouched. When the
  447. temporary file is successfully written, it is renamed to the name of the
  448. original file, thus replacing it. The safest method is create backups
  449. (2). Where a backup file is created before any changes are made. You
  450. can specify your own backup file extension in the dialog. Note that
  451. saving twice will replace your backup as well as your original file.
  452. .TP
  453. .I editor_word_wrap_line_length
  454. line length to wrap. 72 default.
  455. .TP
  456. .I editor_backup_extension
  457. symbol for add extension to name of backup files. Default "~".
  458. .TP
  459. .I editor_line_state
  460. show state line of editor now it show number of file line (in future it
  461. can show things like folding, breakpoints, etc.). M\-n toglle this option.
  462. .TP
  463. .I editor_visible_spaces
  464. Toggle show visible trailing spaces (TWS), if editor_visible_spaces=1 TWS
  465. showed as '.'
  466. .TP
  467. .I editor_visible_tabs
  468. Toggle show visible tabs, if editor_visible_tabs=1 tabs showed as '<\-\-\-\->'
  469. .TP
  470. .I editor_persistent_selections
  471. Do not remove block selection after moving the cursor.
  472. .TP
  473. .I editor_cursor_beyond_eol
  474. Allow moving cursor beyond the end of line.
  475. .TP
  476. .I editor_syntax_highlighting
  477. enable syntax highlighting.
  478. .TP
  479. .I editor_edit_confirm_save
  480. show confirm dialog on save.
  481. .TP
  482. .I editor_option_typewriter_wrap
  483. to be described
  484. .TP
  485. .I editor_option_auto_para_formatting
  486. to be described
  487. .TP
  488. .I editor_option_save_position
  489. save file position on exit.
  490. .TP
  491. .I source_codepage
  492. symbol representation of codepage name for file (i.e. CP1251, ~ \- default).
  493. .TP
  494. .I editor_group_undo
  495. do UNDO for several of the same type of action (inserting/overwriting,
  496. deleting, navigating, typing)
  497. .TP
  498. .I editor_wordcompletion_collect_entire_file
  499. Search autocomplete candidates in entire of file or just from
  500. begin of file to cursor position (0)
  501. .SH MISCELLANEOUS
  502. You can use scanf search and replace to search and replace a C format
  503. string. First take a look at the
  504. .B sscanf
  505. and
  506. .B sprintf
  507. man pages to see what a format string is and how it works. Here's an
  508. example: suppose that you want to replace all occurrences of an open
  509. bracket, three comma separated numbers, and a close bracket, with the
  510. word
  511. .IR apples ,
  512. the third number, the word
  513. .I oranges
  514. and then the second number. You would fill in the Replace dialog box as
  515. follows:
  516. .PP
  517. .nf
  518. .B Enter search string
  519. (%d,%d,%d)
  520. .B Enter replace string
  521. apples %d oranges %d
  522. .B Enter replacement argument order
  523. 3,2
  524. .fi
  525. .PP
  526. The last line specifies that the third and then the second number are to
  527. be used in place of the first and second.
  528. .PP
  529. It is advisable to use this feature with Prompt On Replace on, because a
  530. match is thought to be found whenever the number of arguments found
  531. matches the number given, which is not always a real match. Scanf also
  532. treats whitespace as being elastic. Note that the scanf format %[ is
  533. very useful for scanning strings, and whitespace.
  534. .PP
  535. The editor also displays non\-us characters (160+). When editing
  536. binary files, you should set
  537. .B display bits
  538. to 7 bits in the Midnight Commander options menu to keep the spacing
  539. clean.
  540. .SH FILES
  541. .I @prefix@/share/mc/mc.hlp
  542. .IP
  543. The help file for the program.
  544. .PP
  545. .I @prefix@/share/mc/mc.ini
  546. .IP
  547. The default system\-wide setup for GNU Midnight Commander, used only if
  548. the user's own ~/.config/mc/ini file is missing.
  549. .PP
  550. .I @prefix@/share/mc/mc.lib
  551. .IP
  552. Global settings for the Midnight Commander. Settings in this file
  553. affect all users, whether they have ~/.config/mc/ini or not.
  554. .PP
  555. .I @prefix@/share/mc/syntax/*
  556. .IP
  557. The default system\-wide syntax files for mcedit, used only if
  558. the corresponding user's own ~/.local/share/mc/mcedit/ file is missing.
  559. .PP
  560. .I ~/.config/mc/ini
  561. .IP
  562. User's own setup. If this file is present then the setup is loaded
  563. from here instead of the system\-wide setup file.
  564. .PP
  565. .I ~/.local/share/mc/mcedit/
  566. .IP
  567. User's own directory where block commands are processed and saved and
  568. user's own syntax files are located.
  569. .SH LICENSE
  570. This program is distributed under the terms of the GNU General Public
  571. License as published by the Free Software Foundation. See the built\-in
  572. help of the Midnight Commander for details on the License and the lack
  573. of warranty.
  574. .SH AVAILABILITY
  575. The latest version of this program can be found at
  576. http://midnight\-commander.org/.
  577. .SH SEE ALSO
  578. cooledit(1), mc(1), gpm(1), terminfo(1), scanf(3).
  579. .SH AUTHORS
  580. Paul Sheer (psheer@obsidian.co.za) is the original author of
  581. the Midnight Commander's internal editor.
  582. .SH BUGS
  583. Bugs should be reported to mc\-devel@gnome.org