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 c
  21 Set the interaction to complete mode.  The default is filter mode.
  22 .
  23 .It Fl p Cm prompt
  24 Additionnal part of the prompt to add before the '> '.
  25 .
  26 .It Fl n
  27 Display line numbers in interface.
  28 .
  29 .It Fl N
  30 Return the line number rather than the match.
  31 .
  32 .It Fl k Cm char
  33 Key to use to validate current selection in addition to Enter.
  34 .
  35 .It Fl s Cm separator
  36 Character separating the content from the comments.  Every character after
  37 the separator will be considered as comment and will be grayed and aligned
  38 in the interface.
  39 .Pp
  40 If a separator is at the beginning of a line (without leading space), the
  41 line is considered as a section header, and it will always be displayed
  42 regardless if it matches or not.
  43 .
  44 .It Fl l Cm lines
  45 Number of lines to display at once.  Default is 30.
  46 .
  47 .
  48 .Sh KEYBINDINGS
  49 .
  50 .Bl -tag
  51 .
  52 .It Cm ^P
  53 .It Cm ^N
  54 Navigate to the previous/next line.
  55 .
  56 .It Cm ^I
  57 .It Cm Tab
  58 Set input to the currently highlighted candidate.
  59 .
  60 .It Cm ^H
  61 .It Cm Backspace
  62 Delete one char backward, but if there is no char
  63 backward, it should return an error code of 1.
  64 .
  65 .It Cm ^C
  66 Cancel, and make filter return the error code of 1.
  67 .
  68 .It ^W
  69 Deletes the last entered word.
  70 .
  71 .It ^U
  72 Deletes the entire input and jump to the first line.
  73 .El