123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527 |
- <html><head><title>Rxvt Technical Reference</title>
- <link rev="made" href="mailto:gcw@pobox.com">
- </head>
- <body BGCOLOR="#FFFFFF">
- <hr>
- <h1>Rxvt Technical Reference</h1>
- <h2>Geoff Wing (gcw@pobox.com)</h2>
- <h2>18 April 1998</h2>
- <a name="toc"></a>
- <a name="masonyodl.yo"></a>
-
- <p><dl>
- <li ><a href="rxvtRef.html#Definitions">Definitions</a>
- <li ><a href="rxvtRef.html#Values">Values</a>
- <li ><a href="rxvtRef.html#Sequences">Escape Sequences</a>
- <li ><a href="rxvtRef.html#CSI">CSI (Code Sequence Introducer) Sequences</a>
- <li ><a href="rxvtRef.html#PrivateModes">DEC Private Modes</a>
- <li ><a href="rxvtRef.html#XTerm">XTerm Operating System Commands</a>
- <li ><a href="rxvtRef.html#menuBar">menuBar</a>
- <li ><a href="rxvtRef.html#XPM">XPM</a>
- <li ><a href="rxvtRef.html#Mouse">Mouse Reporting</a>
- <li ><a href="rxvtRef.html#Graphics">Special Graphics Mode</a>
- <li ><a href="rxvtRef.html#KeyCodes">Key Codes</a>
- </dl>
- <p>Reworked from XTerm documentation and other sources
- <a name="rxvtRef-definitions.yo"></a>
-
- <a name="Definitions"></a>
- <h2>Definitions</h2>
-
- <p><dl>
- <dt><strong><code>c</code></strong></dt><dd>The literal character c.</dd>
- <p><dt><strong><code>C</code></strong></dt><dd>A single (required) character.</dd>
- <p><dt><strong><code>Ps</code></strong></dt><dd>A single (usually optional) numeric parameter, composed of one or
- more digits.</dd>
- <p><dt><strong><code>Pm</code></strong></dt><dd>A multiple numeric parameter composed of any number of single numeric
- parameters, separated by ; character(s).</dd>
- <p><dt><strong><code>Pt</code></strong></dt><dd>A text parameter composed of printable characters.</dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-values.yo"></a>
-
- <a name="Values"></a>
- <h2>Values</h2>
-
- <p><dl>
- <dt><strong><code>ENQ</code></strong></dt><dd>Enquiry (Ctrl-E) = Send Device Attributes (DA) <br>request attributes from terminal == <a href="rxvtRef.html#ESCOBPsc">ESC[Psc</a></dd>
- <p><dt><strong><code>BEL</code></strong></dt><dd>Bell (Ctrl-G)</dd>
- <p><dt><strong><code>BS</code></strong></dt><dd>Backspace (Ctrl-H)</dd>
- <p><dt><strong><code>TAB</code></strong></dt><dd>Horizontal Tab (HT) (Ctrl-I)</dd>
- <p><dt><strong><code>LF</code></strong></dt><dd>Line Feed or New Line (NL) (Ctrl-J)</dd>
- <p><dt><strong><code>VT</code></strong></dt><dd>Vertical Tab (Ctrl-K) same as <strong><code>LF</code></strong></dd>
- <p><dt><strong><code>FF</code></strong></dt><dd>Form Feed or New Page (NP) (Ctrl-L) same as <strong><code>LF</code></strong></dd>
- <p><dt><strong><code>CR</code></strong></dt><dd>Carriage Return (Ctrl-M)</dd>
- <p><dt><strong><code>SO</code></strong></dt><dd>Shift Out (Ctrl-N), invokes the G1 character set. <br>Switch to Alternate Character Set</dd>
- <p><dt><strong><code>SI</code></strong></dt><dd>Shift In (Ctrl-O), invokes the G0 character set (the default) <br>Switch to Standard Character Set</dd>
- <p><dt><strong><code>SPC</code></strong></dt><dd>Space Character</dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-sequences.yo"></a>
-
- <a name="Sequences"></a>
- <h2>Escape Sequences</h2>
-
- <p><dl>
- <dt><strong><code>ESC # 8</code></strong></dt><dd>DEC Screen Alignment Test (DECALN)</dd>
- <p><dt><strong><code>ESC 7</code><br><code>ESC 8</code></strong></dt><dd>Save Cursor (SC)<br>Restore Cursor</dd><p><a name="ESCequals"></a>
- <dt><strong><code>ESC =</code><br><code>ESC ></code></strong></dt><dd>Application Keypad (SMKX) == <a href="rxvtRef.html#Priv66"><code>ESC[?66h</code></a><br>Normal Keypad (RMKX) == <a href="rxvtRef.html#Priv66"><code>ESC[?66l</code></a></dd><br><strong>Note:</strong> If the numeric keypad is activated, eg, <strong>Num_Lock</strong> has been
- pressed, numbers or control functions are generated by the numeric keypad
- (see <a href="rxvtRef.html#KeyCodes">Key Codes</a>)
- <p><dt><strong><code>ESC D</code></strong></dt><dd>Index (IND)</dd>
- <p><dt><strong><code>ESC E</code></strong></dt><dd>Next Line (NEL)</dd>
- <p><dt><strong><code>ESC H</code></strong></dt><dd>Tab Set (HTS)</dd>
- <p><dt><strong><code>ESC M</code></strong></dt><dd>Reverse Index (RI)</dd>
- <p><dt><strong><code>ESC N</code></strong></dt><dd>Single Shift Select of G2 Character Set (SS2): affects next character
- only <em>unimplemented</em></dd>
- <p><dt><strong><code>ESC O</code></strong></dt><dd>Single Shift Select of G3 Character Set (SS3): affects next character
- only <em>unimplemented</em></dd>
- <p><dt><strong><code>ESC Z</code></strong></dt><dd>Obsolete form of <a href="rxvtRef.html#ESCOBPsc"><code>ESC[c</code></a> <br>returns: <strong><code>ESC[?1;2C</code></strong> <em>rxvt compile-time option</em></dd>
- <p><dt><strong><code>ESC c</code></strong></dt><dd>Full reset (RIS)</dd>
- <p><dt><strong><code>ESC n</code></strong></dt><dd>Invoke the G2 Character Set (LS2)</dd>
- <p><dt><strong><code>ESC o</code></strong></dt><dd>Invoke the G3 Character Set (LS3)</dd>
- <p><dt><strong><code>ESC </code>(<code> C</code><br><code>ESC </code>)<code> C</code><br><code>ESC * C</code><br><code>ESC + C</code><br><code>ESC $ C</code></strong></dt><dd>Designate G0 Character Set (ISO 2022)<br>Designate G1 Character Set (ISO 2022)<br>Designate G2 Character Set (ISO 2022)<br>Designate G3 Character Set (ISO 2022)<br>Designate Kanji Character Set <br><em>where</em> <strong><code>C</code></strong> is <br><table>
- <tr>
- <td> <strong><code>C = 0</code></strong> </td>
- <td> DEC Special Character and Line Drawing Set <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>C = A</code></strong> </td>
- <td> United Kingdom (UK) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>C = B</code></strong> </td>
- <td> United States (USASCII) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>C = <</code></strong> </td>
- <td> Multinational character set <em>unimplemented</em> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>C = 5</code></strong> </td>
- <td> Finnish character set <em>unimplemented</em> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>C = C</code></strong> </td>
- <td> Finnish character set <em>unimplemented</em> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>C = K</code></strong> </td>
- <td> German character set <em>unimplemented</em> <br></td>
-
- </tr>
- </table> </dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-csi.yo"></a>
-
- <a name="CSI"></a>
- <h2>CSI (Code Sequence Introducer) Sequences</h2>
-
- <p><dl>
- <dt><strong><code>ESC [ Ps @</code></strong></dt><dd>Insert <strong><code>Ps</code></strong> (Blank) Character(s) [default: 1] (ICH)</dd><p><a name="ESCOBPsA"></a>
- <dt><strong><code>ESC [ Ps A</code></strong></dt><dd>Cursor Up <strong><code>Ps</code></strong> Times [default: 1] (CUU)</dd>
- <p><dt><strong><code>ESC [ Ps B</code></strong></dt><dd>Cursor Down <strong><code>Ps</code></strong> Times [default: 1] (CUD)</dd><a name="ESCOBPsC"></a>
- <dt><strong><code>ESC [ Ps C</code></strong></dt><dd>Cursor Forward <strong><code>Ps</code></strong> Times [default: 1] (CUF)</dd>
- <p><dt><strong><code>ESC [ Ps D</code></strong></dt><dd>Cursor Backward <strong><code>Ps</code></strong> Times [default: 1] (CUB)</dd>
- <p><dt><strong><code>ESC [ Ps E</code></strong></dt><dd>Cursor Down <strong><code>Ps</code></strong> Times [default: 1] and to first column</dd>
- <p><dt><strong><code>ESC [ Ps F</code></strong></dt><dd>Cursor Up <strong><code>Ps</code></strong> Times [default: 1] and to first column</dd><p><a name="ESCOBPsG"></a>
- <dt><strong><code>ESC [ Ps G</code></strong></dt><dd>Cursor to Column <strong><code>Ps</code></strong> (HPA)</dd>
- <p><dt><strong><code>ESC [ Ps;Ps H</code></strong></dt><dd>Cursor Position [row;column] [default: 1;1] (CUP)</dd>
- <p><dt><strong><code>ESC [ Ps I</code></strong></dt><dd>Move forward <strong><code>Ps</code></strong> tab stops [default: 1]</dd>
- <p><dt><strong><code>ESC [ Ps J</code></strong></dt><dd>Erase in Display (ED) <br><table>
- <tr>
- <td> <strong><code>Ps = 0</code></strong> </td>
- <td> Clear Below (default) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 1</code></strong> </td>
- <td> Clear Above <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 2</code></strong> </td>
- <td> Clear All <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>ESC [ Ps K</code></strong></dt><dd>Erase in Line (EL) <br><table>
- <tr>
- <td> <strong><code>Ps = 0</code></strong> </td>
- <td> Clear to Right (default) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 1</code></strong> </td>
- <td> Clear to Left <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 2</code></strong> </td>
- <td> Clear All <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>ESC [ Ps L</code></strong></dt><dd>Insert <strong><code>Ps</code></strong> Line(s) [default: 1] (IL)</dd>
- <p><dt><strong><code>ESC [ Ps M</code></strong></dt><dd>Delete <strong><code>Ps</code></strong> Line(s) [default: 1] (DL)</dd>
- <p><dt><strong><code>ESC [ Ps P</code></strong></dt><dd>Delete <strong><code>Ps</code></strong> Character(s) [default: 1] (DCH)</dd>
- <p><dt><strong><code>ESC [ Ps;Ps;Ps;Ps;Ps T</code></strong></dt><dd>Initiate <a href="rxvtRef.html#Mouse">hilite mouse tracking</a>. <em>unimplemented</em>
- Parameters are [func;startx;starty;firstrow;lastrow].</dd>
- <p><dt><strong><code>ESC [ Ps W</code></strong></dt><dd>Tabulator functions <br><table>
- <tr>
- <td> <strong><code>Ps = 0</code></strong> </td>
- <td> Tab Set (HTS) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 2</code></strong> </td>
- <td> Tab Clear (TBC), Clear Current Column (default) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 5</code></strong> </td>
- <td> Tab Clear (TBC), Clear All <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>ESC [ Ps X</code></strong></dt><dd>Erase <strong><code>Ps</code></strong> Character(s) [default: 1] (ECH)</dd>
- <p><dt><strong><code>ESC [ Ps Z</code></strong></dt><dd>Move backward <strong><code>Ps</code></strong> [default: 1] tab stops</dd>
- <p><dt><strong><code>ESC [ Ps '</code></strong></dt><dd>== <a href="rxvtRef.html#ESCOBPsG"><code>ESC [ Ps G</code></a></dd>
- <p><dt><strong><code>ESC [ Ps a</code></strong></dt><dd>== <a href="rxvtRef.html#ESCOBPsC"><code>ESC [ Ps C</code></a></dd><p><a name="ESCOBPsc"></a>
- <dt><strong><code>ESC [ Ps c</code></strong></dt><dd>Send Device Attributes (DA)<br><strong><code>Ps = 0</code></strong> (or omitted) : request attributes from terminal <br>returns: <strong><code>ESC[?1;2c</code></strong> (``I am a VT100 with Advanced Video
- Option'')</dd>
- <p><dt><strong><code>ESC [ Ps d</code></strong></dt><dd>Cursor to Line <strong><code>Ps</code></strong> (VPA)</dd>
- <p><dt><strong><code>ESC [ Ps e</code></strong></dt><dd>== <a href="rxvtRef.html#ESCOBPsA">ESC [ Ps A</a></dd>
- <p><dt><strong><code>ESC [ Ps;Ps f</code></strong></dt><dd>Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]</dd>
- <p><dt><strong><code>ESC [ Ps g</code></strong></dt><dd>Tab Clear (TBC) <br><table>
- <tr>
- <td> <strong><code>Ps = 0</code></strong> </td>
- <td> Clear Current Column (default) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 3</code></strong> </td>
- <td> Clear All (TBC) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>ESC [ Ps i</code></strong></dt><dd>Printing <br><table>
- <tr>
- <td> <strong><code>Ps = 4</code></strong> </td>
- <td> disable transparent print mode (MC4) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 5</code></strong> </td>
- <td> enable transparent print mode (MC5) <em>unimplemented</em> <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>ESC [ Pm h</code><br><code>ESC [ Pm l</code></strong></dt><dd>Set Mode (SM) <br>Reset Mode (RM)<dl>
- <dt><strong><code>Ps = 4</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Insert Mode (SMIR) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Replace Mode (RMIR) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 20</code></strong> <em>unimplemented</em></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Automatic Newline (LNM) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Normal Linefeed (LNM) <br></td>
-
- </tr>
- </table> </dd>
- </dl></dd>
- <dt><strong><code>ESC [ Pm m</code></strong></dt><dd>Character Attributes (SGR) <br><table>
- <tr>
- <td> <strong><code>Ps = 0</code></strong> </td>
- <td> Normal (default) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 1 / 22</code></strong> </td>
- <td> On / Off Bold (bright fg) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 4 / 24</code></strong> </td>
- <td> On / Off Underline <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 5 / 25</code></strong> </td>
- <td> On / Off Blink (bright bg) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 7 / 27</code></strong> </td>
- <td> On / Off Inverse <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 30 / 40</code></strong> </td>
- <td> fg/bg Black <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 31 / 41</code></strong> </td>
- <td> fg/bg Red <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 32 / 42</code></strong> </td>
- <td> fg/bg Green <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 33 / 43</code></strong> </td>
- <td> fg/bg Yellow <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 34 / 44</code></strong> </td>
- <td> fg/bg Blue <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 35 / 45</code></strong> </td>
- <td> fg/bg Magenta <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 36 / 46</code></strong> </td>
- <td> fg/bg Cyan <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 37 / 47</code></strong> </td>
- <td> fg/bg White <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 39 / 49</code></strong> </td>
- <td> fg/bg Default <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>ESC [ Ps n</code></strong></dt><dd>Device Status Report (DSR) <br><table>
- <tr>
- <td> <strong><code>Ps = 5</code></strong> </td>
- <td> Status Report <strong><code>ESC [ 0 n</code></strong> (``OK'') <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 6</code></strong> </td>
- <td> Report Cursor Position (CPR) [row;column] as <strong><code>ESC [ r ; c R</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 7</code></strong> </td>
- <td> Request Display Name <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 8</code></strong> </td>
- <td> Request Version Number (place in window title) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>ESC [ Ps;Ps r</code></strong></dt><dd>Set Scrolling Region [top;bottom] <br>[default: full size of window] (CSR)</dd>
- <p><dt><strong><code>ESC [ s</code></strong></dt><dd>Save Cursor (SC)</dd>
- <p><dt><strong><code>ESC [ Ps x</code></strong></dt><dd>Request Terminal Parameters (DECREQTPARM)</dd>
- <p><dt><strong><code>ESC [ u</code></strong></dt><dd>Restore Cursor</dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-privatemodes.yo"></a>
-
- <a name="PrivateModes"></a>
- <h2>DEC Private Modes</h2>
-
- <p><dl>
- <dt><strong><code>ESC [ ? Pm h</code></strong></dt><dd>DEC Private Mode Set (DECSET)</dd>
- <p><dt><strong><code>ESC [ ? Pm l</code></strong></dt><dd>DEC Private Mode Reset (DECRST)</dd>
- <p><dt><strong><code>ESC [ ? Pm r</code></strong></dt><dd>Restore previously saved DEC Private Mode Values.</dd>
- <p><dt><strong><code>ESC [ ? Pm s</code></strong></dt><dd>Save DEC Private Mode Values.</dd>
- <p><dt><strong><code>ESC [ ? Pm t</code></strong></dt><dd>Toggle DEC Private Mode Values (rxvt extension).</dd>
- <em>where</em> <br><dl>
- <dt><strong><code>Ps = 1</code></strong> (DECCKM)</dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Application Cursor Keys <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Normal Cursor Keys <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 2</code></strong> (ANSI/VT52 mode)</dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Enter VT52 mode <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Enter VT52 mode <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 3</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> 132 Column Mode (DECCOLM) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> 80 Column Mode (DECCOLM) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 4</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Smooth (Slow) Scroll (DECSCLM) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Jump (Fast) Scroll (DECSCLM) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 5</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Reverse Video (DECSCNM) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Normal Video (DECSCNM) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 6</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Origin Mode (DECOM) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Normal Cursor Mode (DECOM) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 7</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Wraparound Mode (DECAWM) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> No Wraparound Mode (DECAWM) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 8</code></strong> <em>unimplemented</em></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Auto-repeat Keys (DECARM) <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> No Auto-repeat Keys (DECARM) <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 9</code></strong> X10 XTerm <a href="rxvtRef.html#Mouse">mouse reporting</a></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Send Mouse X & Y on button press. <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> No mouse reporting. <br></td>
-
- </tr>
- </table> </dd><a name="Priv10"></a>
- <dt><strong><code>Ps = 10</code></strong> (<strong>rxvt</strong>)</dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> <a href="rxvtRef.html#menuBar">menuBar</a> visible <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> <a href="rxvtRef.html#menuBar">menuBar</a> invisible <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 25</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Visible cursor {cnorm/cvvis} <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Invisible cursor {civis} <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 30</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> scrollBar visisble <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> scrollBar invisisble <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 35</code></strong> (<strong>rxvt</strong>)</dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Allow XTerm Shift+key sequences <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Disallow XTerm Shift+key sequences <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 38</code></strong> <em>unimplemented</em></dt><dd>Enter Tektronix Mode (DECTEK)</dd>
- <dt><strong><code>Ps = 40</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Allow 80/132 Mode <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Disallow 80/132 Mode <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 44</code></strong> <em>unimplemented</em></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Turn On Margin Bell <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Turn Off Margin Bell <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 45</code></strong> <em>unimplemented</em></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Reverse-wraparound Mode <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> No Reverse-wraparound Mode <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 46</code></strong> <em>unimplemented</em></dt><dd></dd>
- <p><dt><strong><code>Ps = 47</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Use Alternate Screen Buffer <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Use Normal Screen Buffer <br></td>
-
- </tr>
- </table> </dd>
- <a name="Priv66"></a>
- <dt><strong><code>Ps = 66</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Application Keypad (DECPAM) == <a href="rxvtRef.html#ESCequals"><code>ESC =</code></a> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Normal Keypad (DECPNM) == <a href="rxvtRef.html#ESCequals"><code>ESC ></code></a> <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 67</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Backspace key sends <strong><code>BS</code> (DECBKM)</strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Backspace key sends <strong><code>DEL</code></strong> <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 1000</code></strong> (X11 XTerm <a href="rxvtRef.html#Mouse">mouse reporting</a>)</dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Send Mouse X & Y on button press and release. <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> No mouse reporting. <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 1001</code></strong> (X11 XTerm <a href="rxvtRef.html#Mouse">mouse tracking</a>) <em>unimplemented</em></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Use Hilite Mouse Tracking. <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> No mouse reporting. <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 1010</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Don't scroll to bottom on TTY output <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Scroll to bottom on TTY output <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 1011</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Scroll to bottom when a key is pressed <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Don't scroll to bottom when a key is pressed <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 1047</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Use Alternate Screen Buffer <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it <br></td>
-
- </tr>
- </table> </dd>
- <dt><strong><code>Ps = 1048</code></strong></dt><dd><table>
- <tr>
- <td> <strong><code>h</code></strong> </td>
- <td> Save cursor position <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>l</code></strong> </td>
- <td> Restore cursor position <br></td>
-
- </tr>
- </table> </dd>
- </dl>
- </dl>
- <p>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-xterm.yo"></a>
-
- <a name="XTerm"></a>
- <h2>XTerm Operating System Commands</h2>
-
- <p><dl>
- <dt><strong><code>ESC ] Ps;Pt ST</code></strong></dt><dd>Set XTerm Parameters <br>8-bit ST: 0x9c, <br>7-bit ST sequence: ESC \ (0x1b, 0x5c), <br>backwards compatible terminator BEL (0x07) is also accepted. <br><table>
- <tr>
- <td> <strong><code>Ps = 0</code></strong> </td>
- <td> Change Icon Name and Window Title to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 1</code></strong> </td>
- <td> Change Icon Name to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 2</code></strong> </td>
- <td> Change Window Title to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 4</code></strong> </td>
- <td> <strong><code>Pt</code></strong> is a semi-colon separated sequence of one or more semi-colon separated <strong>number</strong>/<strong>name</strong> pairs, where <strong>number</strong> is an index to a colour and <strong>name</strong> is the name of a colour. Each pair causes the <strong>number</strong>ed colour to be changed to <strong>name</strong>. <br>Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 10</code></strong> <strong>(NB: may change in future)</strong> </td>
- <td> <a href="rxvtRef.html#menuBar">menuBar</a> command <strong><code>Pt</code></strong> <em>rxvt compile-time option</em> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 12</code></strong> </td>
- <td> Change colour of text cursor foreground to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 13</code></strong> </td>
- <td> Change colour of mouse foreground to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 17</code></strong> </td>
- <td> Change colour of highlight characters to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 18</code></strong> </td>
- <td> Change colour of bold characters to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 19</code></strong> </td>
- <td> Change colour of underlined characters to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 20</code></strong> </td>
- <td> Change default background <a href="rxvtRef.html#XPM">pixmap</a> to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 39</code></strong> </td>
- <td> Change default foreground colour to <strong><code>Pt</code></strong> <em>rxvt compile-time option</em> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 46</code></strong> </td>
- <td> Change Log File to <strong><code>Pt</code></strong> <em>unimplemented</em> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 49</code></strong> </td>
- <td> Change default background colour to <strong><code>Pt</code></strong> <em>rxvt compile-time option</em> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 50</code></strong> </td>
- <td> Set Font to <strong><code>Pt</code></strong>, with the following special values of <strong><code>Pt</code></strong> (<strong>rxvt</strong>) <br><strong><code>#+n</code></strong> change up <strong><code>n</code></strong> font(s) <br><strong><code>#-n</code></strong> change down <strong><code>n</code></strong> font(s) <br>if <strong><code>n</code></strong> is missing of 0, a value of 1 is used <br><em>empty</em> change to font0 <br><strong><code>n</code></strong> change to font <strong><code>n</code></strong> <br></td>
-
- </tr>
- <tr>
- <td> <strong><code>Ps = 55</code></strong> </td>
- <td> Log all scrollback buffer and all of screen to <strong><code>Pt</code></strong> <br></td>
-
- </tr>
- </table> </dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-menubar.yo"></a>
-
- <a name="menuBar"></a>
- <h2>menuBar</h2>
-
- <p><strong>The exact syntax used is <em>almost</em> solidified.</strong> <br>In the menus, <strong>DON'T</strong> try to use menuBar commands that add or remove a
- menuBar.
- <p>Note that in all of the commands, the <strong><em>/path/</em></strong> <em>cannot</em> be omitted:
- use <strong>./</strong> to specify a menu relative to the current menu.
- <p><h3>Overview of menuBar operation</h3><p>
- <p>For the menuBar XTerm escape sequence <code>ESC ] 10 ; Pt ST</code>, the
- syntax of <code>Pt</code> can be used for a variety of tasks:
- <dl>
- <li ><a href="rxvtRef.html#menuBarCommands">Commands</a>
- <li ><a href="rxvtRef.html#menuBarAdd">Adding and accessing menus</a>
- <li ><a href="rxvtRef.html#menuBarRemove">Removing menus</a>
- <li ><a href="rxvtRef.html#menuBarArrows">Quick Arrows</a>
- <li ><a href="rxvtRef.html#menuBarSummary">Command Summary</a>
- </dl>
- <p>At the top level is the current menuBar which is a member of a circular
- linked-list of other such menuBars.
- <p>The menuBar acts as a parent for the various drop-down menus, which in turn,
- may have labels, separator lines, menuItems and subMenus.
- <p>The menuItems are the useful bits: you can use them to mimic keyboard input
- or even to send text or escape sequences back to rxvt.
- <p>The menuBar syntax is intended to provide a simple yet robust method of
- constructing and manipulating menus and navigating through the menuBars.
- <p>The first step is to use the tag <strong>[menu:<em>name</em>]</strong> which creates the
- menuBar called <em>name</em> and allows access.
- You may now <a href="rxvtRef.html#menuBarAdd">add</a> or <a href="rxvtRef.html#menuBarRemove">remove</a> menus,
- subMenus, and menuItems. Finally, use the tag <strong>[done]</strong> to set the menuBar
- access as <strong>readonly</strong> to prevent accidental corruption of the menus.
- To re-access the current menuBar for alterations, use the tag <strong>[menu]</strong>,
- make the alterations and then use <strong>[done]</strong>
- <p><a name="menuBarCommands"></a>
- <h3>Commands</h3><p>
- <p><dl>
- <dt><strong>[menu:<em>name</em>]</strong></dt><dd>access the named menuBar for creation or alteration. If a new menuBar
- is created, it is called <em>name</em> (max of 15 chars) and the current
- menuBar is pushed onto the stack</dd>
- <p><dt><strong>[menu]</strong></dt><dd>access the current menuBar for alteration</dd>
- <p><dt><strong>[title:<em>string</em>]</strong></dt><dd>set the current menuBar's title to <em>string</em>, which may contain the
- following format specifiers: <br><strong>%%</strong> : literal <strong>%</strong> character <br><strong>%n</strong> : rxvt name (as per the <strong>-name</strong> command-line option) <br><strong>%v</strong> : rxvt version</dd>
- <p><dt><strong>[done]</strong></dt><dd>set menuBar access as <strong>readonly</strong>. <br>End-of-file tag for <strong>[read:<em>file</em>]</strong> operations.</dd>
- <p><dt><strong>[read:<em>file</em>]</strong></dt><dd>read menu commands directly from <em>file</em> (extension ".menu" will be
- appended if required.) Start reading at a line with <strong>[menu]</strong> or
- <strong>[menu:<em>name</em></strong> and continuing until <strong>[done]</strong> is encountered.
- <p>Blank and comment lines (starting with <strong>#</strong>) are ignored.
- Actually, since any invalid menu commands are also ignored, almost
- anything could be construed as a comment line, but this may be
- tightened up in the future ... so don't count on it!.</dd>
- <p><dt><strong>[read:<em>file</em>;<em>name</em>]</strong></dt><dd>The same as <strong>[read:<em>file</em>]</strong>, but start reading at a line with
- <strong>[menu:<em>name</em>]</strong> and continuing until <strong>[done:<em>name</em>]</strong> or
- <strong>[done]</strong> is encountered.</dd>
- <p><dt><strong>[dump]</strong></dt><dd>dump all menuBars to the file <strong>/tmp/rxvt-PID</strong> in a format suitable
- for later rereading.</dd>
- <p><dt><strong>[rm:name]<br>[rm] [rm:]<br>[rm*] [rm:*]</strong></dt><dd>remove the named menuBar <br>remove the current menuBar <br>remove all menuBars</dd>
- <p><dt><strong>[swap]</strong></dt><dd>swap the top two menuBars</dd>
- <p><dt><strong>[prev]<br>[next]</strong></dt><dd>access the previous or next menuBar</dd>
- <p><dt><strong>[show]<br>[hide]</strong></dt><dd>control display of the menuBar ... just like
- <a href="rxvtRef.html#Priv10">ESC[?10 h/l</a></dd>
- <p><dt><strong>[pixmap:<em>name</em>]<br>[pixmap:<em>name</em>;<em>scaling</em>]</strong></dt><dd>set the background pixmap globally ... just like
- <a href="rxvtRef.html#XPM">ESC ] 20 ; Pt ST</a>
- <p><strong>A Future implementation <em>may</em> make this local to the menubar</strong></dd>
- <p><dt><strong>[:<em>command</em>:]</strong></dt><dd>ignore the menu readonly status and issue a <em>command</em> to
- <a href="rxvtRef.html#menuBarAdd">Add/Modify</a> or <a href="rxvtRef.html#menuBarRemove">Remove</a> a menu or
- menuitem or change the <a href="rxvtRef.html#menuBarArrows">Quick Arrows</a>; a useful
- shortcut for setting the quick arrows from a menuBar.</dd>
- </dl>
- <p><a name="menuBarAdd"></a>
- <h3>Adding and accessing menus</h3><p>
- <p>The following commands may also be <strong>+</strong> prefixed.
- <dl>
- <dt><strong>/<br>./<br>../<br>../../</strong></dt><dd>access menuBar top level <br>access current menu level <br>access parent menu (1 level up) <br>access parent menu (multiple levels up)</dd>
- <dt><strong><em>/path/</em>menu</strong></dt><dd>add/access menu</dd>
- <dt><strong><em>/path/</em>menu/*</strong></dt><dd>add/access menu and clear it if it exists</dd>
- <dt><strong><em>/path/</em>{-}</strong></dt><dd>add separator</dd>
- <dt><strong><em>/path/</em>{item}</strong></dt><dd>add <strong>item</strong> as a label</dd>
- <dt><strong><em>/path/</em>{item} action</strong></dt><dd>add/alter <em>menuitem</em> with an associated <em>action</em></dd>
- <dt><strong><em>/path/</em>{item}{right-text}</strong></dt><dd>add/alter <em>menuitem</em> with <strong>right-text</strong> as the right-justified
- text and as the associated <em>action</em></dd>
- <dt><strong><em>/path/</em>{item}{rtext} action</strong></dt><dd>add/alter <em>menuitem</em> with an associated <em>action</em> and with
- <strong>rtext</strong> as the right-justified text.</dd>
- </dl>
- <dl>
- <dt>Special characters in <em>action</em> must be backslash-escaped:</dt><dd><strong>\a \b \E \e \n \r \t \octal</strong></dd>
- <dt>or in control-character notation:</dt><dd><strong>^@, ^A .. ^Z .. ^_, ^?</strong></dd>
- </dl>
- <p>To send a string starting with a <strong>NUL</strong> (<strong>^@</strong>) character to the program,
- start <em>action</em> with a pair of <strong>NUL</strong> characters (<strong>^@^@</strong>), the first of
- which will be stripped off and the balance directed to the program.
- Otherwise if <em>action</em> begins with <strong>NUL</strong> followed by non-<strong>NUL</strong>
- characters, the leading <strong>NUL</strong> is stripped off and the balance is sent back
- to rxvt.
- <p>As a convenience for the many Emacs-type editors, <em>action</em> may start
- with <strong>M-</strong> (eg, <strong>M-$</strong> is equivalent to <strong>\E$</strong>) and a <strong>CR</strong> will be
- appended if missed from <strong>M-x</strong> commands.
- <p>As a convenience for issuing XTerm <strong>ESC]</strong> sequences from a menubar
- (or quick arrow), a <strong>BEL</strong> (<strong>^G</strong>) will be appended if needed.
- <p><dl>
- <dt>For example,</dt><dd><strong>M-xapropos</strong> is equivalent to <strong>\Exapropos\r</strong></dd>
- <dt>and</dt><dd><strong>\E]10;mona;100</strong> is equivalent to <strong>\E]10;mona;100\a</strong></dd>
- </dl>
- <p>The option <strong>{<em>right-rtext</em>}</strong> will be right-justified. In the absence of
- a specified action, this text will be used as the <em>action</em> as well.
- <p><dl>
- <dt>For example,</dt><dd><strong>/File/{Open}{^X^F}</strong> is equivalent to <strong>/File/{Open}{^X^F} ^X^F</strong></dd>
- </dl>
- <p>The left label <em>is</em> necessary, since it's used for matching,
- but implicitly hiding the left label (by using same name for both left
- and right labels), or explicitly hiding the left label (by preceeding
- it with a dot), makes it possible to have right-justified text only.
- <dl>
- <dt>For example,</dt><dd><strong>/File/{Open}{Open} Open-File-Action</strong></dd>
- <dt>or hiding it</dt><dd><strong>/File/{.anylabel}{Open} Open-File-Action</strong></dd>
- </dl>
- <p><a name="menuBarRemove"></a>
- <h3>Removing menus</h3><p>
- <p><dl>
- <dt><strong>-/*<br>-<em>/path</em>menu<br>-<em>/path</em>{item}<br>-<em>/path</em>{-}</strong></dt><dd>remove all menus from the menuBar, the same as <strong>[clear]</strong><br>remove menu <br>remove item <br>remove separator</dd>
- <dt><strong>-/path/menu/*</strong></dt><dd>remove all items, separators and submenus from menu</dd>
- </dl>
- <p><a name="menuBarArrows"></a>
- <h3>Quick Arrows</h3><p>
- <p>The menus also provide a hook for <em>quick arrows</em> to provide easier user
- access. If nothing has been explicitly set, the default is to emulate the
- curror keys. The syntax permits each arrow to be altered individually or
- all four at once without re-entering their common beginning/end text. For
- example, to explicitly associate cursor actions with the arrows, any of
- the following forms could be used:
- <p><dl>
- <dt><strong><r><em>Right</em><br><l><em>Left</em><br><u><em>Up</em><br><d><em>Down</em></strong></dt><dd>Define actions for the respective arrow buttons</dd>
- <dt><strong><b><em>Begin</em><br><e><em>End</em></strong></dt><dd>Define common beginning/end parts for <em>quick arrows</em> which used
- in conjunction with the above <r> <l> <u> <d> constructs</dd>
- </dl>
- <p><dl>
- <dt>For example, define arrows individually,</dt><dd><strong><u>\E[A <br><d>\E[B <br><r>\E[C <br><l>\E[D</strong></dd>
- <dt>or all at once</dt><dd><strong><u>\E[A<d>\E[B<r>\E[C<l>\E[D</strong></dd>
- <dt>or more compactly (factoring out common parts)</dt><dd><strong><b>\E[<u>A<d>B<r>C<l>D</strong></dd>
- </dl>
- <p><a name="menuBarSummary"></a>
- <h3>Command Summary</h3><p>
- <p>A short summary of the most <em>common</em> commands:
- <p><dl>
- <dt>[menu:name]</dt><dd>use an existing named menuBar or start a new one</dd>
- <dt>[menu]</dt><dd>use the current menuBar</dd>
- <dt>[title:string]</dt><dd>set menuBar title</dd>
- <dt>[done]</dt><dd>set menu access to readonly and, if reading from a file, signal EOF</dd>
- <dt>[done:name]</dt><dd>if reading from a file using [read:file;name] signal EOF</dd>
- <dt>[rm:name]<br>[rm] [rm:]<br>[rm*] [rm:*]</dt><dd>remove named, current, or all menuBar(s)</dd>
- <dt>[swap]</dt><dd>swap top two menuBars</dd>
- <dt>[prev]<br>[next]</dt><dd>access the previous/next menuBar</dd>
- <dt>[show]<br>[hide]</dt><dd>map/unmap menuBar</dd>
- <dt>[pixmap;file]<br>[pixmap;file;scaling]</dt><dd>set a background pixmap</dd>
- <dt>[read:file]<br>[read:file;name]</dt><dd>read in a menu from a file</dd>
- <dt>[dump]</dt><dd>dump out all menuBars to /tmp/rxvt-PID</dd>
- <dt>/</dt><dd>access menuBar top level</dd>
- <dt>./<br>../<br>../../</dt><dd>access current or parent menu level</dd>
- <dt>/path/menu</dt><dd>add/access menu</dd>
- <dt>/path/{-}</dt><dd>add separator</dd>
- <dt>/path/{item}{rtext} action</dt><dd>add/alter menu item<br>({rtext} and/or action, may be omitted)</dd>
- <dt>-/*</dt><dd>remove all menus from the menuBar</dd>
- <dt>-/path/menu</dt><dd>remove menu items, separators and submenus from menu</dd>
- <dt>-/path/menu</dt><dd>remove menu</dd>
- <dt>-/path/{item}</dt><dd>remove item</dd>
- <dt>-/path/{-}</dt><dd>remove separator</dd>
- <dt><b>Begin<r>Right<l>Left<u>Up<d>Down<e>End</dt><dd>menu quick arrows</dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-xpm.yo"></a>
-
- <a name="XPM"></a>
- <h2>XPM</h2>
-
- <p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code></strong> then value of
- <strong><code>Pt</code></strong> can be the name of the background pixmap followed by a sequence of
- scaling/positioning commands separated by semi-colons. The scaling/positioning
- commands are as follows:
- <p><dl>
- <dt>query scale/position</dt><dd><strong>?</strong></dd>
- <p><dt>change scale and position</dt><dd><strong>WxH+X+Y</strong><br><strong>WxH+X</strong> (== <strong>WxH+X+X</strong>)<br><strong>WxH</strong> (same as <strong>WxH+50+50</strong>)<br><strong>W+X+Y</strong> (same as <strong>WxW+X+Y</strong>)<br><strong>W+X</strong> (same as <strong>WxW+X+X</strong>)<br><strong>W</strong> (same as <strong>WxW+50+50</strong>)</dd>
- <p><dt>change position (absolute)</dt><dd><strong>=+X+Y</strong><br><strong>=+X</strong> (same as <strong>=+X+Y</strong>)</dd>
- <p><dt>change position (relative)</dt><dd><strong>+X+Y</strong><br><strong>+X</strong> (same as <strong>+X+Y</strong>)</dd>
- <p><dt>rescale (relative)</dt><dd><strong>Wx0</strong> -> <strong>W *= (W/100)</strong><br><strong>0xH</strong> -> <strong>H *= (H/100)</strong></dd>
- </dl>
- <p>For example:
- <p><dl>
- <dt><strong>\E]20;funky\a</strong></dt><dd>load <strong>funky.xpm</strong> as a tiled image</dd>
- <p><dt><strong>\E]20;mona;100\a</strong></dt><dd>load <strong>mona.xpm</strong> with a scaling of 100%</dd>
- <p><dt><strong>\E]20;;200;?\a</strong></dt><dd>rescale the current pixmap to 200% and display the image geometry in the title</dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-mouse.yo"></a>
-
- <a name="Mouse"></a>
- <h2>Mouse Reporting</h2>
-
- <p><dl>
- <dt><strong><code>ESC [ M <b> <x> <y></code></strong></dt><dd>report mouse position</dd>
- </dl>
- The lower 2 bits of <strong><code><b></code></strong> indicate the button:
- <dl>
- <dt>Button = <strong><code>(<b> - SPACE) & 3</code></strong></dt><dd>0 = Button1 pressed <br>1 = Button2 pressed <br>2 = Button3 pressed <br>3 = button released (X11 mouse report)</dd>
- </dl>
- <p>The upper bits of <strong><code><b></code></strong> indicate the modifiers when the button was
- pressed and are added together (X11 mouse report only):
- <p><dl>
- <dt>State = <strong><code>(<b> - SPACE) & 60</code></strong></dt><dd>4 = Shift <br>8 = Meta <br>16 = Control <br>32 = Double Click <em>(Rxvt extension)</em> <br>Col = <strong><code><x> - SPACE</code></strong> <br>Row = <strong><code><y> - SPACE</code></strong></dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-graphics.yo"></a>
-
- <a name="Graphics"></a>
- <h2>Special Graphics Mode</h2>
-
- <p>Add more documentation here, <em>if anyone actually cares.</em>
- <p><dl>
- <dt><strong><code>ESC G Q</code></strong></dt><dd>query if graphics are available <br>returns: <strong><code>ESC G 0</code></strong> no graphics available <br>returns: <strong><code>ESC G 1</code></strong> graphics available (colour only)</dd>
- <p><dt><strong><code>ESC G W <;x>;<y>;<w>;<h>:</code></strong></dt><dd>create window</dd>
- <p><dt><strong><code>ESC G C <id></code></strong></dt><dd>clear window</dd>
- <p><dt><strong><code>ESC G G <it>:</code></strong></dt><dd>query window <br>returns: <strong><code>ESC G <id> <x> <y> <w> <h> <fw> <fh> <nw> <nh></code></strong></dd>
- <p><dt><strong><code>ESC G L <id></code><br><code>ESC G P <id></code><br><code>ESC G F <id></code></strong></dt><dd>start point <br>start line <br>start fill</dd>
- <p><dt><strong><code>;<x>;<y></code></strong></dt><dd>extend point/line/fill</dd>
- <p><dt><strong><code>ESC G T <id>;<x>;<y>;<mode>;<len>:<text></code></strong></dt><dd>place text</dd>
- </dl>
- <a href="rxvtRef.html#toc">Top</a>
- <p><hr><p><br>
- <a name="rxvtRef-keycodes.yo"></a>
-
- <a name="KeyCodes"></a>
- <h2>Key Codes</h2>
-
- <p>Note: <strong>Shift</strong> + <strong>F1</strong>-<strong>F10</strong> generates <strong>F11</strong>-<strong>F20</strong>
- <p>For the keypad, use <strong>Shift</strong> to temporarily override Application-Keypad
- setting use <strong>Num_Lock</strong> to toggle Application-Keypad setting if <strong>Num_Lock</strong>
- is off, <a href="rxvtRef.html#ESCequals">escape sequences</a> toggle Application-Keypad setting.
- Also note that values of <strong>Home</strong>, <strong>End</strong>, <strong>Delete</strong> may have been compiled
- differently on your system.
- <p>
- <table border=1>
- <tr>
- <td> </td>
- <td> <strong>Normal</strong> </td>
- <td> <strong>Shift</strong> </td>
- <td> <strong>Control</strong> </td>
- <td> <strong>Ctrl+Shift</strong> <br></td>
-
- </tr>
- <tr>
- <td> Tab </td>
- <td> ^I </td>
- <td> ESC [ Z </td>
- <td> ^I </td>
- <td> ESC [ Z <br></td>
-
- </tr>
- <tr>
- <td> BackSpace </td>
- <td> ^H </td>
- <td> ^? </td>
- <td> ^? </td>
- <td> ^? <br></td>
-
- </tr>
- <tr>
- <td> Find </td>
- <td> ESC [ 1 ~ </td>
- <td> ESC [ 1 $ </td>
- <td> ESC [ 1 ^ </td>
- <td> ESC [ 1 @ <br></td>
-
- </tr>
- <tr>
- <td> Insert </td>
- <td> ESC [ 2 ~ </td>
- <td> <em>paste</em> </td>
- <td> ESC [ 2 ^ </td>
- <td> ESC [ 2 @ <br></td>
-
- </tr>
- <tr>
- <td> Execute </td>
- <td> ESC [ 3 ~ </td>
- <td> ESC [ 3 $ </td>
- <td> ESC [ 3 ^ </td>
- <td> ESC [ 3 @ <br></td>
-
- </tr>
- <tr>
- <td> Select </td>
- <td> ESC [ 4 ~ </td>
- <td> ESC [ 4 $ </td>
- <td> ESC [ 4 ^ </td>
- <td> ESC [ 4 @ <br></td>
-
- </tr>
- <tr>
- <td> Prior </td>
- <td> ESC [ 5 ~ </td>
- <td> <em>scroll-up</em> </td>
- <td> ESC [ 5 ^ </td>
- <td> ESC [ 5 @ <br></td>
-
- </tr>
- <tr>
- <td> Next </td>
- <td> ESC [ 6 ~ </td>
- <td> <em>scroll-down</em> </td>
- <td> ESC [ 6 ^ </td>
- <td> ESC [ 6 @ <br></td>
-
- </tr>
- <tr>
- <td> Home </td>
- <td> ESC [ 7 ~ </td>
- <td> ESC [ 7 $ </td>
- <td> ESC [ 7 ^ </td>
- <td> ESC [ 7 @ <br></td>
-
- </tr>
- <tr>
- <td> End </td>
- <td> ESC [ 8 ~ </td>
- <td> ESC [ 8 $ </td>
- <td> ESC [ 8 ^ </td>
- <td> ESC [ 8 @ <br></td>
-
- </tr>
- <tr>
- <td> Delete </td>
- <td> ESC [ 3 ~ </td>
- <td> ESC [ 3 $ </td>
- <td> ESC [ 3 ^ </td>
- <td> ESC [ 3 @ <br></td>
-
- </tr>
- <tr>
- <td> F1 </td>
- <td> ESC [ 11 ~ </td>
- <td> ESC [ 23 ~ </td>
- <td> ESC [ 11 ^ </td>
- <td> ESC [ 23 ^ <br></td>
-
- </tr>
- <tr>
- <td> F2 </td>
- <td> ESC [ 12 ~ </td>
- <td> ESC [ 24 ~ </td>
- <td> ESC [ 12 ^ </td>
- <td> ESC [ 24 ^ <br></td>
-
- </tr>
- <tr>
- <td> F3 </td>
- <td> ESC [ 13 ~ </td>
- <td> ESC [ 25 ~ </td>
- <td> ESC [ 13 ^ </td>
- <td> ESC [ 25 ^ <br></td>
-
- </tr>
- <tr>
- <td> F4 </td>
- <td> ESC [ 14 ~ </td>
- <td> ESC [ 26 ~ </td>
- <td> ESC [ 14 ^ </td>
- <td> ESC [ 26 ^ <br></td>
-
- </tr>
- <tr>
- <td> F5 </td>
- <td> ESC [ 15 ~ </td>
- <td> ESC [ 28 ~ </td>
- <td> ESC [ 15 ^ </td>
- <td> ESC [ 28 ^ <br></td>
-
- </tr>
- <tr>
- <td> F6 </td>
- <td> ESC [ 17 ~ </td>
- <td> ESC [ 29 ~ </td>
- <td> ESC [ 17 ^ </td>
- <td> ESC [ 29 ^ <br></td>
-
- </tr>
- <tr>
- <td> F7 </td>
- <td> ESC [ 18 ~ </td>
- <td> ESC [ 31 ~ </td>
- <td> ESC [ 18 ^ </td>
- <td> ESC [ 31 ^ <br></td>
-
- </tr>
- <tr>
- <td> F8 </td>
- <td> ESC [ 19 ~ </td>
- <td> ESC [ 32 ~ </td>
- <td> ESC [ 19 ^ </td>
- <td> ESC [ 32 ^ <br></td>
-
- </tr>
- <tr>
- <td> F9 </td>
- <td> ESC [ 20 ~ </td>
- <td> ESC [ 33 ~ </td>
- <td> ESC [ 20 ^ </td>
- <td> ESC [ 33 ^ <br></td>
-
- </tr>
- <tr>
- <td> F10 </td>
- <td> ESC [ 21 ~ </td>
- <td> ESC [ 34 ~ </td>
- <td> ESC [ 21 ^ </td>
- <td> ESC [ 34 ^ <br></td>
-
- </tr>
- <tr>
- <td> F11 </td>
- <td> ESC [ 23 ~ </td>
- <td> ESC [ 23 $ </td>
- <td> ESC [ 23 ^ </td>
- <td> ESC [ 23 @ <br></td>
-
- </tr>
- <tr>
- <td> F12 </td>
- <td> ESC [ 24 ~ </td>
- <td> ESC [ 24 $ </td>
- <td> ESC [ 24 ^ </td>
- <td> ESC [ 24 @ <br></td>
-
- </tr>
- <tr>
- <td> F13 </td>
- <td> ESC [ 25 ~ </td>
- <td> ESC [ 25 $ </td>
- <td> ESC [ 25 ^ </td>
- <td> ESC [ 25 @ <br></td>
-
- </tr>
- <tr>
- <td> F14 </td>
- <td> ESC [ 26 ~ </td>
- <td> ESC [ 26 $ </td>
- <td> ESC [ 26 ^ </td>
- <td> ESC [ 26 @ <br></td>
-
- </tr>
- <tr>
- <td> F15 (Help) </td>
- <td> ESC [ 28 ~ </td>
- <td> ESC [ 28 $ </td>
- <td> ESC [ 28 ^ </td>
- <td> ESC [ 28 @ <br></td>
-
- </tr>
- <tr>
- <td> F16 (Menu) </td>
- <td> ESC [ 29 ~ </td>
- <td> ESC [ 29 $ </td>
- <td> ESC [ 29 ^ </td>
- <td> ESC [ 29 @ <br></td>
-
- </tr>
- <tr>
- <td> F17 </td>
- <td> ESC [ 31 ~ </td>
- <td> ESC [ 31 $ </td>
- <td> ESC [ 31 ^ </td>
- <td> ESC [ 31 @ <br></td>
-
- </tr>
- <tr>
- <td> F18 </td>
- <td> ESC [ 32 ~ </td>
- <td> ESC [ 32 $ </td>
- <td> ESC [ 32 ^ </td>
- <td> ESC [ 32 @ <br></td>
-
- </tr>
- <tr>
- <td> F19 </td>
- <td> ESC [ 33 ~ </td>
- <td> ESC [ 33 $ </td>
- <td> ESC [ 33 ^ </td>
- <td> ESC [ 33 @ <br></td>
-
- </tr>
- <tr>
- <td> F20 </td>
- <td> ESC [ 34 ~ </td>
- <td> ESC [ 34 $ </td>
- <td> ESC [ 34 ^ </td>
- <td> ESC [ 34 @ <br></td>
-
- </tr>
- <tr>
- <td> </td>
- <td> </td>
- <td> </td>
- <td> </td>
- <td> <strong>Application</strong> <br></td>
-
- </tr>
- <tr>
- <td> Up </td>
- <td> ESC [ A </td>
- <td> ESC [ a </td>
- <td> ESC O a </td>
- <td> ESC O A <br></td>
-
- </tr>
- <tr>
- <td> Down </td>
- <td> ESC [ B </td>
- <td> ESC [ b </td>
- <td> ESC O b </td>
- <td> ESC O B <br></td>
-
- </tr>
- <tr>
- <td> Right </td>
- <td> ESC [ C </td>
- <td> ESC [ c </td>
- <td> ESC O c </td>
- <td> ESC O C <br></td>
-
- </tr>
- <tr>
- <td> Left </td>
- <td> ESC [ D </td>
- <td> ESC [ d </td>
- <td> ESC O d </td>
- <td> ESC O D <br></td>
-
- </tr>
- <tr>
- <td> KP_Enter </td>
- <td> ^M </td>
- <td> </td>
- <td> </td>
- <td> ESC O M <br></td>
-
- </tr>
- <tr>
- <td> KP_F1 </td>
- <td> ESC O P </td>
- <td> </td>
- <td> </td>
- <td> ESC O P <br></td>
-
- </tr>
- <tr>
- <td> KP_F2 </td>
- <td> ESC O Q </td>
- <td> </td>
- <td> </td>
- <td> ESC O Q <br></td>
-
- </tr>
- <tr>
- <td> KP_F3 </td>
- <td> ESC O R </td>
- <td> </td>
- <td> </td>
- <td> ESC O R <br></td>
-
- </tr>
- <tr>
- <td> KP_F4 </td>
- <td> ESC O S </td>
- <td> </td>
- <td> </td>
- <td> ESC O S <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_Multiply </td>
- <td> * </td>
- <td> </td>
- <td> </td>
- <td> ESC O j <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_Add </td>
- <td> + </td>
- <td> </td>
- <td> </td>
- <td> ESC O k <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_Separator </td>
- <td> , </td>
- <td> </td>
- <td> </td>
- <td> ESC O l <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_Subtract </td>
- <td> - </td>
- <td> </td>
- <td> </td>
- <td> ESC O m <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_Decimal </td>
- <td> . </td>
- <td> </td>
- <td> </td>
- <td> ESC O n <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_Divide </td>
- <td> / </td>
- <td> </td>
- <td> </td>
- <td> ESC O o <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_0 </td>
- <td> 0 </td>
- <td> </td>
- <td> </td>
- <td> ESC O p <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_1 </td>
- <td> 1 </td>
- <td> </td>
- <td> </td>
- <td> ESC O q <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_2 </td>
- <td> 2 </td>
- <td> </td>
- <td> </td>
- <td> ESC O r <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_3 </td>
- <td> 3 </td>
- <td> </td>
- <td> </td>
- <td> ESC O s <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_4 </td>
- <td> 4 </td>
- <td> </td>
- <td> </td>
- <td> ESC O t <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_5 </td>
- <td> 5 </td>
- <td> </td>
- <td> </td>
- <td> ESC O u <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_6 </td>
- <td> 6 </td>
- <td> </td>
- <td> </td>
- <td> ESC O v <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_7 </td>
- <td> 7 </td>
- <td> </td>
- <td> </td>
- <td> ESC O w <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_8 </td>
- <td> 8 </td>
- <td> </td>
- <td> </td>
- <td> ESC O x <br></td>
-
- </tr>
- <tr>
- <td> XK_KP_9 </td>
- <td> 9 </td>
- <td> </td>
- <td> </td>
- <td> ESC O y <br></td>
-
- </tr>
- </table>
- <a href="rxvtRef.html#toc">Top</a>
- </body>
- </html>
|