mc/source
0
0
Fork 0
mirror of https://github.com/MidnightCommander/source.git synced 2026-02-02 11:11:55 -08:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
source/S/src--help.h.html
github-actions[bot] 08571174ab Deploy to GitHub Pages
2026-02-01 17:32:02 +00:00

94 lines
10 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>src/help.h</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.11' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='../style.css' />
</head>
<body>
<!-- beginning of fixed guide -->
<div id='guide'><ul>
<li><a href='#TOP'><img class='icon' src='../icons/first.png' alt='[^]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/last.png' alt='[v]' /></a></li>
<li><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a></li>
<li><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a></li>
<li><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a></li>
<li class='standout'><span><a href='../files/src.html'>src</a>/help.h</span></li>
</ul></div>
<!-- end of fixed guide -->
<div align='right'>Manual pages:
<a href=man/mc.html>mc</a> &bullet; <a href=man/mcdiff.html>mcdiff</a> &bullet; <a href=man/mcedit.html>mcedit</a> &bullet; <a href=man/mcview.html>mcview</a>
</div>
<a id='TOP' name='TOP'></a><h2 class='header'><a href='../mains.html'>root</a>/<a href='../files/src.html'>src</a>/help.h</h2>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><img class='icon' src='../icons/n_top.png' alt='[top]' /><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+1 src/help.h' /> */</em>
<hr />
<h2 class='header'><a href='../J/help.h.html' title='Multiple included from 2 places.'>INCLUDED FROM</a></h2>
<hr />
<pre>
<a id='L1' name='L1'></a> 1 <em class='comment'>/** \file help.h</em>
<a id='L2' name='L2'></a> 2 <em class='comment'> * \brief Header: hypertext file browser</em>
<a id='L3' name='L3'></a> 3 <em class='comment'> *</em>
<a id='L4' name='L4'></a> 4 <em class='comment'> * Implements the hypertext file viewer.</em>
<a id='L5' name='L5'></a> 5 <em class='comment'> * The hypertext file is a file that may have one or more nodes. Each</em>
<a id='L6' name='L6'></a> 6 <em class='comment'> * node ends with a ^D character and starts with a bracket, then the</em>
<a id='L7' name='L7'></a> 7 <em class='comment'> * name of the node and then a closing bracket. Right after the closing</em>
<a id='L8' name='L8'></a> 8 <em class='comment'> * bracket a newline is placed. This newline is not to be displayed by</em>
<a id='L9' name='L9'></a> 9 <em class='comment'> * the help viewer and must be skipped - its sole purpose is to facilitate</em>
<a id='L10' name='L10'></a> 10 <em class='comment'> * the work of the people managing the help file template (xnc.hlp) .</em>
<a id='L11' name='L11'></a> 11 <em class='comment'> *</em>
<a id='L12' name='L12'></a> 12 <em class='comment'> * Links in the hypertext file are specified like this: the text that</em>
<a id='L13' name='L13'></a> 13 <em class='comment'> * will be highlighted should have a leading ^A, then it comes the</em>
<a id='L14' name='L14'></a> 14 <em class='comment'> * text, then a ^B indicating that highlighting is done, then the name</em>
<a id='L15' name='L15'></a> 15 <em class='comment'> * of the node you want to link to and then a ^C.</em>
<a id='L16' name='L16'></a> 16 <em class='comment'> *</em>
<a id='L17' name='L17'></a> 17 <em class='comment'> * The file must contain a ^D at the beginning and at the end of the</em>
<a id='L18' name='L18'></a> 18 <em class='comment'> * file or the program will not be able to detect the end of file.</em>
<a id='L19' name='L19'></a> 19 <em class='comment'> *</em>
<a id='L20' name='L20'></a> 20 <em class='comment'> * Laziness/widgeting attack: This file does use the dialog manager</em>
<a id='L21' name='L21'></a> 21 <em class='comment'> * and uses mainly the dialog to achieve the help work. there is only</em>
<a id='L22' name='L22'></a> 22 <em class='comment'> * one specialized widget and it's only used to forward the mouse messages</em>
<a id='L23' name='L23'></a> 23 <em class='comment'> * to the appropriate routine.</em>
<a id='L24' name='L24'></a> 24 <em class='comment'> *</em>
<a id='L25' name='L25'></a> 25 <em class='comment'> * This file is included by help.c and man2hlp.c</em>
<a id='L26' name='L26'></a> 26 <em class='comment'> */</em>
<a id='L27' name='L27'></a> 27
<a id='L28' name='L28'></a> 28 <em class='sharp'>#ifndef</em> <a href='../S/src--help.h.html#L29' title='Defined at 29 in src/help.h.'>MC__HELP_H</a>
<a id='L29' name='L29'></a> 29 <em class='sharp'>#define</em> <a href='../S/src--help.h.html#L28' title='Referred from 28 in src/help.h.'>MC__HELP_H</a>
<a id='L30' name='L30'></a> 30
<a id='L31' name='L31'></a> 31 <em class='comment'>/*** typedefs(not structures) and defined constants **********************************************/</em>
<a id='L32' name='L32'></a> 32
<a id='L33' name='L33'></a> 33 <em class='comment'>/* Markers used in the help files */</em>
<a id='L34' name='L34'></a> 34 <em class='sharp'>#define</em> <a href='../R/CHAR_LINK_START.html' title='Multiple referred from 2 places.'>CHAR_LINK_START</a> '\01' <em class='comment'>// Ctrl-A</em>
<a id='L35' name='L35'></a> 35 <em class='sharp'>#define</em> <a href='../R/CHAR_LINK_POINTER.html' title='Multiple referred from 3 places.'>CHAR_LINK_POINTER</a> '\02' <em class='comment'>// Ctrl-B</em>
<a id='L36' name='L36'></a> 36 <em class='sharp'>#define</em> <a href='../R/CHAR_LINK_END.html' title='Multiple referred from 2 places.'>CHAR_LINK_END</a> '\03' <em class='comment'>// Ctrl-C</em>
<a id='L37' name='L37'></a> 37 <em class='sharp'>#define</em> <a href='../R/CHAR_NODE_END.html' title='Multiple referred from 13 places.'>CHAR_NODE_END</a> '\04' <em class='comment'>// Ctrl-D</em>
<a id='L38' name='L38'></a> 38 <em class='sharp'>#define</em> <a href='../S/src--help.c.html#L570' title='Referred from 570 in src/help.c.'>CHAR_ALTERNATE</a> '\05' <em class='comment'>// Ctrl-E</em>
<a id='L39' name='L39'></a> 39 <em class='sharp'>#define</em> <a href='../S/src--help.c.html#L573' title='Referred from 573 in src/help.c.'>CHAR_NORMAL</a> '\06' <em class='comment'>// Ctrl-F</em>
<a id='L40' name='L40'></a> 40 <em class='sharp'>#define</em> <a href='../S/src--help.c.html#L576' title='Referred from 576 in src/help.c.'>CHAR_VERSION</a> '\07' <em class='comment'>// Ctrl-G</em>
<a id='L41' name='L41'></a> 41 <em class='sharp'>#define</em> <a href='../S/src--help.c.html#L581' title='Referred from 581 in src/help.c.'>CHAR_FONT_BOLD</a> '\010' <em class='comment'>// Ctrl-H</em>
<a id='L42' name='L42'></a> 42 <em class='sharp'>#define</em> <a href='../S/src--help.c.html#L587' title='Referred from 587 in src/help.c.'>CHAR_FONT_NORMAL</a> '\013' <em class='comment'>// Ctrl-K</em>
<a id='L43' name='L43'></a> 43 <em class='sharp'>#define</em> <a href='../S/src--help.c.html#L584' title='Referred from 584 in src/help.c.'>CHAR_FONT_ITALIC</a> '\024' <em class='comment'>// Ctrl-T</em>
<a id='L44' name='L44'></a> 44
<a id='L45' name='L45'></a> 45 <em class='comment'>/*** enums ***************************************************************************************/</em>
<a id='L46' name='L46'></a> 46
<a id='L47' name='L47'></a> 47 <em class='comment'>/*** structures declarations (and typedefs of structures)*****************************************/</em>
<a id='L48' name='L48'></a> 48
<a id='L49' name='L49'></a> 49 <em class='comment'>/*** global variables defined in .c file *********************************************************/</em>
<a id='L50' name='L50'></a> 50
<a id='L51' name='L51'></a> 51 <em class='comment'>/*** declarations of public functions ************************************************************/</em>
<a id='L52' name='L52'></a> 52
<a id='L53' name='L53'></a> 53 <a href='../Y/gboolean.html' title='Multiple used in 1942 places.'>gboolean</a> <a href='../S/src--help.c.html#L1121' title='Defined at 1121 in src/help.c.'>help_interactive_display</a> (<strong class='reserved'>const</strong> <a href='../Y/gchar.html' title='Multiple used in 321 places.'>gchar</a> *<a href='../Y/event_group_name.html' title='Multiple used in 74 places.'>event_group_name</a>, <strong class='reserved'>const</strong> <a href='../Y/gchar.html' title='Multiple used in 321 places.'>gchar</a> *<a href='../Y/event_name.html' title='Multiple used in 69 places.'>event_name</a>,
<a id='L54' name='L54'></a> 54 <a href='../Y/gpointer.html' title='Multiple used in 108 places.'>gpointer</a> <a href='../Y/init_data.html' title='Multiple used in 48 places.'>init_data</a>, <a href='../Y/gpointer.html' title='Multiple used in 108 places.'>gpointer</a> <a href='../Y/data.html' title='Multiple used in 916 places.'>data</a>);
<a id='L55' name='L55'></a> 55
<a id='L56' name='L56'></a> 56 <em class='comment'>/*** inline functions ****************************************************************************/</em>
<a id='L57' name='L57'></a> 57 <em class='sharp'>#endif</em>
</pre>
<hr />
<a id='BOTTOM' name='BOTTOM'></a>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a><img class='icon' src='../icons/n_bottom.png' alt='[bottom]' /><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+57 src/help.h' /> */</em>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink