From dbe252c70ca0e97bc4bd5ebf5c15c7f867fb0acd Mon Sep 17 00:00:00 2001 From: Timothy Stack Date: Tue, 15 Sep 2020 15:45:29 -0700 Subject: [PATCH] [docs] some more doc stuff --- docs/source/config.rst | 13 +++++++++++-- docs/source/key-encoding-prompt.png | Bin 0 -> 88912 bytes src/lnav.cc | 2 +- 3 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 docs/source/key-encoding-prompt.png diff --git a/docs/source/config.rst b/docs/source/config.rst index 84467134..e9abafb1 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -175,13 +175,22 @@ Key Sequence Encoding Key presses are converted into a hex-encoded string that is used to lookup an entry in the keymap. Each byte of the keypress value is formatted as an :code:`x` followed by the hex-encoding in lowercase. For example, the encoding -for the £ key would be :code:`xc2xa3`. +for the £ key would be :code:`xc2xa3`. To make it easier to discover the +encoding for unassigned keys, **lnav** will print in the command prompt the +:code:`:config` command and +`JSON-Pointer `_ for assigning a command +to the key. + +.. figure:: key-encoding-prompt.png + :align: center + + Screenshot of the command prompt when an unassigned key is pressed. .. note:: Since **lnav** is a terminal application, it can only receive keypresses that can be represented as characters or escape sequences. For example, it cannot - handle modifier keypresses. + handle the press of a modifier key. Reference ^^^^^^^^^ diff --git a/docs/source/key-encoding-prompt.png b/docs/source/key-encoding-prompt.png new file mode 100644 index 0000000000000000000000000000000000000000..fe63412b93e823d8bc5616673d482c285dd6c047 GIT binary patch literal 88912 zcmZU)1yCH{vN()Ga0%{^Ai*s-i@OC2?h+)p+u{;Dc#sViEI^RpVX>gW-Q5E$&H}sp z=XdXY@7?;oQ`OTw=bY}I(>*oS-PIGXt*L~EO@)nwgoLM}EU$xvg#HXjwpbYdTn$GZ zk&tk$9OdM+RpjItv_0MI9bN2@kd)&y-(wo;4wDs{=%{=M$5MXrE1pRxEQ8P(4Y@L+ zBI;GDwzWFe8(;5tJwFrJ47~N_r{+jge==D6z55$d|F!sg0y^~@H(8YShmpJSyRia* z!}wFV?fyC?lK1jGzY%v8j&z}*1syrvAFA}vBTSMgw$ialSby(Pq7zA|snNe)-yt$u z7LbaMc{(auLun9o#XK+B(U2G%2_3LVBP8Oek-HPn_yeSn`Uxvq3iEk%t@!#eJSiCZ zXY@tXlCrDZW2oFt8&%?VWK9W>at97Z8<8emV*(Ar8E`H?03sIk-()BwPx6I{NHgr? zFlvVRE1R#&lNRFDqc&yBbfQ}O4hZKPAvPx{HV>{EF@A{ENioJMzicpt&mtNH5hj6fL>^U7R(Ni^>WO+*RQ(0hiH8*WHH@J=L{%sFNUEe9%*1oI6_wIG(Ko2- zac0p^smgI0jQHvMib{^xl)0aI>H6J&e${;i?L-?}MQ2j@&>7=Z5NvI#4j9ky68+L9 z6dVAu$P8)ZXH6^F0yC0bJU};Iej@qI_zflO9nLG2DMDvCm#;(dDS9iG2GQ28-ryut z%JNSe7}m|oRCM3>2dDY>tURcKj0%eZ7T*myw-lV+1G+>QWzFba%ELCu!9@K(nb=wD zK}w|*By*qy?U%$=pNR$kH?obvxZf}BuP!Oy_o821HwEu>}?^h3nHky zM-}vf%_!6*LQGRaG7rFSKuchbRE$I(g+!*^n}y60;lki}^!+3XJj-kqMzG6(6Bm}C zI0ImAbCbsgU3?{cLQlhD!`Mf^OZp^@JPV|otO9W}G`cl?byLLm$Mv9#Lu-SyG`MAX zcbgFVqX~Vc@5HhE-u9z%AavH_D~oE$yW6VUfh(@so{R(bOJcp@qeFrtEBXgsaNvWrTgZt+~*w>ITJY!)g15*lC{F24ItC!RuUuoW(JUEzjz6O?e0 zz>0aP910m+xYyIy*)l#|-g;0Gz_?V}2piuA! z2>)rxyoll(wq{9Rfg0P*=T4lDO5UUIPF)M~h0u71w|vEvAtaVnqKM>_F(J57La^nO#xrw6pQ*W{x=jz$fs=i@`V<3&&%wz%E#ls4mAkw8%s{p4HD7qtFd z>xmWv=R0QiWH`SzMHr47AWCi%7Hs?KOn zQcgrpv_Nu4NF86(AKULr9B-@c$pTHcRu0yYs?2GMX-e?U@Q$C=4Ah!uGD%$`EoLY7=)-;J zeXQes>fP2Jyq4Qe+K%Z{cj9}(cO7%``*81wYkH;9Pw~7`N@YV6pl4A5&;lmFJz%l8 ziB@Bq{Ah`7i8YBNiN2`C;lGe47*@W{TDHg}$Yd9F6~$V8-g?=G-PafMQ9aRdaF@?3 zS1so;XCa3kGZ$|gml)4jq{4o(Oy)chgBqPOK2bICmcmTv;lm$(e4%kZb9+;V-~}{c z4}Qvz{7bfx!!OdudoUtl7&sW&xa-3AS?o^7wp0#cW8Miz0W+=wUXAVoxl2@yJN5

Q@X`E?1fRN`J&TDaeq?h!Zl&l(-7(agAsUxU2K${v0<5{!IL#XYAVSQvbKUp+&Xn zO~bN{&%zg{vF7n6bH_E?H9H$Cff4(5jh|y&CZD)g3|u;vZ!=EC#e+I*JD|QkzFMbA ze*6vbI)<##q!50;&D+K3t#`{&9kcP%fb^E`kPQ)?p%9fu&~m16PrR~ zF4$>x&mqhz9BvZ5Lh9EZl=H}W7kHOVH%`Ztf=4GTL0MQLaS-%2AoTX~_H)pjzmNZl ze|b>dRoD1i%fSZndaXyo;D``=D9t5w^JFjYykp|d4L}a20T+a7DJ`ZDCM}9>7lAVY z8^A`O2@(f`q@}L3$yYlDzz=?iOsY>R?+24fl4NGqyvBqprbQt`x?qNT+J$WK$Q6o+ z=&0C?sHUjnSeBStykF$@q*thsZ&O~7Z2Jv>HLx@dKf8-hF}}-P%qUII$kNNa<`#Vw5a79zV`XEXD4K2knMtKm z>vb7RnXB3<9krP6+~Td^MALSY^UmKv4N5=z&f)vji&)k}^-ZlskfySh=0+|&p1!Yc z*UtgMKX2##qBUYJ;-HsdOVuiN$fC*g`qd1;D`01B-(at6X@2Phep-KdlyRk7@QpkFp_KPKB-`;`u&3$UQP#|X zIv5ZsU~{EzYd`Sko6&sZ{+JVpRw`(a<~ToJ6!@}@jEg5wKsdm)PogoP@j&v4{i*!e z`qVn$;szReCCuGTu1wa%>21+!zm-jFHN2#=Fx@b%m4KEo4wra3xC8}}J8-)iZU40G z)7jQJnsy#V$v!o#ZRvD}_K}tt%+}i0a2i4F=c4o-MkGew)_$ussCDH?c~fU$(`bM6 zMa%iObDaU&`@cpG?XFwxekaioy}@?Pb+y5Mh^nmE2UYL0F#vmD*2 zQ8Cei^}@@X@`jtIKZ07+T3SxyR;En%%=CZGcprRrYBDxjtLON*@OzE1Fv4I z8T%T}?VCHPMu(&vtwBL&n2=Bs0NVp?e{k z`;f!)6#^r=DiIfd|6!uzv;d{R6f(L~*9;+Fx>2#)AC9s!r#m*u7LIgltDa1k{YU9m ztSO-Fe6he~#C4HCmjiyG9jHe9z^C@M^8ktp^oM(V{asyl8*vx?kRU})ZLHKp*Y?u? zXmKxfl(i00o8Lhd^7F=c`zQ6nOl`{=;ktjIz}^0+33^MQ>qM7atFGt!JJ%)2nV?Ld z7`&}~tojrJOMN_`?+3KPv>^~E^Y0R^(<{0e`fSO1f1R7z)1#u~AIS+515(aF?x6J< zqo?e3ixYE^&im8zuiy#4q$4LFJ83?X?%C_UtqF(bK|0spxo=o{3|cS<@I(h!m#l zeOzB(ut!RzLb~TXKRq?tSb3yee^;M}B&eygA*3%Gc8eukdR^>k)XywHE19~#N_c@0TM zS58Ic8SC13+S$2!eQ@*6A^sBlJn_O^*~kkCiR|@1fUKhP3i2#}!BNl9+fYMY%*O2_ zx0S7%wH>$rNB4i^AW8U(J(C~pysa4gKf1VjiTO)1{cDHVGyTsr4-><`ws<>BG8t-U zGswAl+A#=m3v%-^NntZEFi3dX+KcJPEB=T5`A(AQgSWT47!Qx1pC7lM0Joc`0}r35 zs3;FFKMy}Y*Ygf8uK-tXD}OFmFXn#>`5!s*c3w7~j_%%$Zmtaf$hER|^YNBsV){qX z|Bin@r=7p!|7mjd`p>bR56JV+3J)JQFVFwVerA>UXI4zx(cjL+P~P$5v(27$Nbw20 z<(K#u!~bvT|5W~)Ro~0bQ_k(TXk|7HA_PNV932_*>t~Id;r$_G|3)-$cul&QqT%or>%**wVyYWBlUi*Lk#DSEaRwsiUArFHU4{Jc{x)UaM>OAWb@IVHL- z7aATUl_6aAV#D-^ITUFHg{us3y|c4KuOd4}bvYGFKeCeoFvpcrizUQA&X)>l_dZ@! zY4B>;YZ&Fuo}G;}p6P!<(p~PgcTxw=;1gDO_F7;!!LczM8|ezer&pW zLG;r}ty#xz7ZLNTH~gyh6^KA(Yf0r4NAB7K=Y`e`tx6-Crt)Y$o(P0)nopcb+D&H+Z<