iomenu.1

   1 .Dd $Mdocdate: October 16 2016 $
   2 .Dt IOMENU 1
   3 .Os
   4 .Sh NAME
   5 .Nm iomenu
   6 .Op Fl nNHksl
   7 .
   8 .
   9 .Sh DESCRIPTION
  10 .
  11 The
  12 .Nm
  13 utility filters lines form stdin interactively with the keyboard, and print
  14 the selected line to stdout.
  15 .Pp
  16 Lower case switches are for the interface, uppercase switches are for
  17 input/output.
  18 .Bl -tag
  19 .It Fl n
  20 Display line numbers in interface.
  21 .
  22 .It Fl N
  23 Return the line number rather than the match.
  24 .
  25 .It Fl H
  26 Return the current header that the selection belongs to in addition to the
  27 match, delimited by a tab.
  28 .
  29 .It Fl k Cm key
  30 Key to use to validate current selection in addition to Enter.
  31 .
  32 .It Fl s Cm separator
  33 Character separating the content from the comments.  Every character after
  34 the separator will be considered as comment and will be grayed and aligned
  35 in the interface.
  36 .Pp
  37 If a separator is at the beginning of a line (without leading space), the
  38 line is considered as a section header, and it will always be displayed
  39 regardless if it matches or not.
  40 .
  41 .It Fl l Cm lines
  42 Number of lines to display at once.  Default is 30.
  43 .El
  44 .
  45 .
  46 .Sh KEYBINDINGS
  47 .
  48 .Bl -tag
  49 .It Cm ^M, ^J, Enter
  50 Print the matched line to stdout and exit.
  51 .
  52 .It Cm ^@, ^Space
  53 Print the content of the input rather than the matched line to stdout and exit.
  54 .
  55 .It Cm ^P / ^N, Up / Down
  56 Navigate to the previous / next line.
  57 .
  58 .It Cm PageUp / PageDown
  59 Navigate 10 lines up / down.
  60 .
  61 .It Cm ^I, Tab
  62 Set input to the currently highlighted candidate, then cycle through candidate
  63 list.
  64 .
  65 .It Cm ^H, Backspace
  66 Delete one char backward, but if there is no char
  67 backward, it should return an error code of 1.
  68 .
  69 .It Cm ^C
  70 Cancel, and make filter return the error code of 1.
  71 .
  72 .It Cm ^W
  73 Deletes the last entered word.
  74 .
  75 .It Cm ^U
  76 Deletes the entire input and jump to the first line.
  77 .El