iomenu.1

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