man/vis-complete.1

   1 .Dd January 15, 2017
   2 .Dt VIS-COMPLETE 1
   3 .Os Vis VERSION
   4 .
   5 .Sh NAME
   6 .Nm vis-complete
   7 .Nd Interactively complete file or word
   8 .
   9 .Sh SYNOPSIS
  10 .Nm vis-complete
  11 .Op Fl -file
  12 .Op Fl -word
  13 .Op Ar --
  14 .Op Ar pattern
  15 .Pp
  16 .Nm vis-complete
  17 .Fl h |
  18 .Fl -help
  19 .
  20 .Sh DESCRIPTION
  21 .Nm vis-complete
  22 takes a pattern on the command-line and completes file or word and displays
  23 them in a menu for the user to select one.
  24 Once the user has selected a completion, the completion (excluding the
  25 pattern) is printed to standard output.
  26 .Pp
  27 .Nm vis-complete
  28 uses
  29 .Xr vis-menu 1
  30 as its user-interface,
  31 so see that page for more details.
  32 .
  33 .Bl -tag -width flag
  34 .It Fl -file
  35 This passes
  36 .Ar pattern
  37 to
  38 .Nm find
  39 to obtain a list of matching file names.
  40 .It Fl -word
  41 This reads standard input to obtain a list of lines matching
  42 .Ar pattern .
  43 .It Fl -
  44 If this token is encountered before the first non-option argument,
  45 all following arguments will be treated as pattern,
  46 even if they would otherwise be valid command-line options.
  47 .Pp
  48 If encountered after the first non-option argument,
  49 or after a previous instance of
  50 .Li --
  51 it is treated as a pattern.
  52 .It Ar pattern
  53 The pattern to be completed by file or word.
  54 .It Fl h | Fl -help
  55 If present,
  56 .Nm vis-complete
  57 prints a usage summary and exits,
  58 ignoring any other flag and arguments.
  59 .El
  60 .
  61 .Sh EXIT STATUS
  62 .Ex -std vis-complete
  63 .Pp
  64 In particular,
  65 like
  66 .Xr vis-menu 1 ,
  67 .Nm vis-complete
  68 prints nothing and sets its exit status to 1
  69 if the user refused to select a file.
  70 .
  71 .Sh SEE ALSO
  72 .Xr vis 1 ,
  73 .Xr vis-menu 1
  74 .
  75 .Sh BUGS
  76 Because
  77 .Nm vis-complete
  78 uses
  79 .Xr find 1
  80 to obtain the list of files, weird things might happen if you have
  81 control-characters in your filenames.