Reference

# Module `awful.key`

Create easily new key objects ignoring certain modifiers.

Author:

Julien Danjou <julien@danjou.info>

Copyright© 2009 Julien Danjou

Release: v3.4.11

## Functions

match (key, pressed_mod, pressed_key) | Compare a key object with modifiers and key.
new (mod, key, press, release) | Create a new key to use as binding.

## Tables

ignore_modifiers | Modifiers to ignore.

## Functions

match (key, pressed_mod, pressed_key)
  Compare a key object with modifiers and key.

  ### Parameters

  - key: The key object.
  - pressed_mod: The modifiers to compare with.
  - pressed_key: The key to compare with.
new (mod, key, press, release)
  Create a new key to use as binding. This function is useful to create several keys from one, because it will use the ignore_modifier variable to create more key with or without the ignored modifiers activated. For example if you want to ignore CapsLock in your keybinding (which is ignored by default by this function), creating key binding with this function will return 2 key objects: one with CapsLock on, and the other one with CapsLock off.

  ### Parameters

  - mod:
  - key:
  - press:
  - release:

  ### Return value:

  A table with one or several key objects.

  ### See also:

  - capi.key

## Tables

ignore_modifiers
  Modifiers to ignore. By default this is initialized as { "Lock", "Mod2" } so the Caps Lock or Num Lock modifier are not taking into account by awesome when pressing keys.