| | | | |
| Offset 1, 326 lines modified | Offset 1, 142 lines modified |
| | 1 | .TH·EDITRC·5·"May·22,·2016"·"" |
| 1 | .\"» $NetBSD:·editrc.5,v·1.34·2022/12/06·00:59:20·uwe·Exp·$ | |
| 2 | .\" | |
| 3 | .\"·Copyright·(c)·1997-2000·The·NetBSD·Foundation,·Inc. | |
| 4 | .\"·All·rights·reserved. | |
| 5 | .\" | |
| 6 | .\"·This·file·was·contributed·to·The·NetBSD·Foundation·by·Luke·Mewburn. | |
| 7 | .\" | |
| 8 | .\"·Redistribution·and·use·in·source·and·binary·forms,·with·or·without | |
| 9 | .\"·modification,·are·permitted·provided·that·the·following·conditions | |
| 10 | .\"·are·met: | |
| 11 | .\"·1.·Redistributions·of·source·code·must·retain·the·above·copyright | |
| 12 | .\"····notice,·this·list·of·conditions·and·the·following·disclaimer. | |
| 13 | .\"·2.·Redistributions·in·binary·form·must·reproduce·the·above·copyright | |
| 14 | .\"····notice,·this·list·of·conditions·and·the·following·disclaimer·in·the | |
| 15 | .\"····documentation·and/or·other·materials·provided·with·the·distribution. | |
| 16 | .\" | |
| 17 | .\"·THIS·SOFTWARE·IS·PROVIDED·BY·THE·NETBSD·FOUNDATION,·INC.·AND·CONTRIBUTORS | |
| 18 | .\"·``AS·IS''·AND·ANY·EXPRESS·OR·IMPLIED·WARRANTIES,·INCLUDING,·BUT·NOT·LIMITED | |
| 19 | .\"·TO,·THE·IMPLIED·WARRANTIES·OF·MERCHANTABILITY·AND·FITNESS·FOR·A·PARTICULAR | |
| 20 | .\"·PURPOSE·ARE·DISCLAIMED.··IN·NO·EVENT·SHALL·THE·FOUNDATION·OR·CONTRIBUTORS | |
| 21 | .\"·BE·LIABLE·FOR·ANY·DIRECT,·INDIRECT,·INCIDENTAL,·SPECIAL,·EXEMPLARY,·OR | |
| 22 | .\"·CONSEQUENTIAL·DAMAGES·(INCLUDING,·BUT·NOT·LIMITED·TO,·PROCUREMENT·OF | |
| 23 | .\"·SUBSTITUTE·GOODS·OR·SERVICES;·LOSS·OF·USE,·DATA,·OR·PROFITS;·OR·BUSINESS | |
| 24 | .\"·INTERRUPTION)·HOWEVER·CAUSED·AND·ON·ANY·THEORY·OF·LIABILITY,·WHETHER·IN | |
| 25 | .\"·CONTRACT,·STRICT·LIABILITY,·OR·TORT·(INCLUDING·NEGLIGENCE·OR·OTHERWISE) | |
| 26 | .\"·ARISING·IN·ANY·WAY·OUT·OF·THE·USE·OF·THIS·SOFTWARE,·EVEN·IF·ADVISED·OF·THE | |
| 27 | .\"·POSSIBILITY·OF·SUCH·DAMAGE. | |
| 28 | .\" | |
| 29 | .Dd·May·22,·2016 | |
| 30 | .Dt·EDITRC·5 | |
| 31 | .Os | |
| 32 | .Sh·NAME | 2 | .SH·NAME |
| 33 | .Nm·editrc | 3 | \fBeditrc\fP |
| 34 | .Nd·configuration·file·for·editline·library | 4 | \-·configuration·file·for·editline·library |
| 35 | .Sh·SYNOPSIS | 5 | .SH·SYNOPSIS |
| 36 | .Nm | 6 | .br |
| | 7 | \fBeditrc\fP |
| 37 | .Sh·DESCRIPTION | 8 | .SH·DESCRIPTION |
| 38 | The | 9 | The |
| 39 | .Nm | 10 | \fBeditrc\fP |
| 40 | file·defines·various·settings·to·be·used·by·the | 11 | file·defines·various·settings·to·be·used·by·the |
| 41 | .Xr·editline·3 | 12 | \fBeditline\fP(3) |
| 42 | library. | 13 | library. |
| 43 | .Pp | |
| 44 | The·format·of·each·line·is: | 14 | The·format·of·each·line·is: |
| 45 | .Pp | |
| 46 | .D1·Oo·Ar·prog·Ns·Ic·\&:·Oc·Ns·Ar·command·Oo·Ar·arg·...·Oc | |
| 47 | .Pp | |
| 48 | .Ar·command | |
| 49 | is·one·of·the | 15 | is·one·of·the |
| 50 | .Xr·editline·3 | |
| 51 | builtin·commands. | 16 | builtin·commands. |
| 52 | Refer·to | 17 | Refer·to |
| 53 | .Sx·BUILTIN·COMMANDS | |
| 54 | for·more·information. | 18 | for·more·information. |
| 55 | .Pp | |
| 56 | .Ar·prog | |
| 57 | is·the·program·name·string·that·a·program·defines·when·it·calls | 19 | is·the·program·name·string·that·a·program·defines·when·it·calls |
| 58 | .Xr·el_init·3 | |
| 59 | to·set·up | 20 | to·set·up |
| 60 | .Xr·editline·3·, | |
| 61 | which·is·usually | 21 | which·is·usually |
| 62 | .Va·argv·Ns·Li·[0]·. | |
| 63 | .Ar·command | |
| 64 | will·be·executed·for·any·program·which·matches | 22 | will·be·executed·for·any·program·which·matches |
| 65 | .Ar·prog·. | |
| 66 | .Pp | |
| 67 | .Ar·prog | |
| 68 | may·also·be·a | 23 | may·also·be·a |
| 69 | .Xr·regex·3 | |
| 70 | style | 24 | style |
| 71 | regular·expression,·in·which·case | 25 | regular·expression,·in·which·case |
| 72 | .Ar·command | |
| 73 | will·be·executed·for·any·program·that·matches·the·regular·expression. | 26 | will·be·executed·for·any·program·that·matches·the·regular·expression. |
| 74 | .Pp | |
| 75 | If | 27 | If |
| 76 | .Ar·prog | |
| 77 | is·absent, | 28 | is·absent, |
| 78 | .Ar·command | |
| 79 | is·executed·for·all·programs. | 29 | is·executed·for·all·programs. |
| 80 | .Sh·BUILTIN·COMMANDS | |
| 81 | The | 30 | The |
| 82 | .Nm·editline | |
| 83 | library·has·some·builtin·commands,·which·affect·the·way | 31 | library·has·some·builtin·commands,·which·affect·the·way |
| 84 | that·the·line·editing·and·history·functions·operate. | 32 | that·the·line·editing·and·history·functions·operate. |
| 85 | These·are·based·on·similar·named·builtins·present·in·the | 33 | These·are·based·on·similar·named·builtins·present·in·the |
| 86 | .Xr·tcsh·1 | |
| 87 | shell. | 34 | shell. |
| 88 | .Pp | |
| 89 | The·following·builtin·commands·are·available: | 35 | The·following·builtin·commands·are·available: |
| 90 | .Bl·-tag·-width·4n | |
| 91 | .It·Ic·bind·Oo·Fl·aeklrsv·Oc·Op·Ar·key·Op·Ar·command | |
| 92 | Without·options·and·arguments,·list·all·bound·keys·and·macros,·and | 36 | Without·options·and·arguments,·list·all·bound·keys·and·macros,·and |
| 93 | the·editor·command·or·input·string·to·which·each·one·is·bound. | 37 | the·editor·command·or·input·string·to·which·each·one·is·bound. |
| 94 | If·only | 38 | If·only |
| 95 | .Ar·key | |
| 96 | is·supplied,·show·the·binding·for·that·key·or·macro. | 39 | is·supplied,·show·the·binding·for·that·key·or·macro. |
| 97 | If | 40 | If |
| 98 | .Ar·key·command | |
| 99 | is·supplied,·bind·the·editor | 41 | is·supplied,·bind·the·editor |
| 100 | .Ar·command | |
| 101 | to·that·key·or·macro. | 42 | to·that·key·or·macro. |
| 102 | .Pp | |
| 103 | The·options·are·as·follows: | 43 | The·options·are·as·follows: |
| 104 | .Bl·-tag·-width·4n | |
| 105 | .It·Fl·a | |
| 106 | List·or·change·key·bindings·in·the | 44 | List·or·change·key·bindings·in·the |
| 107 | .Xr·vi·1 | |
| 108 | mode·alternate·(command·mode)·key·map. | 45 | mode·alternate·(command·mode)·key·map. |
| 109 | .It·Fl·e | |
| 110 | Bind·all·keys·to·the·standard | 46 | Bind·all·keys·to·the·standard |
| 111 | .Tn·GNU | |
| 112 | Emacs-like·bindings. | 47 | Emacs-like·bindings. |
| 113 | .It·Fl·k | |
| 114 | .Ar·key | |
| 115 | is·interpreted·as·a·symbolic·arrow·key·name,·which·may·be·one·of | 48 | is·interpreted·as·a·symbolic·arrow·key·name,·which·may·be·one·of |
| 116 | .Ic·up·, | |
| 117 | .Ic·down·, | |
| 118 | .Ic·left | |
| 119 | or | 49 | or |
| 120 | .Ic·right·. | |
| 121 | .It·Fl·l | |
| 122 | List·all·editor·commands·and·a·short·description·of·each. | 50 | List·all·editor·commands·and·a·short·description·of·each. |
| 123 | .It·Fl·r | |
| 124 | Remove·the·binding·of·the·key·or·macro | 51 | Remove·the·binding·of·the·key·or·macro |
| 125 | .Ar·key·. | |
| 126 | .It·Fl·s | |
| 127 | Define·a·keyboard·macro·rather·than·a·key·binding·or·command·macro: | 52 | Define·a·keyboard·macro·rather·than·a·key·binding·or·command·macro: |
| 128 | .Ar·command | |
| 129 | is·taken·as·a·literal·string·and·appended·to·the·input·queue·whenever | 53 | is·taken·as·a·literal·string·and·appended·to·the·input·queue·whenever |
| 130 | .Ar·key | |
| 131 | is·typed. | 54 | is·typed. |
| 132 | Bound·keys·and·macros·in | 55 | Bound·keys·and·macros·in |
| 133 | .Ar·command | |
| 134 | are·themselves·reinterpreted,·and·this·continues·for·ten·levels·of | 56 | are·themselves·reinterpreted,·and·this·continues·for·ten·levels·of |
| 135 | interpretation. | 57 | interpretation. |
| 136 | .It·Fl·v | |
| 137 | Bind·all·keys·to·the·standard | 58 | Bind·all·keys·to·the·standard |
| 138 | .Xr·vi·1·Ns·-like | |
| 139 | bindings. | 59 | bindings. |
| | |
| 140 | .El | |
| 141 | .Pp | |
| 142 | The | 60 | The |
| 143 | .Xr·editline·7 | |
| 144 | manual·documents·all·editor·commands·and·contains·more·information | 61 | manual·documents·all·editor·commands·and·contains·more·information |
| 145 | about·macros·and·the·input·queue. | 62 | about·macros·and·the·input·queue. |
| 146 | .Pp | |
| 147 | .Ar·key | |
| 148 | and | 63 | and |
| 149 | .Ar·command | |
| 150 | can·contain·control·characters·of·the·form | 64 | can·contain·control·characters·of·the·form |
| 151 | .Sq·Ic·^·Ns·Ar·character | |
| 152 | .Po | |
| 153 | e.g.\& | 65 | e.g.\& |
| 154 | .Ql·^A | |
| 155 | .Pc·, | |
| 156 | and·the·following·backslashed·escape·sequences: | 66 | and·the·following·backslashed·escape·sequences: |
| 157 | .Pp | |
| 158 | .Bl·-tag·-compact·-offset·indent·-width·Ic | |
| 159 | .It·Ic·\ea | |
| 160 | Bell | 67 | Bell |
| 161 | .It·Ic·\eb | |
| 162 | Backspace | 68 | Backspace |
| 163 | .It·Ic·\ee | |
| 164 | Escape | 69 | Escape |
| 165 | .It·Ic·\ef | |
| 166 | Formfeed | 70 | Formfeed |
| 167 | .It·Ic·\en | |
| 168 | Newline | 71 | Newline |
| 169 | .It·Ic·\er | |
| 170 | Carriage·return | 72 | Carriage·return |
| 171 | .It·Ic·\et | |
| 172 | Horizontal·tab | 73 | Horizontal·tab |
| 173 | .It·Ic·\ev | |
| 174 | Vertical·tab | 74 | Vertical·tab |
| 175 | .Sm·off | |
| 176 | .It·Ic·\e·Ar·nnn | |
| 177 | .Sm·on | |
| 178 | The | 75 | The |
| 179 | .Tn·ASCII | |
| 180 | character·corresponding·to·the·octal·number | 76 | character·corresponding·to·the·octal·number |
| 181 | .Ar·nnn·. | |
| 182 | .El | |
| 183 | .Pp | |
| 184 | .Ql·\e | |
| 185 | nullifies·the·special·meaning·of·the·following·character, | 77 | nullifies·the·special·meaning·of·the·following·character, |
| 186 | if·it·has·any,·notably | 78 | if·it·has·any,·notably |
| 187 | .Ql·\e | |
| 188 | and | 79 | and |
| 189 | .Ql·^·. | |
| 190 | .It·Ic·echotc·Oo·Fl·sv·Oc·Ar·arg·Ar·... | |
| 191 | Exercise·terminal·capabilities·given·in | 80 | Exercise·terminal·capabilities·given·in |
| 192 | .Ar·arg·. | |
| 193 | If | 81 | If |
| 194 | .Ar·arg | |
| 195 | is | 82 | is |
| 196 | .Ql·baud·, | |
| 197 | .Ql·cols·, | |
| 198 | .Ql·lines·, | |
| 199 | .Ql·rows·, | |
| 200 | .Ql·meta·, | |
| 201 | or | 83 | or |
| 202 | .Ql·tabs·, | |
| 203 | the·value·of·that·capability·is·printed,·with | 84 | the·value·of·that·capability·is·printed,·with |
| 204 | .Dq·yes | |
| 205 | or | 85 | or |
| 206 | .Dq·no | |
| 207 | indicating·that·the·terminal·does·or·does·not·have·that·capability. | 86 | indicating·that·the·terminal·does·or·does·not·have·that·capability. |
| 208 | .Pp | |
| 209 | .Fl·s | |
| 210 | returns·an·empty·string·for·non-existent·capabilities,·rather·than | 87 | returns·an·empty·string·for·non-existent·capabilities,·rather·than |
| 211 | causing·an·error. | 88 | causing·an·error. |
| 212 | .Fl·v | |
| 213 | causes·messages·to·be·verbose. | 89 | causes·messages·to·be·verbose. |
| 214 | .It·Ic·edit·Op·Li·on·No·|·Li·off | |
| 215 | Enable·or·disable·the | 90 | Enable·or·disable·the |
| 216 | .Nm·editline | |
| 217 | functionality·in·a·program. | 91 | functionality·in·a·program. |
| 218 | .It·Ic·history·Li·list·No·|·Li·size·Ar·n·No·|·Li·unique·Ar·n | |
| 219 | The | 92 | The |
| 220 | .Ql·list | |
| 221 | command·lists·all·entries·in·the·history. | 93 | command·lists·all·entries·in·the·history. |
| 222 | The | 94 | The |
| 223 | .Ql·size | |
| 224 | command·sets·the·history·size·to | 95 | command·sets·the·history·size·to |
| 225 | .Ar·n | |
| 226 | entries. | 96 | entries. |
| 227 | The | 97 | The |
| 228 | .Ql·unique | |
| 229 | command·controls·if·history·should·keep·duplicate·entries. | 98 | command·controls·if·history·should·keep·duplicate·entries. |
| 230 | If | 99 | If |
| 231 | .Ar·n | |
| 232 | is·non·zero,·only·keep·unique·history·entries. | 100 | is·non·zero,·only·keep·unique·history·entries. |
| 233 | If | 101 | If |
| 234 | .Ar·n | |
| 235 | is·zero,·then·keep·all·entries·(the·default). | 102 | is·zero,·then·keep·all·entries·(the·default). |
| 236 | .It·Ic·settc·Ar·cap·Ar·val | |
| 237 | Set·the·terminal·capability | 103 | Set·the·terminal·capability |
| 238 | .Ar·cap | |
| 239 | to | 104 | to |
| 240 | .Ar·val·, | |
| 241 | as·defined·in | 105 | as·defined·in |
| 242 | .Xr·termcap·5·. | |
| 243 | No·sanity·checking·is·done. | 106 | No·sanity·checking·is·done. |
| 244 | .It·Ic·setty·Oo·Fl·a·Oc·Oo·Fl·d·Oc·Oo·Fl·q·Oc·Oo·Fl·x·Oc·Oo·Ic·\&+·Ns·Ar·mode·Oc·\ | |
| 245 | Oo·Fl·Ar·mode·Oc·Oo·Ar·mode·Oc·Oo·Ar·char\|·Ns·Ic·=·Ns·Ar·c·Oc | 107 | Oo·Fl·Ar·mode·Oc·Oo·Ar·mode·Oc·Oo·Ar·char\|·Ns·Ic·=·Ns·Ar·c·Oc |
| 246 | Control·which·tty·modes·that | 108 | Control·which·tty·modes·that |
| 247 | .Nm | |
| 248 | won't·allow·the·user·to·change. | 109 | won't·allow·the·user·to·change. |
| 249 | .Fl·d·, | |
| 250 | .Fl·q | |
| 251 | or | 110 | or |
| 252 | .Fl·x | |
| 253 | tells | 111 | tells |
| 254 | .Ic·setty | |
| 255 | to·act·on·the | 112 | to·act·on·the |
| 256 | .Sq·edit·, | |
| 257 | .Sq·quote | |
| 258 | or | 113 | or |
| 259 | .Sq·execute | |
| 260 | set·of·tty·modes·respectively;·defaulting·to | 114 | set·of·tty·modes·respectively;·defaulting·to |
| | |
| 261 | .Fl·x·. | |
| 262 | .Pp | |
| 263 | Without·other·arguments, | 115 | Without·other·arguments, |
| 264 | .Ic·setty | |
| 265 | lists·the·modes·in·the·chosen·set·which·are·fixed·on | 116 | lists·the·modes·in·the·chosen·set·which·are·fixed·on |
| 266 | .Po | |
| 267 | .Ic·+·Ns·Ar·mode | |
| 268 | .Pc | |
| 269 | or·off | 117 | or·off |
| 270 | .Po | |
| 271 | .Fl·Ns·Ar·mode | |
| 272 | .Pc·. | |
| 273 | .Fl·a | |
| 274 | lists·all·tty·modes·in·the·chosen·set·regardless·of·the·setting. | 118 | lists·all·tty·modes·in·the·chosen·set·regardless·of·the·setting. |
| 275 | With | 119 | With |
| 276 | .Ic·+·Ns·Ar·mode·, | |
| 277 | .Fl·Ns·Ar·mode | |
| 278 | or | 120 | or |
| 279 | .Ar·mode·, | |
| 280 | fixes | 121 | fixes |
| 281 | .Ar·mode | |
| 282 | on·or·off·or·removes·control·of | 122 | on·or·off·or·removes·control·of |
| 283 | .Ar·mode | |
| 284 | in·the·chosen·set. | 123 | in·the·chosen·set. |
| 285 | .Pp | |
| 286 | .Ic·Setty | |
| 287 | can·also·be·used·to·set·tty·characters·to·particular·values·using | 124 | can·also·be·used·to·set·tty·characters·to·particular·values·using |
| 288 | .Ar·char\|·Ns·Ic·=·Ns·Ar·value·. | |
| 289 | If | 125 | If |
| 290 | .Ar·value | |
| 291 | is·empty | 126 | is·empty |
| 292 | then·the·character·is·set·to | 127 | then·the·character·is·set·to |
| 293 | .Dv·_POSIX_VDISABLE·. | |
| 294 | .It·Ic·telltc | |
| 295 | List·the·values·of·all·the·terminal·capabilities·(see | 128 | List·the·values·of·all·the·terminal·capabilities·(see |
| 296 | .Xr·termcap·5·)·. | |
| 297 | .El | |
| 298 | .Sh·ENVIRONMENT | |
| 299 | .Bl·-tag·-width·Ev | |
| 300 | .It·Ev·EDITRC | |
| 301 | Names·the·default·configuration·file·for·the | 129 | Names·the·default·configuration·file·for·the |
| 302 | .Xr·editline·3 | |
| 303 | library. | 130 | library. |
| 304 | .El | |
| 305 | .Sh·FILES | |
| 306 | .Bl·-tag·-width·Pa | |
| 307 | .It·Pa·~/.editrc | |
| 308 | Last·resort·user·configuration·file·for·the | 131 | Last·resort·user·configuration·file·for·the |
| 309 | .Xr·editline·3 | |
| 310 | library·if·no·other·file·is·specified. | 132 | library·if·no·other·file·is·specified. |
| 311 | .El | |
| 312 | .Sh·SEE·ALSO | |
| 313 | .Xr·editline·3·, | |
| 314 | .Xr·regex·3·, | |
| 315 | .Xr·termcap·5·, | |
| 316 | .Xr·editline·7 | |
| 317 | .Sh·AUTHORS | |
| 318 | .An·-nosplit | |
| 319 | The | 133 | The |
| 320 | .Nm·editline | |
| 321 | library·was·written·by | 134 | library·was·written·by |
| 322 | .An·Christos·Zoulas·, | |
| 323 | and·this·manual·was·written·by | 135 | and·this·manual·was·written·by |
| 324 | .An·Luke·Mewburn·, | |
| 325 | with·some·sections·inspired·by | 136 | with·some·sections·inspired·by |
| 326 | .Xr·tcsh·1·. | |