manpagez: man pages & more
man bind(1)
Home | html | info | man
bind(1)                              fish                              bind(1)




NAME

       bind - handle fish key bindings


   Synopsis
       bind [OPTIONS] SEQUENCE COMMAND

   Description
       The bind builtin causes fish to add a key binding from the specified
       sequence.

       SEQUENCE is the character sequence to bind to. Usually, one would use
       fish escape sequences to express them. For example, because pressing
       the Alt key and another character sends that character prefixed with an
       escape character, Alt-based key bindings can be written using the \e
       escape. For example, Alt-w can be written as \ew. Control character can
       be written in much the same way using the \c escape, for example
       Control-x can be written as \cx. Note that Alt-based key bindings are
       case sensitive and Control base key bindings are not. This is not a
       design choice in fish, it is simply how terminals work.

       If SEQUENCE is the empty string, i.e. an empty set of quotes, this is
       interpreted as the default keybinding. It will be used whenever no
       other binding matches. For most key bindings, it makes sense to use the
       self-insert function (i.e. bind '' self-insert as the default
       keybining. This will insert any keystrokes not specifically bound to
       into the editor. Non-printable characters are ignored by the editor, so
       this will not result in e.g. control sequences being printable.

       If the -k switch is used, the name of the key (such as down, up or
       backspace) is used instead of a sequence. The names used are the same
       as the corresponding curses variables, but without the 'key_' prefix.
       (See man 5 terminfo for more information, or use bind --key-names for a
       list of all available named keys)

       COMMAND can be any fish command, but it can also be one of a set of
       special input functions. These include functions for moving the cursor,
       operating on the kill-ring, performing tab completion, etc. Use 'bind
       --function-names' for a complete list of these input functions.

       When COMMAND is a shellscript command, it is a good practice to put the
       actual code into a function and simply bind to the function name. This
       way it becomes significantly easier to test the function while editing,
       and the result is usually more readable as well.


       o -a or --all If --key-names is specified, show all key names, not only
         the ones that actually are defined for the current terminal. If erase
         mode is specified, this switch will cause all current bindings to be
         erased.

       o -e or --erase Erase mode. All non-switch arguments are interpreted as
         character sequences and any commands associated with those sequences
         are erased.

       o -h or --help Display help and exit

       o -k or --key Specify a key name, such as 'left' or 'backspace' instead
         of a character sequence

       o -K or --key-names Display a list of available key names

       o -f or --function-names Display a list of available input functions


   Example
       bind \cd 'exit' causes fish to exit on Control-d

       bind -k ppage history-search-backward Causes fish to perform a history
       search when the page up key is pressed



Version 1.23.1                    8 Mar 2009                           bind(1)

fish 1.23.1 - Generated Sun Mar 8 13:48:39 CDT 2009
© manpagez.com 2000-2021
Individual documents may contain additional copyright information.