Keyboard Preferences

Strawman for documentation of the revised 2.0.6 interface

Peter 3Oct13: I propose that we use this Talk page to develop the alternative version with the new 2.0.5 interface, so that we can easily leave the current page in place if the new interface is reverted for whatever reason.

• Peter 3Oct13 later: ToDo-1 This draft page is now ready, I think, for editorial review and merciless editing.

Keyboard Preferences sets the keyboard shortcuts which can be used for numerous commands in Audacity as an alternative to using Menus, Toolbars or mouse gestures.

Audacity comes supplied with a default set of shortcut bindings but these can be added to, changed or removed here if desired.

Click on any of the other Preferences sections in the above image to go directly to that Preferences page.

Image map entry for Modules parked here:

rect 32 288 122 303 Modules Preferences

A full list of the commands with their default key bindings is also available at Keyboard Shortcut Reference.

View by

There are three ways of viewing the key bindings which you can select by clicking on the appropriate radio button:.

Tree

This is the default view. It lists the commands which can be attached to keyboard shortcuts, together with their currently allocated shortcut or "binding". The commands are listed in the order they appear in the Audacity menu bar. For any menu that has sub-menus, those sub-menus are shown in the same order they appear within the menu. The menus and sub-menus ("branches" in this "tree" view) are by default shown fully expanded. You can click on any branch's  -  icon to collapse the branch and any branch which is collapsed can be expanded by clicking on its  +  icon.

This view has a Search box which enables you to search for either a command or shortcut.

Name

This view lists the commands in alphabetical order with the command on the left.

This also has a Search box, as above this enables you to search for either a command or shortcut.

Key

This view lists the currently assigned shortcuts in alphabetical order with the shortcut on the left, followed by an alphabetic listing of all the commands that currently have no shortcut assigned to them. This view is perhaps the easiest one to use to ascertain which keys or key combinations are not currently assigned and in use.

This has a Hotkey box which enables you to search by shortcut.

Input box, Set and Clear buttons

• To change or add a binding:
  1. Click to select the item you want to change in the Command/Key combination window. The entry will be highlighted and the current key combination for that command (if any) will now appear in the input box to left of the Set button.
  2. Either click in the input box, or press TAB once to switch focus to it.
  3. Choose your binding by either holding any modifier key (or combination of modifiers) then pressing any non-modifier key, or press any non-modifier key on its own. Valid modifiers are:
     • SHIFT
     • CTRL ( CMND on a Mac)
     • ALT
     • ALTGR or Right ALT (on Windows keyboards, this key sends a combined CTRL + ALT modifier and can thus be used as an alternative to call any binding that includes CTRL + ALT).

     As an example, SHIFT + 6  or CTRL + SHIFT + P  are both valid bindings. Your chosen key or key combination will now replace the previous content of the input box. Note: you cannot set the main system shortcut for Escape (ESC on Windows or ALT + C on some Linux systems) as a binding.

  4. Click Set to apply your desired change. If your chosen key binding is already allocated to a command, Audacity will inform you and ask you if you want to go ahead (thus removing the original binding).

• Clear: To remove a binding, select the item as above, then press Clear.

Export..., Import... and Defaults buttons

• Export... and Import...: You can export and import key bindings (for example to keep a safe copy of your custom settings, or to transfer them to Audacity on another machine). Export... exports your bindings as an XML file, and Import... imports the XML file back again. You can also edit the XML file in any text editor and re-import it, as an alternative to editing the key bindings in Preferences.

Audacity does not check for bindings which are allocated to more than one command when importing the file, so edit carefully.

The only entries you can usefully edit are the actual key bindings themselves which are in the "key" string at the end of each command. For example, to set the key binding for "New" to SHIFT + N, the command in the XML file should read:

<command name="New" label="New" key="Shift+N"/>

Be sure not to delete the closing "/>" characters at the end of the command.

• Defaults: Clicking the Defaults button reverts all bindings to those when you first obtained Audacity. This button is handy if you decide you have not got your changes right and want to start over again.

OK and Cancel buttons

• OK: When you have completed your edits press the OK button to save the new bindings and exit the dialog.
• Cancel: If you press the Cancel button this aborts the editing and all bindings will remain as they were before you started to edit them and the dialog will be exited.