comparison man/hyperbole.texi @ 76:c0c698873ce1 r20-0b33

Import from CVS: tag r20-0b33
author cvs
date Mon, 13 Aug 2007 09:05:10 +0200
parents 131b0175ea99
children 4be1180a9e89
comparison
equal deleted inserted replaced
75:a4e0195b387b 76:c0c698873ce1
496 @end format 496 @end format
497 497
498 @display 498 @display
499 Mail list for discussion of all Hyperbole issues. Bug reports and 499 Mail list for discussion of all Hyperbole issues. Bug reports and
500 suggestions may also be sent here.@refill 500 suggestions may also be sent here.@refill
501 @end display
501 502
502 @cindex e-mail, effective communication 503 @cindex e-mail, effective communication
503 @cindex effective communication 504 @cindex effective communication
505 @display
504 Always use your Subject and/or Summary: lines to state the position that 506 Always use your Subject and/or Summary: lines to state the position that
505 your message takes on the topic that it addresses. 507 your message takes on the topic that it addresses.
506 508
507 For example, send: 509 For example, send:
508 510
514 516
515 Statements end with periods, questions with question marks (typically), 517 Statements end with periods, questions with question marks (typically),
516 and high energy, high impact declarations with exclamation points. This 518 and high energy, high impact declarations with exclamation points. This
517 simple rule makes all e-mail communication much easier for recipients to 519 simple rule makes all e-mail communication much easier for recipients to
518 handle appropriately.@refill 520 handle appropriately.@refill
521 @end display
519 522
520 @cindex Hyperbole version 523 @cindex Hyperbole version
521 @cindex Emacs version 524 @cindex Emacs version
522 @vindex emacs-version 525 @vindex emacs-version
526 @display
523 If you ask a question, your subject line should end with a ?, 527 If you ask a question, your subject line should end with a ?,
524 e.g@. "Subject: How can man page SEE ALSOs be made implicit buttons?" A 528 e.g@. "Subject: How can man page SEE ALSOs be made implicit buttons?" A
525 "Subject: Re: How can ..." then indicates an answer to the question. 529 "Subject: Re: How can ..." then indicates an answer to the question.
526 Question messages should normally include your Hyperbole and Emacs 530 Question messages should normally include your Hyperbole and Emacs
527 version numbers and clearly explain your problem and surrounding issues. 531 version numbers and clearly explain your problem and surrounding issues.
2315 @section Menu Commands 2319 @section Menu Commands
2316 2320
2317 The Otl/ menu entry on the Hyperbole top-level menu provides access to 2321 The Otl/ menu entry on the Hyperbole top-level menu provides access to
2318 a number of major outliner commands: 2322 a number of major outliner commands:
2319 2323
2320 @example
2321 @group
2322 @cindex outliner commands 2324 @cindex outliner commands
2323 @cindex Koutliner commands 2325 @cindex Koutliner commands
2324 @findex kotl-mode:show-all 2326 @findex kotl-mode:show-all
2325 @findex kvspec:toggle-blank-lines 2327 @findex kvspec:toggle-blank-lines
2326 @findex kfile:find 2328 @findex kfile:find
2331 @findex kotl-mode:overview 2333 @findex kotl-mode:overview
2332 @findex kotl-mode:show-tree 2334 @findex kotl-mode:show-tree
2333 @findex kotl-mode:top-cells 2335 @findex kotl-mode:top-cells
2334 @findex kvspec:activate 2336 @findex kvspec:activate
2335 @cindex menu, Outline 2337 @cindex menu, Outline
2338 @example
2339 @group
2336 Menu Item Command Description 2340 Menu Item Command Description
2337 ==================================================================== 2341 ====================================================================
2338 All kotl-mode:show-all Expand all cells 2342 All kotl-mode:show-all Expand all cells
2339 Blanks kvspec:toggle-blank-lines Toggle blank lines on or off 2343 Blanks kvspec:toggle-blank-lines Toggle blank lines on or off
2340 Create kfile:find Edit or create an outline 2344 Create kfile:find Edit or create an outline
3345 @cindex rolodex menu 3349 @cindex rolodex menu
3346 The Rolo/ menu entry on the Hyperbole top-level menu provides the 3350 The Rolo/ menu entry on the Hyperbole top-level menu provides the
3347 user interface to the rolodex. The rolo menu provides access to the 3351 user interface to the rolodex. The rolo menu provides access to the
3348 following commands: 3352 following commands:
3349 3353
3350 @example
3351 @group
3352 @cindex rolodex commands 3354 @cindex rolodex commands
3353 @cindex Wrolo commands 3355 @cindex Wrolo commands
3354 @findex rolo-add 3356 @findex rolo-add
3355 @findex rolo-display-matches 3357 @findex rolo-display-matches
3356 @findex rolo-edit 3358 @findex rolo-edit
3359 @findex rolo-sort 3361 @findex rolo-sort
3360 @findex rolo-grep 3362 @findex rolo-grep
3361 @findex rolo-fgrep 3363 @findex rolo-fgrep
3362 @findex rolo-word 3364 @findex rolo-word
3363 @findex rolo-yank 3365 @findex rolo-yank
3366 @example
3367 @group
3364 Menu Item Command Description 3368 Menu Item Command Description
3365 ==================================================================== 3369 ====================================================================
3366 Add rolo-add Adds a rolodex entry 3370 Add rolo-add Adds a rolodex entry
3367 Display rolo-display-matches Displays last matches again 3371 Display rolo-display-matches Displays last matches again
3368 Edit rolo-edit Edits an existing rolodex entry 3372 Edit rolo-edit Edits an existing rolodex entry
3586 @noindent 3590 @noindent
3587 @display 3591 @display
3588 WinConfig> AddName DeleteName RestoreName PopRing SaveRing YankRing 3592 WinConfig> AddName DeleteName RestoreName PopRing SaveRing YankRing
3589 @end display 3593 @end display
3590 3594
3595 @cindex wconfig commands
3596 @cindex window configuration commands
3591 @example 3597 @example
3592 @group 3598 @group
3593 @cindex wconfig commands
3594 @cindex window configuration commands
3595 @findex wconfig-add-by-name 3599 @findex wconfig-add-by-name
3596 @findex wconfig-delete-by-name 3600 @findex wconfig-delete-by-name
3597 @findex wconfig-restore-by-name 3601 @findex wconfig-restore-by-name
3598 @findex wconfig-delete-pop 3602 @findex wconfig-delete-pop
3599 @findex wconfig-ring-save 3603 @findex wconfig-ring-save
4574 a window system with mouse key support. So keep in mind that the 4578 a window system with mouse key support. So keep in mind that the
4575 operations in this section apply only if you have mouse support within 4579 operations in this section apply only if you have mouse support within
4576 Hyperbole. The Smart Key operations in, @ref{Smart Keyboard Keys}, 4580 Hyperbole. The Smart Key operations in, @ref{Smart Keyboard Keys},
4577 apply to both mouse and keyboard Smart Key usage. 4581 apply to both mouse and keyboard Smart Key usage.
4578 4582
4583 @cindex drag, side edge
4584 @cindex side drag
4579 @format 4585 @format
4580 @group 4586 @group
4581 @cindex drag, side edge
4582 @cindex side drag
4583 If dragged from a side-by-side window edge or from the immediate left of 4587 If dragged from a side-by-side window edge or from the immediate left of
4584 a vertical scroll bar: 4588 a vertical scroll bar:
4585 ACTION or ASSIST 4589 ACTION or ASSIST
4586 Resizes adjacent window sides to the point of drag release. 4590 Resizes adjacent window sides to the point of drag release.
4587 @end group 4591 @end group
4588 @end format 4592 @end format
4589 4593
4594 @cindex drag, between windows
4590 @format 4595 @format
4591 @group 4596 @group
4592 @cindex drag, between windows
4593 If dragged from inside one window to another: 4597 If dragged from inside one window to another:
4594 ACTION 4598 ACTION
4595 Creates a new link button at the drag start location, linked to the 4599 Creates a new link button at the drag start location, linked to the
4596 drag end location. If drag start position is within a button, 4600 drag end location. If drag start position is within a button,
4597 modifies the button to link to drag end location. 4601 modifies the button to link to drag end location.
4599 Swaps buffers in the two windows. 4603 Swaps buffers in the two windows.
4600 @end group 4604 @end group
4601 @end format 4605 @end format
4602 4606
4603 @page 4607 @page
4608 @cindex drag, horizontal
4609 @cindex horizontal drag
4604 @format 4610 @format
4605 @group 4611 @group
4606 @cindex drag, horizontal
4607 @cindex horizontal drag
4608 If dragged horizontally within a single window while depressed 4612 If dragged horizontally within a single window while depressed
4609 (hmouse-x-drag-sensitivity sets the minimal horizontal movement which 4613 (hmouse-x-drag-sensitivity sets the minimal horizontal movement which
4610 registers a drag): 4614 registers a drag):
4611 ACTION 4615 ACTION
4612 Goes to buffer end if drag was to the right, otherwise goes to beginning. 4616 Goes to buffer end if drag was to the right, otherwise goes to beginning.
4614 Splits window vertically if drag was to the right, otherwise deletes 4618 Splits window vertically if drag was to the right, otherwise deletes
4615 window. 4619 window.
4616 @end group 4620 @end group
4617 @end format 4621 @end format
4618 4622
4623 @cindex depress, modeline
4624 @cindex modeline depress
4619 @format 4625 @format
4620 @group 4626 @group
4621 @cindex depress, modeline
4622 @cindex modeline depress
4623 If depressed within a window mode line: 4627 If depressed within a window mode line:
4624 ACTION 4628 ACTION
4625 (1) clicked on left edge of a window's modeline, 4629 (1) clicked on left edge of a window's modeline,
4626 window's buffer is buried (placed at bottom of buffer list); 4630 window's buffer is buried (placed at bottom of buffer list);
4627 (2) clicked on right edge of a window's modeline, 4631 (2) clicked on right edge of a window's modeline,
4648 its window and potentially its vertical neighbors. 4652 its window and potentially its vertical neighbors.
4649 @end group 4653 @end group
4650 @end format 4654 @end format
4651 4655
4652 @page 4656 @page
4657 @cindex drag, vertical
4658 @cindex vertical drag
4653 @format 4659 @format
4654 @group 4660 @group
4655 @cindex drag, vertical
4656 @cindex vertical drag
4657 If dragged vertically within a single window while depressed 4661 If dragged vertically within a single window while depressed
4658 (hmouse-y-drag-sensitivity sets the minimal vertical movement which 4662 (hmouse-y-drag-sensitivity sets the minimal vertical movement which
4659 registers a drag): 4663 registers a drag):
4660 ACTION or ASSIST 4664 ACTION or ASSIST
4661 Splits current window into two side-by-side windows. 4665 Splits current window into two side-by-side windows.
4662 @end group 4666 @end group
4663 @end format 4667 @end format
4664 4668
4669 @cindex drag, diagonal
4670 @cindex diagonal drag
4665 @format 4671 @format
4666 @group 4672 @group
4667 @cindex drag, diagonal
4668 @cindex diagonal drag
4669 If dragged diagonally within a single window while depressed 4673 If dragged diagonally within a single window while depressed
4670 (hmouse-x-diagonal-sensitivity and hmouse-y-diagonal-sensitivity set the 4674 (hmouse-x-diagonal-sensitivity and hmouse-y-diagonal-sensitivity set the
4671 minimal diagonal movement which registers a drag): 4675 minimal diagonal movement which registers a drag):
4672 ACTION 4676 ACTION
4673 Save current window configuration onto a ring of window configurations. 4677 Save current window configuration onto a ring of window configurations.
4708 @end format 4712 @end format
4709 4713
4710 @vindex smart-scroll-proportional 4714 @vindex smart-scroll-proportional
4711 @cindex proportional scrolling 4715 @cindex proportional scrolling
4712 @cindex scrolling 4716 @cindex scrolling
4717 @cindex click, end of line
4718 @cindex end of line click
4713 @format 4719 @format
4714 @group 4720 @group
4715 @cindex click, end of line
4716 @cindex end of line click
4717 When pressed at the end of a line but not the end of a buffer: 4721 When pressed at the end of a line but not the end of a buffer:
4718 ACTION 4722 ACTION
4719 Scrolls up according to value of smart-scroll-proportional. If 4723 Scrolls up according to value of smart-scroll-proportional. If
4720 smart-scroll-proportional is nil or if point is on the top 4724 smart-scroll-proportional is nil or if point is on the top
4721 window line, scrolls up (forward) a windowful. Otherwise, tries to 4725 window line, scrolls up (forward) a windowful. Otherwise, tries to
4728 tries to bring current line to bottom of window. Leaves point at end of 4732 tries to bring current line to bottom of window. Leaves point at end of
4729 line and returns t if scrolled, nil if not. 4733 line and returns t if scrolled, nil if not.
4730 @end group 4734 @end group
4731 @end format 4735 @end format
4732 4736
4737 @cindex click, button
4738 @cindex button click
4733 @format 4739 @format
4734 @group 4740 @group
4735 @cindex click, button
4736 @cindex button click
4737 When pressed on a Hyperbole button: 4741 When pressed on a Hyperbole button:
4738 ACTION 4742 ACTION
4739 Activates button. 4743 Activates button.
4740 ASSIST 4744 ASSIST
4741 Displays help for button, typically a summary of its attributes. 4745 Displays help for button, typically a summary of its attributes.
5044 hidden then show it, otherwise hide it; 5048 hidden then show it, otherwise hide it;
5045 (5) anywhere else, scroll down a windowful. 5049 (5) anywhere else, scroll down a windowful.
5046 @end group 5050 @end group
5047 @end format 5051 @end format
5048 5052
5053 @cindex click, Info
5054 @cindex Info browsing
5049 @format 5055 @format
5050 @group 5056 @group
5051 @cindex click, Info
5052 @cindex Info browsing
5053 If pressed within an Info manual node: 5057 If pressed within an Info manual node:
5054 ACTION 5058 ACTION
5055 (1) the first line of an Info Menu Entry or Cross Reference, the desired 5059 (1) the first line of an Info Menu Entry or Cross Reference, the desired
5056 node is found; 5060 node is found;
5057 (2) the Up,Next,or Previous entries of a Node Header (first line), 5061 (2) the Up,Next,or Previous entries of a Node Header (first line),
5104 (5) a msg summary buffer, on or after the last line, all messages are 5108 (5) a msg summary buffer, on or after the last line, all messages are
5105 marked undeleted. 5109 marked undeleted.
5106 @end group 5110 @end group
5107 @end format 5111 @end format
5108 5112
5113 @cindex click, GNUS
5114 @cindex GNUS browsing
5109 @format 5115 @format
5110 @group 5116 @group
5111 @cindex click, GNUS
5112 @cindex GNUS browsing
5113 If pressed within a GNUS listing of newsgroups buffer at: 5117 If pressed within a GNUS listing of newsgroups buffer at:
5114 ACTION 5118 ACTION
5115 (1) a GNUS-GROUP line, that newsgroup is read; 5119 (1) a GNUS-GROUP line, that newsgroup is read;
5116 (2) to the left of any GNUS-GROUP line, on any of the whitespace, the 5120 (2) to the left of any GNUS-GROUP line, on any of the whitespace, the
5117 current group is unsubscribed or resubscribed; 5121 current group is unsubscribed or resubscribed;
5157 (3) anywhere else, the window is scrolled down a windowful. 5161 (3) anywhere else, the window is scrolled down a windowful.
5158 @end group 5162 @end group
5159 @end format 5163 @end format
5160 5164
5161 @page 5165 @page
5166 @cindex click, buffer menu
5167 @cindex buffer menu
5162 @format 5168 @format
5163 @group 5169 @group
5164 @cindex click, buffer menu
5165 @cindex buffer menu
5166 If pressed within a listing of buffers (Buffer-menu-mode): 5170 If pressed within a listing of buffers (Buffer-menu-mode):
5167 ACTION 5171 ACTION
5168 (1) on the first column of an entry, the selected buffer is marked for 5172 (1) on the first column of an entry, the selected buffer is marked for
5169 display; 5173 display;
5170 (2) on the second column of an entry, the selected buffer is marked to be 5174 (2) on the second column of an entry, the selected buffer is marked to be
5182 (3) on or after the last line in the buffer, all display, save, and delete 5186 (3) on or after the last line in the buffer, all display, save, and delete
5183 marks on all entries are undone. 5187 marks on all entries are undone.
5184 @end group 5188 @end group
5185 @end format 5189 @end format
5186 5190
5191 @cindex click, dired
5192 @cindex dired browsing
5187 @format 5193 @format
5188 @group 5194 @group
5189 @cindex click, dired
5190 @cindex dired browsing
5191 If pressed within a dired-mode buffer: 5195 If pressed within a dired-mode buffer:
5192 ACTION 5196 ACTION
5193 (1) within an entry line, the selected file/directory is displayed 5197 (1) within an entry line, the selected file/directory is displayed
5194 for editing in the other window; 5198 for editing in the other window;
5195 (2) on or after the last line in the buffer, if any deletes are to be 5199 (2) on or after the last line in the buffer, if any deletes are to be
5206 entries are undone. 5210 entries are undone.
5207 @end group 5211 @end group
5208 @end format 5212 @end format
5209 5213
5210 @page 5214 @page
5211 @format
5212 @group
5213 @cindex click, tar 5215 @cindex click, tar
5214 @cindex tar archive browsing 5216 @cindex tar archive browsing
5215 @cindex extracting from tar files 5217 @cindex extracting from tar files
5218 @format
5219 @group
5216 If pressed within a tar-mode buffer: 5220 If pressed within a tar-mode buffer:
5217 ACTION 5221 ACTION
5218 (1) within an entry line, the selected file/directory is displayed 5222 (1) within an entry line, the selected file/directory is displayed
5219 for editing in the other window; 5223 for editing in the other window;
5220 (2) on or after the last line in the buffer, if any deletes are to be 5224 (2) on or after the last line in the buffer, if any deletes are to be
5225 (2) on or after the last line in the buffer, all delete marks on all 5229 (2) on or after the last line in the buffer, all delete marks on all
5226 entries are undone. 5230 entries are undone.
5227 @end group 5231 @end group
5228 @end format 5232 @end format
5229 5233
5234 @cindex man page references
5230 @format 5235 @format
5231 @group 5236 @group
5232 @cindex man page references
5233 If pressed on a cross reference within a man page entry section labeled 5237 If pressed on a cross reference within a man page entry section labeled
5234 NAME, SEE ALSO, or PACKAGES USED, or within a man page C routine 5238 NAME, SEE ALSO, or PACKAGES USED, or within a man page C routine
5235 specification (see 'smart-man-c-routine-ref') and man page buffer 5239 specification (see 'smart-man-c-routine-ref') and man page buffer
5236 has either an attached file or else a @var{man-path} local variable 5240 has either an attached file or else a @var{man-path} local variable
5237 containing its pathname: 5241 containing its pathname:
5238 ACTION or ASSIST 5242 ACTION or ASSIST
5239 Displays man page or source code for cross reference. 5243 Displays man page or source code for cross reference.
5240 @end group 5244 @end group
5241 @end format 5245 @end format
5242 5246
5243 @format
5244 @group
5245 @cindex click, world-wide web 5247 @cindex click, world-wide web
5246 @cindex W3 5248 @cindex W3
5247 @cindex URL 5249 @cindex URL
5248 @cindex world-wide web 5250 @cindex world-wide web
5251 @format
5252 @group
5249 If pressed on a world-wide web universal resource locator: 5253 If pressed on a world-wide web universal resource locator:
5250 ACTION 5254 ACTION
5251 Displays the URL referent at point. 5255 Displays the URL referent at point.
5252 ASSIST 5256 ASSIST
5253 Goes back to a previously displayed web page. 5257 Goes back to a previously displayed web page.
5254 @end group 5258 @end group
5255 @end format 5259 @end format
5256 5260
5261 @cindex game, gomoku
5262 @cindex gomoku
5257 @format 5263 @format
5258 @group 5264 @group
5259 @cindex game, gomoku
5260 @cindex gomoku
5261 If pressed in a Gomoku game buffer. 5265 If pressed in a Gomoku game buffer.
5262 ACTION 5266 ACTION
5263 Makes a move at the space pointed to. 5267 Makes a move at the space pointed to.
5264 ASSIST 5268 ASSIST
5265 Takes back a prior move made at the space pointed to. 5269 Takes back a prior move made at the space pointed to.
5266 @end group 5270 @end group
5267 @end format 5271 @end format
5268 5272
5273 @cindex click, wrolo matches
5274 @cindex wrolo matches
5269 @format 5275 @format
5270 @group 5276 @group
5271 @cindex click, wrolo matches
5272 @cindex wrolo matches
5273 If pressed within an entry in the wrolo match display buffer: 5277 If pressed within an entry in the wrolo match display buffer:
5274 ACTION or ASSIST 5278 ACTION or ASSIST
5275 The entry is edited in the other window. 5279 The entry is edited in the other window.
5276 @end group 5280 @end group
5277 @end format 5281 @end format