NVDA 2024.1beta10 User Guide

Introduction

Welcome to NVDA!

NonVisual Desktop Access (NVDA) is a free and open source screen reader for the Microsoft Windows operating system. Providing feedback via synthetic speech and Braille, it enables blind or vision impaired people to access computers running Windows for no more cost than a sighted person. NVDA is developed by NV Access, with contributions from the community.

General Features

NVDA allows blind and vision impaired people to access and interact with the Windows operating system and many third party applications.

A short video demonstration, "What is NVDA?" is available from the NV Access YouTube channel.

Major highlights include:

• Support for popular applications including web browsers, email clients, internet chat programs and office suites
• Built-in speech synthesizer supporting over 80 languages
• Reporting of textual formatting where available such as font name and size, style and spelling errors
• Automatic announcement of text under the mouse and optional audible indication of the mouse position
• Support for many refreshable braille displays, including the ability to detect many of them automatically as well as braille input on braille displays with a braille keyboard
• Ability to run entirely from a USB flash drive or other portable media without the need for installation
• Easy to use talking installer
• Translated into 54 languages
• Support for modern Windows Operating Systems including both 32 and 64 bit variants
• Ability to run during Windows sign-in and other secure screens.
• Announcing controls and text while using touch gestures
• Support for common accessibility interfaces such as Microsoft Active Accessibility, Java Access Bridge, IAccessible2 and UI Automation
• Support for Windows Command Prompt and console applications
• The ability to highlight the system focus

System Requirements

• Operating Systems: all 32-bit and 64-bit editions of Windows 8.1, Windows 10, Windows 11, and all Server Operating Systems starting from Windows Server 2012 R2.
  • both AMD64 and ARM64 variants of Windows are supported.
• at least 150 MB of storage space.

Internationalization

It is important that people anywhere in the world, no matter what language they speak, get equal access to technology. Besides English, NVDA has been translated into 54 languages including: Afrikaans, Albanian, Amharic, Arabic, Aragonese, Bulgarian, Burmese, Catalan, Chinese (simplified and traditional), Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, Galician, Georgian, German (Germany and Switzerland), Greek, Hebrew, Hindi, Hungarian, Icelandic, Irish, Italian, Japanese, Kannada, Korean, Kyrgyz, Lithuanian, Macedonian, Mongolian, Nepali, Norwegian, Polish, Portuguese (Brazil and Portugal), Punjabi, Romanian, Russian, Serbian, Slovak, Slovenian, Spanish (Colombia and Spain), Swedish, Tamil, Thai, Turkish, Ukrainian and Vietnamese.

Speech Synthesizer Support

Apart from providing its messages and interface in several languages, NVDA can also enable the user to read content in any language, as long as they have a speech synthesizer that can speak that language.

NVDA is bundled with eSpeak NG, a free, open-source, multi-lingual speech synthesizer.

Information about other speech synthesizers that NVDA supports can be found in the Supported Speech Synthesizers section.

Braille support

For users that own a refreshable braille display, NVDA can output its information in braille. NVDA uses the open source braille translator LibLouis to generate braille sequences from text. Both uncontracted and contracted braille input via a braille keyboard is also supported. Furthermore, NVDA will detect many braille displays automatically by default. Please see the Supported Braille Displays section for information about the supported braille displays.

NVDA supports braille codes for many languages, including contracted, uncontracted and computer braille codes.

License and Copyright

NVDA is copyright 2006-2024 NVDA contributors.

NVDA is available under the GNU General Public License version 2, with two special exceptions. The exceptions are outlined in the license document under the sections "Non-GPL Components in Plugins and Drivers" and "Microsoft Distributable Code". NVDA also includes and uses components which are made available under different free and open source licenses. You are free to share or change this software in any way you like as long as it is accompanied by the license and you make all source code available to anyone who wants it. This applies to both original and modified copies of this software, plus any derivative works.

For further details, you can view the full license. For details regarding exceptions, access the license document from the NVDA menu under the "help" section.

NVDA Quick Start Guide

This quick start guide contains three main sections: downloading, initial setup, and running NVDA. These are followed by information on adjusting preferences, participating in the community and getting help. The information in this guide is condensed from other parts of the NVDA User Guide. Please refer to the full User Guide for more detailed information on each topic.

Downloading NVDA

NVDA is completely free for anyone to use. There is no license key to worry about or expensive subscription to pay. NVDA is updated, on average, four times per year. The latest version of NVDA is always available from the "Download" page of the NV Access website.

NVDA works with all recent versions of Microsoft Windows. Check the System Requirements for full details.

Steps for Downloading NVDA

These steps assume some familiarity with navigating a web page.

• Open your web browser (Press the Windows key, type the word "internet" without quotes, and press enter)
• Load the NV Access download page (Press alt+d, type the following address and press enter): https://www.nvaccess.org/download
• Activate the "download" button
• The browser may or may not prompt for an action after downloading, and then start the download
• Depending on the browser, the file may run automatically after it downloads
• If the file needs to be manually launched, press alt+n to move to the notification area, then alt+r to run the file (or the steps for your browser)

Setting up NVDA

Running the file you have just downloaded will start a temporary copy of NVDA. You will then be asked if you want to install NVDA, create a portable copy or just continue using the temporary copy.

NVDA does not need access to the Internet to run or install once the launcher is downloaded. If available, an internet connection does enable NVDA to check for updates periodically.

Steps for running the downloaded launcher

The setup file is named "nvda_2022.1.exe" or similar. The year and version changes between updates to reflect the current release.

1. Run the downloaded file. Music plays while a temporary copy of NVDA loads. Once loaded, NVDA will speak throughout the rest of the process.
2. The NVDA Launcher window appears with the license agreement. Press downArrow to read the license agreement if desired.
3. Press tab to move to the "I agree" checkbox, then press the spacebar to check it.
4. Press tab to move through the options, then press enter on the desired option.

The options are:

• "Install NVDA on this computer": This is the main option most users want for easy use of NVDA.
• "Create portable copy": This allows NVDA to be setup in any folder without installing. This is useful on computers without admin rights, or on a memory stick to carry with you. When selected, NVDA walks through the steps to create a portable copy. The main thing NVDA needs to know is the folder to setup the portable copy in.
• "Continue running": This keeps the temporary copy of NVDA running. This is useful for testing features in a new version before installing it. When selected, the launcher window closes and the temporary copy of NVDA continues running until it is exited or the PC is shut down. Note that changes to settings are not saved.
• "Cancel": This closes NVDA without performing any action.

If you plan to always use NVDA on this computer, you will want to choose to install NVDA. Installing NVDA will allow for additional functionality such as automatic starting after sign-in, the ability to read the Windows sign-in and secure screens. These cannot be done with portable and temporary copies. For full details of the limitations when running a portable or temporary copy of NVDA, please see Portable and temporary copy restrictions.

Installing also offers to create Start Menu and desktop shortcuts, and allow NVDA to be started with control+alt+n.

Steps for installing NVDA from the launcher

These steps walk through the most common setup options. For more details on the options available, please see Installation options.

1. From the launcher, ensure the checkbox to agree to the license is checked.
2. Tab to, and activate the "Install NVDA on this computer" button.
3. Next, are options to use NVDA during Windows sign-in and to create a desktop shortcut. These are checked by default. If desired, press tab and spaceBar to change any of these options, or leave them at the default.
4. Press enter to continue.
5. A Windows "User Account Control (UAC)" dialog appears asking "Do you want to allow this app to make changes to your PC?".
6. Press alt+y to accept the UAC prompt.
7. A progress bar fills up as NVDA installs. During this process NVDA sounds an increasingly higher pitched beep. This process is often fast and may not be noticed.
8. A dialog box appears confirm that the install of NVDA has been successful. The message advises to "Press OK to start the installed copy". Press enter to start the installed copy.
9. The "Welcome to NVDA" dialog appears, and NVDA reads a welcome message. The focus is on the "Keyboard Layout" drop-down. By default, "Desktop" keyboard layout uses the number pad for some function. If desired, press downArrow to choose "Laptop" keyboard layout to reassign number pad functions to other keys.
10. Press tab to move to "Use capsLock as an NVDA modifier key". Insert is set as the NVDA modifier key by default. Press spaceBar to select capsLock as an alternate modifier key. Note that the keyboard layout is set separately from the NVDA modifier key. The NVDA key and keyboard layout can be changed later from the Keyboard Settings.
11. Use tab and spaceBar to adjust the other options on this screen. These set whether NVDA starts automatically.
12. Press enter to close the dialog box with NVDA now running.

Running NVDA

The full NVDA user guide has all the NVDA commands, split up into different sections for reference. The tables of commands are also available in the "Commands Quick Reference". The "Basic Training for NVDA" NVDA training module has each command in more depth with step-by-step activities. "Basic Training for NVDA" is available from the NV Access Shop.

Here are some basic commands which are used frequently. All commands are configurable, so these are the default keystrokes for these functions.

The NVDA Modifier Key

The default NVDA modifier key is either the numpadZero, (with numLock off), or the insert key, near the delete, home and end keys. The NVDA modifier key can also be set to the capsLock key.

Input Help

To learn and practice the location of keys, press NVDA+1 to turn Input help on. While in input help mode, performing any input gesture (such as pressing a key or performing a touch gesture) will report the action and describe what it does (if anything). The actual commands will not execute while in input help mode.

Starting and stopping NVDA

Reading text

Reporting location and other information

Toggle which information NVDA reads

The synth settings ring

Web navigation

The full list of Single Letter Navigation keys is in the Browse Mode section of the user guide.

Preferences

Most NVDA functions can be enabled or changed via the NVDA settings. Settings, and other options, are available via NVDA's menu. To open NVDA's menu, press NVDA+n. To open NVDA's general settings dialog directly, press NVDA+control+g. Many settings screens have keystrokes to open them directly, such as NVDA+control+s for synthesizer, or NVDA+control+v for other voice options.

Community

NVDA has a vibrant user community. There is a main English language email list and a page full of local language groups. NV Access, makers of NVDA, are active on Twitter and Facebook. NV Access also have a regular In-Process blog.

There is also an NVDA Certified Expert program. This is an online exam you can complete to demonstrate your skills in NVDA. NVDA Certified Experts can list their contact and relevant business details.

Getting help

To get help for NVDA, press NVDA+n to open the menu, then h for help. From this submenu you can access the User Guide, a quick reference of commands, history of new features and more. These first three options open in the default web browser. There is also more comprehensive Training Material available in the NV Access Shop.

We recommend starting with the "Basic Training for NVDA module". This module covers concepts from getting started up to browsing the web and using object navigation. It is available in:

• Electronic text, which includes Word DOCX, Web page HTML, eBook ePub and Kindle KFX formats.
• Human-read, MP3 audio
• Hard-copy UEB Braille with delivery included anywhere in the world.

Other modules, and the discounted NVDA Productivity Bundle, are available in the NV Access Shop.

NV Access also sells telephone support, either in blocks, or as part of the NVDA Productivity Bundle. Telephone support includes local numbers in Australia and the USA.

The email user groups are a great source of community help, as are certified NVDA experts.

You can make bug reports or feature requests via GitHub. The contribution guidelines contain valuable information for contributing to the community.

More Setup Options

Installation Options

If installing NVDA directly from the downloaded NVDA launcher, press the Install NVDA button. If you have already closed this dialog or are wanting to install from a portable copy, please choose the Install NVDA menu item found under Tools in the NVDA menu.

The installation dialog that appears will confirm whether you wish to install NVDA and will also tell you whether this installation will be updating a previous install. Pressing the Continue button will start installing NVDA. There are also a few options in this dialog which are explained below. Once the installation has completed, a message will appear telling you that it was successful. Pressing OK at this point will restart the newly installed copy of NVDA.

Incompatible add-ons warning

If you have add-ons already installed there may also be a warning that incompatible add-ons will be disabled. Before you're able to press the Continue button you will have to use the checkbox to confirm that you understand that these add-ons will be disabled. There will also be a button present to review the add-ons that will be disabled. Refer to the incompatible add-ons dialog section for more help on this button. After installation, you are able to re-enable incompatible add-ons at your own risk from within the Add-on Store.

Use NVDA during sign-in

This option allows you to choose whether or not NVDA should automatically start while at the Windows sign-in screen, before you have entered a password. This also includes User Account Control and other secure screens. This option is enabled by default for fresh installations.

Create Desktop Shortcut (ctrl+alt+n)

This option allows you to choose whether or not NVDA should create a shortcut on the desktop to start NVDA. If created, this shortcut will also be assigned a shortcut key of control+alt+n, allowing you to start NVDA at any time with this keystroke.

Copy Portable Configuration to Current User Account

This option allows you to choose whether or not NVDA should copy the user configuration from the currently running NVDA into the configuration for the currently logged on user, for the installed copy of NVDA. This will not copy the configuration for any other users of this system nor to the system configuration for use during Windows sign-in and other secure screens. This option is only available when installing from a portable copy, not when installing directly from the downloaded Launcher package.

Creating a Portable Copy

If creating a portable copy directly from the NVDA download package, press the Create Portable Copy button. If you have already closed this dialog or you are running an installed copy of NVDA, choose the Create Portable copy menu item found under Tools in the NVDA menu.

The Dialog that appears allows you to choose where the portable copy should be created. This can be a directory on your hard drive or a location on a USB thumb drive or other portable media. There is also an option to choose whether NVDA should copy the logged on user's current NVDA configuration for use with the newly created portable copy. This option is only available when creating a portable copy from an installed copy, not when creating from the download package. Pressing Continue will create the portable copy. Once creation is complete, a message will appear telling you it was successful. Press OK to dismiss this dialog.

Portable and Temporary Copy Restrictions

If you want to take NVDA with you on a USB thumb drive or other writable media, then you should choose to create a portable copy. The installed copy is also able to create a portable copy of itself at any time. The portable copy also has the ability to install itself on any computer at a later time. However, if you wish to copy NVDA onto read-only media such as a CD, you should just copy the download package. Running the portable version directly from read-only media is not supported at this time.

The NVDA installer can be used as a temporary copy of NVDA. Temporary copies prevent saving NVDA settings. This includes disabling usage of the Add-on Store.

Portable and temporary copies of NVDA have the following restrictions:

• The inability to automatically start during and/or after log-on.
• The inability to interact with applications running with administrative privileges, unless of course NVDA itself has been run also with these privileges (not recommended).
• The inability to read User Account Control (UAC) screens when trying to start an application with administrative privileges.
• The inability to support input from a touchscreen.
• The inability to provide features such as browse mode and speaking of typed characters in Windows Store apps.
• Audio ducking is not supported.

Using NVDA

Launching NVDA

If you have installed NVDA with the installer, then starting NVDA is as simple as either pressing control+alt+n, or choosing NVDA from the NVDA menu under Programs on the Start Menu. Additionally you can type NVDA into the Run dialog and press Enter. If NVDA is already running, it will be restarted. You can also pass some command line options which allows you to quit (-q), disable add-ons (--disable-addons), etc.

For installed copies, NVDA stores the configuration in the roaming application data folder of the current user by default (e.g. "C:\Users\<user>\AppData\Roaming"). It is possible to change this in a way that NVDA loads its configuration from the local application data folder instead. Consult the section about system wide parameters for more details.

To start the portable version, go to the directory you unpacked NVDA to, and press enter or double click on nvda.exe. If NVDA was already running, it will automatically stop before starting the portable version.

As NVDA starts, you will first hear an ascending set of tones (telling you that NVDA is loading). Depending on how fast your computer is, or if you are running NVDA off a USB key or other slow media, it may take a little while to start. If it is taking an extra-long time to start, NVDA should say "Loading NVDA. Please wait..."

If you don't hear any of this, or you hear the Windows error sound, or a descending set of tones, then this means that NVDA has an error, and you will need to possibly report a bug to the developers. Please check out the NVDA website for how to do this.

Welcome Dialog

When NVDA starts for the first time, you will be greeted by a dialog box which provides you with some basic information about the NVDA modifier key and the NVDA menu. (Please see further sections about these topics.) The dialog box also contains a combo box and three checkboxes. The combo box lets you select the keyboard layout. The first checkbox lets you control if NVDA should use the Caps Lock as an NVDA modifier key. The second specifies whether NVDA should start automatically after you log on to Windows and is only available for installed copies of NVDA. The third lets you control if this Welcome dialog should appear each time NVDA starts.

Data usage statistics dialog

Starting from NVDA 2018.3, the user is asked if they want to allow usage data to be sent to NV Access in order to help improve NVDA in the future. When starting NVDA for the first time, a dialog will appear which will ask you if you want to accept sending data to NV Access while using NVDA. You can read more info about the data gathered by NV Access in the general settings section, Allow NV Access to gather NVDA usage statistics. Note: pressing on "yes" or "no" will save this setting and the dialog will never appear again unless you reinstall NVDA. However, you can enable or disable the data gathering process manually in NVDA's general settings panel. For changing this setting manually, you can check or uncheck the checkbox called Allow the NVDA project to gather NVDA usage statistics.

About NVDA keyboard commands

The NVDA Modifier Key

Most NVDA-specific keyboard commands consist of pressing a particular key called the NVDA modifier key in conjunction with one or more other keys. Notable exceptions to this are the text review commands for the desktop keyboard layout which just use the numpad keys by themselves, but there are some other exceptions as well.

NVDA can be configured so that the numpad Insert, Extended Insert and/or Caps Lock key can be used as the NVDA modifier key. By default, both the numpad Insert and Extended Insert keys are set as NVDA modifier keys.

If you wish to cause one of the NVDA modifier keys to behave as it usually would if NVDA were not running (e.g. you wish to turn Caps Lock on when you have set Caps Lock to be an NVDA modifier key), you can press the key twice in quick succession.

Keyboard Layouts

NVDA currently comes with two sets of key commands (known as keyboard layouts): the desktop layout and the laptop layout. By default, NVDA is set to use the Desktop layout, though you can switch to the Laptop layout in the Keyboard category of the NVDA Settings dialog, found under Preferences in the NVDA menu.

The Desktop layout makes heavy use of the numpad (with Num Lock off). Although most laptops do not have a physical numpad, some laptops can emulate one by holding down the FN key and pressing letters and numbers on the right-hand side of the keyboard (7, 8, 9, u, i, o, j, k, l, etc.). If your laptop cannot do this or does not allow you to turn Num Lock off, you may want to switch to the Laptop layout instead.

NVDA Touch Gestures

If you are running NVDA on a device with a touchscreen, you can also control NVDA directly via touch commands. While NVDA is running, unless touch interaction support is disabled, all touch input will go directly to NVDA. Therefore, actions that can be performed normally without NVDA will not work.

To toggle touch interaction support, press NVDA+control+alt+t.

You can also enable or disable touch interaction support from the Touch Interaction category of the NVDA settings.

Exploring the Screen

The most basic action you can perform with the touch screen is to announce the control or text at any point on the screen. To do this, place one finger anywhere on the screen. You can also keep your finger on the screen and move it around to read other controls and text that your finger moves over.

Touch Gestures

When NVDA commands are described later in this user guide, they may list a touch gesture which can be used to activate that command with the touchscreen. Following are some instructions on how to perform the various touch gestures.

Taps

Tap the screen quickly with one or more fingers.

Tapping once with one finger is simply known as a tap. Tapping with 2 fingers at the same time is a 2-finger tap and so on.

If the same tap is performed one or more times again in quick succession, NVDA will instead treat this as a multi-tap gesture. Tapping twice will result in a double-tap. Tapping 3 times will result in a triple-tap and so on. Of course, these multi-tap gestures also recognize how many fingers were used, so it's possible to have gestures like a 2-finger triple-tap, a 4-finger tap, etc.

Flicks

Quickly swipe your finger across the screen.

There are 4 possible flick gestures depending on the direction: flick left, flick right, flick up and flick down.

Just like taps, more than one finger can be used to perform the gesture. Therefore, gestures such as 2-finger flick up and 4-finger flick left are all possible.

Touch Modes

As there are many more NVDA commands than possible touch gestures, NVDA has several touch modes you can switch between which make certain subsets of commands available. The two modes are text mode and object mode. Certain NVDA commands listed in this document may have a touch mode listed in brackets after the touch gesture. For example, flick up (text mode) means that the command will be performed if you flick up, but only while in text mode. If the command does not have a mode listed, it will work in any mode.

To toggle touch modes, perform a 3-finger tap.

Touch keyboard

The touch keyboard is used to enter text and commands from a touchscreen. When focused on an edit field, you can bring up the touch keyboard by double-tapping the touch keyboard icon on the bottom of the screen. For tablets such as Microsoft Surface Pro, the touch keyboard is always available when the keyboard is undocked. To dismiss the touch keyboard, double-tap the touch keyboard icon or move away from the edit field.

While the touch keyboard is active, to locate keys on the touch keyboard, move your finger to where the touch keyboard is located (typically at the bottom of the screen), then move around the keyboard with one finger. When you find the key you wish to press, double-tap the key or lift your finger, depending on options chosen from the Touch Interaction Settings category of the NVDA Settings.

Input Help Mode

Many NVDA commands are mentioned throughout the rest of this user guide, but an easy way to explore all the different commands is to turn on input help.

To turn on input help, press NVDA+1. To turn it off, press NVDA+1 again. While in input help, performing any input gesture (such as pressing a key or performing a touch gesture) will report the action and describe what it does (if anything). The actual commands will not execute while in input help mode.

The NVDA menu

The NVDA menu allows you to control NVDA's settings, access help, save/revert your configuration, Modify speech dictionaries, access additional tools and exit NVDA.

To get to the NVDA menu from anywhere in Windows while NVDA is running, you may do any of the following:

• press NVDA+n on the keyboard.
• Perform a 2-finger double-tap on the touch screen.
• Access the system tray by pressing Windows+b, downArrow to the NVDA icon, and press enter.
• Alternatively, access the system tray by pressing Windows+b, downArrow to the NVDA icon, and open the context menu by pressing the applications key located next to the right control key on most keyboards. On a keyboard without an applications key, press shift+f10 instead.
• Right-click on the NVDA icon located in the Windows system tray

When the menu comes up, You can use the arrow keys to navigate the menu, and the enter key to activate an item.

Basic NVDA commands

Reporting System Information

Speech modes

The speech mode governs how screen content, notifications, responses to commands, and other output is spoken during operation of NVDA. The default mode is "talk", which speaks in situations that are expected when using a screen reader. However, under certain circumstances, or when running particular programs, you may find one of the other speech modes valuable.

The four available speech modes are:

• Talk (Default): NVDA will speak normally in reaction to screen changes, notifications, and actions such as moving the focus, or issuing commands.
• On-demand: NVDA will only speak when you use commands with a reporting function (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.
• Off: NVDA will not speak anything, however unlike sleep mode, it will silently react to commands.
• Beeps: NVDA will replace normal speech with short beeps.

The Beeps mode may be useful when some very verbose output is scrolling in a terminal window, but you don't care what it is, only that it is continuing to scroll; or in other circumstances when the fact that there is output is more relevant than the output itself.

The On-demand mode may be valuable when you don't need constant feedback about what is happening on screen or on the computer, but you periodically need to check particular things using review commands, etc. Examples include while recording audio, when using screen magnification, during a meeting or a call, or as an alternative to beeps mode.

A gesture allows cycling through the various speech modes:

If you only need to switch between a limited subset of speech modes, see Modes available in the Cycle speech mode command for a way to disable unwanted modes.

Navigating with NVDA

NVDA allows you to explore and navigate the system in several ways, including both normal interaction and review.

Objects

Each Application and the operating system itself consist of many objects. An object is a single item such as a piece of text, button, checkbox, slider, list or editable text field.

Navigating with the System Focus

The system focus, also known simply as the focus, is the object which receives keys typed on the keyboard. For example, if you are typing into an editable text field, the editable text field has the focus.

The most common way of navigating around Windows with NVDA is to simply move the system focus using standard Windows keyboard commands, such as pressing tab and shift+tab to move forward and back between controls, pressing alt to get to the menu bar and then using the arrows to navigate menus, and using alt+tab to move between running applications. As you do this, NVDA will report information about the object with focus, such as its name, type, value, state, description, keyboard shortcut and positional information. When Visual Highlight is enabled, the location of the current system focus is also exposed visually.

There are some key commands that are useful when moving with the System focus:

Navigating with the System Caret

When an object that allows navigation and/or editing of text is focused, you can move through the text using the system caret, also known as the edit cursor.

When the focus is on an object that has the system caret, you can use the arrow keys, page up, page down, home, end, etc. to move through the text. You can also change the text if the control supports editing. NVDA will announce as you move by character, word and line, and will also announce as you select and unselect text.

NVDA provides the following key commands in relation to the system caret:

When within a table, the following key commands are also available:

Object Navigation

Most of the time, you will work with applications using commands which move the focus and the caret. However, sometimes, you may wish to explore the current application or the Operating System without moving the focus or caret. You may also wish to work with objects that cannot be accessed normally using the keyboard. In these cases, you can use object navigation.

Object navigation allows you to move between and obtain information about individual objects. When you move to an object, NVDA will report it similarly to the way it reports the system focus. For a way to review all text as it appears on the screen, you can instead use screen review.

Rather than having to move back and forth between every single object on the system, the objects are organized hierarchically. This means that some objects contain other objects and you must move inside them to access the objects they contain. For example, a list contains list items, so you must move inside the list in order to access its items. If you have moved to a list item, moving next and previous will take you to other list items in the same list. Moving to a list item's containing object will take you back to the list. You can then move past the list if you wish to access other objects. Similarly, a toolbar contains controls, so you must move inside the toolbar to access the controls in the toolbar.

If you yet prefer to move back and forth between every single object on the system, you can use commands to move to the previous/next object in a flattened view. For example, if you move to the next object in this flattened view and the current object contains other objects, NVDA will automatically move to the first object that it contains. Alternatively, if the current object doesn't contain any objects, NVDA will move to the next object at the current level of the hierarchy. If there is no such next object, NVDA will try to find the next object in the hierarchy based on containing objects until there are no more objects to move to. The same rules apply to moving backwards in the hierarchy.

The object currently being reviewed is called the navigator object. Once you navigate to an object, you can review its content using the text review commands while in Object review mode. When Visual Highlight is enabled, the location of the current navigator object is also exposed visually. By default, the navigator object moves along with the System focus, though this behaviour can be toggled on and off.

Note: Braille following Object Navigation can be configured via Braille Tether.

To navigate by object, use the following commands:

Note: numpad keys require the Num Lock to be turned off to work properly.

Reviewing Text

NVDA allows you to read the contents of the screen, current document or current object by character, word or line. This is mostly useful in places (including Windows command consoles) where there is no system caret. For example, you might use it to review the text of a long information message in a dialog.

When moving the review cursor, the System caret does not follow along, so you can review text without losing your editing position. However, by default, when the System caret moves, the review cursor follows along. This can be toggled on and off.

Note: Braille following the review cursor can be configured via Braille Tether.

The following commands are available for reviewing text:

Note: numpad keys require the Num Lock to be turned off to work properly.

A good way to remember the basic text review commands when using the Desktop layout is to think of them as being in a grid of three by three, with top to bottom being line, word and character and left to right being previous, current and next. The layout is illustrated as follows:

Review Modes

NVDA's text review commands can review content within the current navigator object, current document or screen, depending on the review mode selected.

The following commands switch between review modes:

Object Review

While in object review mode, you are able to only review the content of the current navigator object. For objects such as editable text fields or other basic text controls, this will generally be the text content. For other objects, this may be the name and/or value.

Document Review

When the navigator object is within a browse mode document (e.g. web page) or other complex document (e.g. a Lotus Symphony document), it is possible to switch to the document review mode. The document review mode allows you to review the text of the entire document.

When switching from object review to document review, the review cursor is placed in the document at the position of the navigator object. When moving around the document with review commands, the navigator object is automatically updated to the object found at the current review cursor position.

Note that NVDA will switch to document review from object review automatically when moving around browse mode documents.

Screen Review

The screen review mode allows you to review the text of the screen as it appears visually within the current application. This is similar to the screen review or mouse cursor functionality in many other Windows screen readers.

When switching to screen review mode, the review cursor is placed at the screen position of the current navigator object. When moving around the screen with review commands, the navigator object is automatically updated to the object found at the screen position of the review cursor.

Note that in some newer applications, NVDA may not see some or all text displayed on the screen due to the use of newer screen drawing technologies which are impossible to support at this time.

Navigating with the Mouse

When you move the mouse, NVDA by default reports the text that is directly under the mouse pointer as the pointer moves over it. Where supported, NVDA will read the surrounding paragraph of text, though some controls may only read by line.

NVDA can be configured to also announce the type of object under the mouse as it moves (e.g. list, button, etc.). This may be useful for totally blind users, as sometimes, the text isn't enough.

NVDA provides a way for users to understand where the mouse is located relative to the dimensions of the screen by playing the current mouse coordinates as audio beeps. The higher the mouse is on the screen, the higher the pitch of the beeps. The further left or right the mouse is located on the screen, the further left or right the sound will be played (assuming the user has stereo speakers or headphones).

These extra mouse features are not turned on by default in NVDA. If you wish to take advantage of them, you can configure them from the Mouse settings category of the NVDA Settings dialog, found in the NVDA Preferences menu.

Although a physical mouse or trackpad should be used to navigate with the mouse, NVDA provides some commands related to the mouse:

Browse Mode

Complex read-only documents such as web pages are browsed in NVDA using browse mode. This includes documents in the following applications:

• Mozilla Firefox
• Microsoft Internet Explorer
• Mozilla Thunderbird
• HTML messages in Microsoft Outlook
• Google Chrome
• Microsoft Edge
• Adobe Reader
• Foxit Reader
• Supported books in Amazon Kindle for PC

Browse mode is also optionally available for Microsoft Word documents.

In browse mode, the content of the document is made available in a flat representation that can be navigated with the cursor keys as if it were a normal text document. All of NVDA's system caret key commands will work in this mode; e.g. say all, report formatting, table navigation commands, etc. When Visual Highlight is enabled, the location of the virtual browse mode caret is also exposed visually. Information such as whether text is a link, heading, etc. is reported along with the text as you move.

Sometimes, you will need to interact directly with controls in these documents. For example, you will need to do this for editable text fields and lists so that you can type characters and use the cursor keys to work with the control. You do this by switching to focus mode, where almost all keys are passed to the control. When in Browse mode, by default, NVDA will automatically switch to focus mode if you tab to or click on a particular control that requires it. Conversely, tabbing to or clicking on a control that does not require focus mode will switch back to browse mode. You can also press enter or space to switch to focus mode on controls that require it. Pressing escape will switch back to browse mode. In addition, you can manually force focus mode, after which it will remain in effect until you choose to disable it.

Single Letter Navigation

While in browse mode, for quicker navigation, NVDA also provides single character keys to jump to certain fields in the document. Note that not all of these commands are supported in every type of document.

The following keys by themselves jump to the next available element, while adding the shift key causes them to jump to the previous element:

• h: heading
• l: list
• i: list item
• t: table
• k: link
• n: nonLinked text
• f: form field
• u: unvisited link
• v: visited link
• e: edit field
• b: button
• x: checkbox
• c: combo box
• r: radio button
• q: block quote
• s: separator
• m: frame
• g: graphic
• d: landmark
• o: embedded object (audio and video player, application, dialog, etc.)
• 1 to 6: headings at levels 1 to 6 respectively
• a: annotation (comment, editor revision, etc.)
• w: spelling error

To move to the beginning or end of containing elements such as lists and tables:

Some web applications such as Gmail, Twitter and Facebook use single letters as shortcut keys. If you want to use these while still being able to use your cursor keys to read in browse mode, you can temporarily disable NVDA's single letter navigation keys.

To toggle single letter navigation on and off for the current document, press NVDA+shift+space.

Other navigation commands

In addition to the quick navigation commands listed above, NVDA has commands that have no default keys assigned. To use these commands, you first need to assign gestures to them using the Input Gestures dialog. Here is a list of available commands:

• Article
• Grouping
• Tab

Keep in mind that there are two commands for each type of element, for moving forward in the document and backward in the document, and you must assign gestures to both commands in order to be able to quickly navigate in both directions. For example, if you want to use the y / shift+y keys to quickly navigate through tabs, you would do the following:

1. Open input gestures dialog from browse mode.
2. Find "moves to the next tab" item in the Browse mode section.
3. Assign y key for found gesture.
4. Find "moves to the previous tab" item.
5. Assign shift+y for found gesture.

The Elements List

The elements list provides access to a list of various types of elements in the document as appropriate for the application. For example, in web browsers, the elements list can list links, headings, form fields, buttons or landmarks. Radio buttons allow you to switch between the different types of elements. An edit field is also provided in the dialog which allows you to filter the list to help you search for a particular item on the page. Once you have chosen an item, you can use the provided buttons in the dialog to move to or activate that item.

Searching for text

This dialog allows you to search for terms in the current document. In the "Type the text you wish to find" field, the text to be found can be entered. The "Case sensitive" checkbox makes the search consider uppercase and lowercase letters differently. For example, with "Case sensitive" selected you can find "NV Access" but not "nv access". Use the following keys for performing searches:

Embedded Objects

Pages can include rich content using technologies such as Oracle Java and HTML5, as well as applications and dialogs. Where these are encountered in browse mode, NVDA will report "embedded object", "application" or "dialog", respectively. You can quickly move to them using the o and shift+o embedded object single letter navigation keys. To interact with these objects, you can press enter on them. If it is accessible, you can then tab around it and interact with it like any other application. A key command is provided to return to the original page containing the embedded object:

Native Selection Mode

By default when selecting text with the shift+arrow keys in Browse Mode, a selection is only made within NVDA's Browse Mode representation of the document, and not within the application itself. This means that the selection is not visible on screen, and copying text with control+c will only copy NVDA's plain text representation of the content. i.e. formatting of tables, or whether something is a link will not be copied. However, NVDA has a Native Selection Mode which can be turned on in particular Browse Mode documents (so far only Mozilla Firefox) which causes the document's native selection to follow NVDA's Browse Mode selection.

When Native Selection Mode is turned on, copying the selection with control+c will also use the application's own copy functionality, meaning that rich content will be copied to the clipboard, rather than plain text. This means that pasting this content into a program such as Microsoft Word or Excel, formatting such as tables, or whether something is a link will be included. Please note however that in native selection mode, some accessible labels or other information that NVDA generates in Browse Mode will not be included. Also, although the application will try its best to match the native selection to NVDA's Browse Mode selection, it may not always be completely accurate. However, for scenarios where you wish to copy an entire table or paragraph of rich content, this feature should prove useful.

Reading Mathematical Content

NVDA can read and navigate mathematical content on the web and in other applications, providing access in both speech and braille. However, in order for NVDA to read and interact with mathematical content, you will first need to install a Math component for NvDA. There are several NVDA add-ons available in the NVDA Add-on Store that provide support for math, including the MathCAT NVDA add-on and Access8Math. Please refer to the Add-on Store section to learn how to browse and install available add-ons in NVDA. NVDA also can make use of the older MathPlayer software from Wiris if found on your system, though this software is no longer maintained.

Supported math content

With an appropriate math component installed, NVDA supports the following types of mathematical content:

• MathML in Mozilla Firefox, Microsoft Internet Explorer and Google Chrome.
• Microsoft Word 365 Modern Math Equations via UI automation: NVDA is able to read and interact with math equations in Microsoft Word 365/2016 build 14326 and higher. Note however that any previously created MathType equations must be first converted to Office Math. This can be done by selecting each and choosing "Equation Options", then "Convert to Office Math" in the context menu. Ensure your version of MathType is the latest version before doing this. Microsoft Word provides linear symbol-based navigation through the equations itself and supports inputting math using several syntaxes, including LateX. For further details, please see Linear format equations using UnicodeMath and LaTeX in Word
• Microsoft Powerpoint, and older versions of Microsoft Word: NVDA can read and navigate MathType equations in both Microsoft Powerpoint and Microsoft word. MathType needs to be installed in order for this to work. The trial version is sufficient. It can be downloaded from the MathType presentation page.
• Adobe Reader: Note that this is not an official standard yet, so there is currently no publicly available software that can produce this content.
• Kindle Reader for PC: NVDA can read and navigate Math in Kindle for PC for books with accessible math.

When reading a document, NVDA will speak any supported mathematical content where it occurs. If you are using a braille display, it will also be displayed in braille.

Interactive Navigation

If you are working primarily with speech, in most cases, you will probably wish to examine the expression in smaller segments, rather than hearing the entire expression at once.

If you are in browse mode, you can do this by moving the cursor to the mathematical content and pressing enter.

If you are not in browse mode:

1. move the review cursor to the mathematical content. By default, the review cursor follows the system caret, so you can usually use the system caret to move to the desired content.
2. Then, activate the following command:

At this point, NVDA will enter Math mode, where you can use commands such as the arrow keys to explore the expression. For example, you can move through the expression with the left and right arrow keys and zoom into a portion of the expression such as a fraction using the down arrow key.

When you wish to return to the document, simply press the escape key.

For more information on available commands and preferences for reading and navigating within math content, please refer to the documentation for your particular math component you have installed.

• MathCAT documentation
• Access8Math documentation
• MathPlayer documentation

Sometimes mathematical content might be displayed as a button or other type of element which, when activated, can display a dialog or more information related to the formula. To activate the button or the element containing the formula, press ctrl+enter.

Installing MathPlayer

Although it is generally recommended to use one of the newer NVDA add-ons to support math in NVDA, in certain limited scenarios MathPlayer may still be a more suitable choice. E.g. MathPlayer may support a particular language or Braille code that is unsupported in newer add-ons. MathPlayer is available for free from the Wiris website. Download MathPlayer. After installing MathPlayer, you will need to restart NVDA. Please note that information about MathPlayer may state that it is only for older browsers such as Internet Explorer 8. This is only referring to using MathPlayer to display mathematical content visually, and can be ignored by those using it to read or navigate math with NVDA.

Braille

If you own a braille display, NVDA can display information in braille. If your braille display has a Perkins-style keyboard, you can also enter contracted or uncontracted braille. Braille can also be displayed on screen using the Braille Viewer instead of, or at the same time as, using a physical braille display.

Please see the Supported Braille Displays section for information about the supported braille displays. This section also contains information about what displays support NVDA's automatic background braille display detection functionality. You can configure braille using the Braille category of the NVDA Settings dialog.

Control Type, State and Landmark abbreviations

In order to fit as much information as possible on a braille display, the following abbreviations have been defined to indicate control type and state as well as landmarks.

The following state indicators are also defined:

Finally, the following abbreviations for landmarks are defined:

Braille Input

NVDA supports entry of both uncontracted and contracted braille via a braille keyboard. You can select the translation table used to translate braille into text using the Input table setting in the Braille category of the NVDA Settings dialog.

When uncontracted braille is being used, text is inserted as soon as it is entered. When using contracted braille, text is inserted when you press space or enter at the end of a word. Note that translation can only reflect the braille word you are typing and cannot consider existing text. For example, if you are using a braille code that begins numbers with a number sign and you press backspace to move to the end of a number, you will need to type the number sign again to enter additional numbers.

Pressing dot 7 erases the last entered braille cell or character. Dot 8 translates any braille input and presses the enter key. Pressing dot 7 + dot 8 translates any braille input, but without adding a space or pressing enter.

Inputting keyboard shortcuts

NVDA supports inputting keyboard shortcuts and emulating keypresses using the braille display. This emulation comes in two forms: assigning a Braille input directly to some key press and using the virtual modifier keys.

Commonly-used keys, such as the arrow keys or pressing Alt to reach menus, can be mapped directly to Braille inputs. The driver for each Braille display comes pre-equipped with some of these assignments. You can change these assignments or add new emulated keys from the Input Gestures dialog.

While this approach is useful for commonly-pressed or unique keys (such as Tab), you may not want to assign a unique set of keys to each keyboard shortcut. To allow emulating keypresses where modifier keys are held down, NVDA provides commands to toggle the control, alt, shift, windows, and NVDA keys, along with commands for some combinations of those keys. To use these toggles, first press the command (or sequence of commands) for the modifier keys you want pressed. Then input the character that's part of the keyboard shortcut you want to input. For example, to produce control+f, use the "Toggle control key" command and then type an f, and to input control+alt+t, use either the "Toggle control key" and "Toggle alt key" commands, in either order, or the "Toggle control and alt keys" command, followed by typing a t.

If you accidentally toggle modifier keys, running the toggle command again will remove the modifier.

When typing in contracted Braille, using the modifier toggle keys will cause your input to be translated just as if you had pressed dots 7+8. In addition, the emulated keypress cannot reflect Braille typed before the modifier key was pressed. This means that, to type alt+2 with a Braille code that uses a number sign, you must first toggle Alt and then type a number sign.

Vision

While NVDA is primarily aimed at blind or vision impaired people who primarily use speech and/or braille to operate a computer, it also provides built-in facilities to change the contents of the screen. Within NVDA, such a visual aid is called a vision enhancement provider.

NVDA offers several built-in vision enhancement providers which are described below. Additional vision enhancement providers can be provided in NVDA add-ons.

NVDA's vision settings can be changed in the vision category of the NVDA Settings dialog.

Visual Highlight

Visual Highlight can help to identify the system focus, navigator object and browse mode positions. These positions are highlighted with a coloured rectangle outline.

• Solid blue highlights a combined navigator object and system focus location (e.g. because the navigator object follows the system focus).
• Dashed blue highlights just the system focus object.
• Solid pink highlights just the navigator object.
• Solid yellow highlights the virtual caret used in browse mode (where there is no physical caret such as in web browsers).

When Visual Highlight is enabled in the vision category of the NVDA Settings dialog, you can change whether or not to highlight the focus, navigator object or browse mode caret.

Screen Curtain

As a blind or vision impaired user, it is often not possible or necessary to see the contents of the screen. Furthermore, it might be hard to ensure that there isn't someone looking over your shoulder. For this situation, NVDA contains a feature called "Screen Curtain" which can be enabled to make the screen black.

You can enable the Screen Curtain in the vision category of the NVDA Settings dialog.

When the Screen Curtain is active some tasks directly based on what appears on the screen such as performing OCR or taking a screenshot cannot be achieved.

Due to a change in the Windows Magnification API, Screen Curtain had to be updated to support the newest versions of Windows. Use NVDA 2021.2 to activate Screen Curtain with Windows 10 21H2 (10.0.19044) or later. For security purposes, when using a new version of Windows, get visual confirmation that the Screen Curtain makes the screen entirely black.

Content Recognition

When authors don't provide sufficient information for a screen reader user to determine the content of something, various tools can be used to attempt to recognize the content from an image. NVDA supports the optical character recognition (OCR) functionality built into Windows 10 and later to recognize text from images. Additional content recognizers can be provided in NVDA add-ons.

When you use a content recognition command, NVDA recognizes content from the current navigator object. By default, the navigator object follows the system focus or browse mode cursor, so you can usually just move the focus or browse mode cursor where desired. For example, if you move the browse mode cursor to a graphic, recognition will recognize content from the graphic by default. However, you may wish to use object navigation directly to, for example, recognize the content of an entire application window.

Once recognition is complete, the result will be presented in a document similar to browse mode, allowing you to read the information with cursor keys, etc. Pressing enter or space will activate (normally click) the text at the cursor if possible. Pressing escape dismisses the recognition result.

Windows OCR

Windows 10 and later includes OCR for many languages. NVDA can use this to recognize text from images or inaccessible applications.

You can set the language to use for text recognition in the Windows OCR category of the NVDA Settings dialog. Additional languages can be installed by opening the Start menu, choosing Settings, selecting Time & Language -> Region & Language and then choosing Add a language.

When you want to monitor constantly changing content, such as when watching a video with subtitles, you can optionally enable automatic refresh of the recognized content. This can also be done in the Windows OCR category of the NVDA Settings dialog.

Windows OCR may be partially or fully incompatible with NVDA vision enhancements or other external visual aids. You will need to disable these aids before proceeding to a recognition.

To recognize the text in the current navigator object using Windows OCR, press NVDA+r.

Application Specific Features

NVDA provides its own extra features for some applications to make certain tasks easier or to provide access to functionality which is not otherwise accessible to screen reader users.

Microsoft Word

Automatic Column and Row Header Reading

NVDA is able to automatically announce appropriate row and column headers when navigating around tables in Microsoft Word. This requires that the Report Table row / column headers option in NVDA's Document Formatting settings, found in the NVDA Settings dialog, be turned on.

If you use UIA to access Word documents, which is default in recent versions of Word and Windows, the cells of the first row will automatically be considered as column headers; similarly, the cells of the first column will automatically be considered as row headers.

On the contrary, if you do not use UIA to access Word documents, you will have to indicate to NVDA which row or column contains the headers in any given table. After moving to the first cell in the column or row containing the headers, use one of the following commands:

These settings will be stored in the document as bookmarks compatible with other screen readers such as JAWS. This means that users of other screen readers who open this document at a later date will automatically have the row and column headers already set.

Browse Mode in Microsoft Word

Similar to the web, Browse mode can be used in Microsoft Word to allow you to use features such as Quick navigation and the Elements List.

To toggle Browse mode on and off in Microsoft Word, press NVDA+space.

For further information about Browse mode and Quick Navigation, see the Browse Mode section.

The Elements List

While in Browse mode in Microsoft Word, you can access the Elements List by pressing NVDA+f7.

The Elements List can list headings, links, annotations (which includes comments and track changes) and errors (currently limited to spelling errors).

Reporting Comments

To report any comments at the current caret position, press NVDA+alt+c.

All comments for the document, along with other tracked changes, can also be listed in the NVDA Elements List when selecting Annotations as the type.

Microsoft Excel

Automatic Column and Row Header Reading

NVDA is able to automatically announce appropriate row and column headers when navigating around Excel worksheets. This firstly requires that the Report Table row / column headers option in NVDA's Document Formatting settings, found in the NVDA Settings dialog, be turned on. Secondly, NVDA needs to know which row or column contains the headers. After moving to the first cell in the column or row containing the headers, use one of the following commands:

These settings will be stored in the workbook as defined name ranges compatible with other screen readers such as JAWS. This means that users of other screen readers who open this workbook at a later date will automatically have the row and column headers already set.

The Elements List

Similar to the web, NVDA has an Elements List for Microsoft Excel that allows you to list and access several different types of information.

To access the Elements List in Excel, press NVDA+f7.

The various types of information available in the Elements List are:

• Charts: This lists all charts in the active worksheet. Selecting a chart and pressing enter or the Move to button focuses the chart for navigating and reading with the arrow keys.
• Comments: This lists all cells in the active worksheet containing comments. The cell address along with its comments are shown for each cell. Pressing enter or the Move To button when on a listed comment will move directly to that cell.
• Formulas: This lists all cells in the worksheet containing a formula. The cell address along with its formula are shown for each cell. Pressing enter or the Move To button on a listed formula will move directly to that cell.
• Sheets: This lists all sheets in the workbook. Pressing f2 when on a listed sheet allows you to rename the sheet. Pressing enter or the Move To button while on the listed sheet will switch to that sheet.
• Form fields: This lists all form fields in the active worksheet. For each form field, the Elements List shows the alternative text of the field along with the addresses of the cells it covers. Selecting a form field and pressing enter or the Move to button moves to that field in browse mode.

Reporting Notes

To report any notes for the currently focused cell, press NVDA+alt+c. In Microsoft 2016, 365 and newer, the classic comments in Microsoft Excel have been renamed to "notes".

All notes for the worksheet can also be listed in the NVDA Elements List after pressing NVDA+f7.

NVDA can also display a specific dialog for adding or editing a certain note. NVDA overrides the native MS Excel notes editing region due to accessibility constraints, but the key stroke for displaying the dialog is inherited from MS Excel and therefore works also without NVDA running.

To add or edit a certain note, in a focused cell, press shift+f2.

This key stroke does not appear and cannot be changed in NVDA's input gesture dialog.

Note: it is possible to open the note editing region in MS Excel also from the context menu of any cell of the work sheet. However, this will open the inaccessible note editing region and not the NVDA specific note editing dialog.

In Microsoft Office 2016, 365 and newer, a new style comment dialog has been added. This dialog is accessible and provides more features such as replying to comments, etc. It can also be opened from the context menu of a certain cell. The comments added to the cells via the new style comment dialog are not related to "notes".

Reading Protected Cells

If a workbook has been protected, it may not be possible to move focus to particular cells that have been locked for editing.

To allow moving to locked cells, switch to Browse Mode by pressing NVDA+space, and then use standard Excel movement commands such as the arrow keys to move around all cells on the current worksheet.

Form Fields

Excel worksheets can include form fields. You can access these using the Elements List or the f and shift+f form field single letter navigation keys. Once you move to a form field in browse mode, you can press enter or space to either activate it or switch to focus mode so you can interact with it, depending on the control. For further information about Browse mode and single letter navigation, see the Browse Mode section.

Microsoft PowerPoint

foobar2000

Note: The above shortcuts work only with the default formatting string for foobar's status line.

Miranda IM

Poedit

NVDA offers enhanced support for Poedit 3.4 or newer.

Kindle for PC

NVDA supports reading and navigating books in Amazon Kindle for PC. This functionality is only available in Kindle books designated with "Screen Reader: Supported" which you can check on the details page for the book.

Browse mode is used to read books. It is enabled automatically when you open a book or focus the book area. The page will be turned automatically as appropriate when you move the cursor or use the say all command.

You can manually turn to the next page with the pageDown key and turn to the previous page with the pageUp key.

Single letter navigation is supported for links and graphics, but only within the current page. Navigating by link also includes footnotes.

NVDA provides early support for reading and interactive navigation of mathematical content for books with accessible math. Please see the Reading Mathematical Content section for further information.

Text Selection

Kindle allows you to perform various functions on selected text, including obtaining a dictionary definition, adding notes and highlights, copying the text to the clipboard and searching the web. To do this, first select text as you normally would in browse mode; e.g. by using shift and the cursor keys.

Once you have selected text, press the applications key or shift+f10 to show the available options for working with the selection.

If you do this with no text selected, options will be shown for the word at the cursor.

User Notes

You can add a note regarding a word or passage of text. To do this, first select the relevant text and access the selection options as described above. Then, choose Add Note.

When reading in browse mode, NVDA refers to these notes as comments.

To view, edit or delete a note:

1. Move the cursor to the text containing the note.
2. Access the options for the selection as described above.
3. Choose Edit Note.

Azardi

When in the table view of added books:

Windows Console

NVDA provides support for the Windows command console used by Command Prompt, PowerShell, and the Windows Subsystem for Linux. The console window is of fixed size, typically much smaller than the buffer that holds the output. As new text is written, the content scroll upwards and previous text is no longer visible. On Windows versions before Windows 11 22H2, text in the console that is not visibly displayed in the window is not accessible with NVDA's text review commands. Therefore, it is necessary to scroll the console window to read earlier text. In newer versions of the console and in Windows Terminal, it is possible to review the entire text buffer freely without the need to scroll the window.

The following built-in Windows Console keyboard shortcuts may be useful when reviewing text with NVDA in older versions of Windows Console:

Configuring NVDA

Most configuration can be performed using dialog boxes accessed through the Preferences sub-menu of the NVDA menu. Many of these settings can be found in the multi-page NVDA Settings dialog. In all dialog boxes, press the OK button to accept any changes you have made. To cancel any changes, press the Cancel button or the escape key. For certain dialogs, you can press the Apply button to let the settings take effect immediately without closing the dialog. Most NVDA dialogs support context help.

When in a dialog, pressing f1 opens the User Guide at the paragraph related to the focused setting or the current dialog.

Some settings can also be changed using shortcut keys, which are listed where relevant in the sections below.

NVDA Settings

NVDA provides many configuration parameters that can be changed using the settings dialog. To make it easier to find the kind of settings you want to change, the dialog displays a list of configuration categories to choose from. When you select a category, all of the settings related to it will be shown in the dialog. To move between categories, use tab or shift+tab to reach the list of categories, and then use the up and down arrow keys to navigate the list. From anywhere in the dialog, you may also move forward one category by pressing ctrl+tab, or back one category by pressing shift+ctrl+tab.

Once you change one or more settings, the settings can be applied using the apply button, in which case the dialog will stay open, allowing you to change more settings or choose another category. If you want to save your settings and close the NVDA Settings dialog, you can use the OK button.

Some settings categories have dedicated shortcut keys. If pressed, the shortcut key will open the NVDA Settings dialog directly to that particular category. By default, not all categories can be accessed with keyboard commands. If you frequently access categories that do not have dedicated shortcut keys, you may wish to use the Input Gestures dialog to add a custom gesture such as a keyboard command or touch gesture for that category.

The settings categories found in the NVDA Settings dialog will be outlined below.

General

Open General settings

Key: NVDA+control+g

The General category of the NVDA Settings dialog sets NVDA's overall behaviour such as interface language and whether or not it should check for updates. This category contains the following options:

Language

This is a combo box which allows you to select the language that NVDA's user interface and messages should be shown in. There are many languages, however the default option is "User Default, Windows". This option tells NVDA to use the language that Windows is currently set to.

Please note that NVDA must be restarted when changing the language. When the confirmation dialog appears, select "restart now" or "restart later" if you wish to use the new language now or at a later time, respectively. If "restart later" is selected, the configuration must be saved (either manually or using the save on exit functionality).

Save configuration on exit

This option is a checkbox that, when checked, tells NVDA to automatically save the current configuration when you exit NVDA.

Show exit options when exiting NVDA

This option is a checkbox that allows you to choose whether or not a dialog appears when you exit NVDA that asks what action you want to perform. When checked, a dialog will appear when you attempt to exit NVDA asking whether you want to exit, restart, restart with add-ons disabled or install pending updates (if any). When unchecked, NVDA will exit immediately.

Play sounds when starting or exiting NVDA

This option is a checkbox that, when checked, tells NVDA to play sounds when it starts or exits.

Logging level

This is a combo box that lets you choose how much NVDA will log as it's running. Generally users should not need to touch this as not too much is logged. However, if you wish to provide information in a bug report, or enable or disable logging altogether, then it may be a useful option.

The available logging levels are:

• Disabled: Apart from a brief startup message, NVDA will not log anything while it runs.
• Info: NVDA will log basic information such as startup messages and information useful for developers.
• Debug warning: Warning messages that are not caused by severe errors will be logged.
• Input/output: Input from keyboard and braille displays, as well as speech and braille output will be logged. If you are concerned about privacy, do not set the logging level to this option.
• Debug: In addition to info, warning, and input/output messages, additional debug messages will be logged. Just like input/output, if you are concerned about privacy, you should not set the logging level to this option.

Start NVDA after I sign in

If this option is enabled, NVDA will start automatically as soon as you sign in to Windows. This option is only available for installed copies of NVDA.

Use NVDA during sign-in (requires administrator privileges)

If you sign in to Windows by providing a user name and password, then enabling this option will make NVDA start automatically at the sign-in screen when Windows starts. This option is only available for installed copies of NVDA.

Use currently saved settings during sign-in and on secure screens (requires administrator privileges)

Pressing this button copies your currently saved NVDA user configuration to NVDA's system configuration directory, so that NVDA will use it during sign-in and when running on User Account Control (UAC) and other secure screens. To make sure that all your settings are transferred, make sure to save your configuration first with control+NVDA+c or Save configuration in the NVDA menu. This option is only available for installed copies of NVDA.

Automatically check for updates to NVDA

If this is enabled, NVDA will automatically check for updated versions and inform you when an update is available. You can also manually check for updates by selecting Check for updates under Help in the NVDA menu. When manually or automatically checking for updates, it is necessary for NVDA to send some information to the update server in order to receive the correct update for your system. The following information is always sent:

• Current NVDA version
• Operating System version
• Whether the Operating System is 64 or 32 bit

Allow NV Access to gather NVDA usage statistics

If this is enabled, NV Access will use the information from update checks in order to track the number of NVDA users including particular demographics such as Operating system and country of origin. Note that although your IP address will be used to calculate your country during the update check, the IP address is never kept. Apart from the mandatory information required to check for updates, the following extra information is also currently sent:

• NVDA interface language
• Whether this copy of NVDA is portable or installed
• Name of the current speech synthesizer in use (including the name of the add-on the driver comes from)
• Name of the current Braille display in use (including the name of the add-on the driver comes from)
• The current output Braille table (if Braille is in use)

This information greatly aides NV Access to prioritize future development of NVDA.

Notify for pending updates on startup

If this is enabled, NVDA will inform you when there is a pending update on startup, offering you the possibility to install it. You can also manually install the pending update from the Exit NVDA dialog (if enabled), from the NVDA menu, or when you perform a new check from the Help menu.

Speech Settings

Open Speech settings

Key: NVDA+control+v

The Speech category in the NVDA Settings dialog contains options that lets you change the speech synthesizer as well as voice characteristics for the chosen synthesizer. For a quicker alternative way of controlling speech parameters from anywhere, please see the Synth Settings Ring section.

The Speech Settings category contains the following options:

Change synthesizer

The first option in the Speech Settings category is the Change... button. This button activates the Select Synthesizer dialog, which allows you to select the active speech synthesizer and output device. This dialog opens on top of the NVDA Settings dialog. Saving or dismissing the settings in the Select Synthesizer dialog will return you to the NVDA Settings dialog.

Voice

The Voice option is a combo box listing all the voices of the current synthesizer that you have installed. You can use the arrow keys to listen to all the various choices. Left and Up arrow take you up in the list, while right and down arrow move you down in the list.

Variant

If you are using the Espeak NG synthesizer which is packaged with NVDA, this is a combo box that allows you to select the Variant the synthesizer should speak with. ESpeak NG's Variants are rather like voices, as they provide slightly different attributes to the eSpeak NG voice. Some variants will sound like a male, some like a female, and some even like a frog. If using a third-party synthesizer, you may also be able to change this value if your chosen voice supports it.

Rate

This option allows you to change the rate of your voice. This is a slider that goes from 0 to 100 - 0 being the slowest, 100 being the fastest.

Rate boost

Enabling this option will significantly increase the speech rate, if supported by the current synthesizer.

Pitch

This option allows you to change the pitch of the current voice. It is a slider which goes from 0 to 100 - 0 being the lowest pitch and 100 being the highest.

Volume

This option is a slider which goes from 0 to 100 - 0 being the lowest volume and 100 being the highest.

Inflection

This option is a slider that lets you choose how much inflection (rise and fall in pitch) the synthesizer should use to speak with.

Automatic Language switching

This checkbox allows you to toggle whether NVDA should switch speech synthesizer languages automatically if the text being read specifies its language. This option is enabled by default.

Automatic Dialect switching

This checkbox allows you to toggle whether or not dialect changes should be made, rather than just actual language changes. For example, if reading in an English U.S. voice but a document specifies that some text is in English U.K., then the synthesizer will switch accents if this option is enabled. This option is disabled by default.

Punctuation/Symbol Level

Key: NVDA+p

This allows you to choose the amount of punctuation and other symbols that should be spoken as words. For example, when set to all, all symbols will be spoken as words. This option applies to all synthesizers, not just the currently active synthesizer.

Trust voice's language when processing characters and symbols

On by default, this option tells NVDA if the current voice's language can be trusted when processing symbols and characters. If you find that NVDA is reading punctuation in the wrong language for a particular synthesizer or voice, you may wish to turn this off to force NVDA to use its global language setting instead.

Include Unicode Consortium data (including emoji) when processing characters and symbols

When this checkbox is checked, NVDA will include additional symbol pronunciation dictionaries when pronouncing characters and symbols. These dictionaries contain descriptions for symbols (particularly emoji) that are provided by the Unicode Consortium as part of their Common Locale Data Repository. If you want NVDA to speak descriptions of emoji characters based on this data, you should enable this option. However, if you are using a speech synthesizer that supports speaking emoji descriptions natively, you may wish to turn this off.

Note that manually added or edited character descriptions are saved as part of your user settings. Therefore, if you change the description of a particular emoji, your custom description will be spoken for that emoji regardless of whether this option is enabled. You can add, edit or remove symbol descriptions in NVDA's punctuation/symbol pronunciation dialog.

To toggle Unicode Consortium data inclusion from anywhere, please assign a custom gesture using the Input Gestures dialog.

Capital pitch change percentage

This edit field allows you to type the amount that the pitch of the voice will change when speaking a capital letter. This value is a percentage, where a negative value lowers the pitch and a positive value raises it. For no pitch change you would use 0. Usually, NVDA raises the pitch slightly for any capital letter, but some synthesizers may not support this well. In case pitch change for capitals is not supported, consider Say "cap" before capitals and/or Beep for capitals instead.

Say "cap" before capitals

This setting is a checkbox that, when checked, tells NVDA to say the word "cap" before any capital letter when spoken as an individual character such as when spelling.

Beep for capitals

If this checkbox is checked, NVDA will make a small beep each time it encounters a capitalized character by itself.

Use spelling functionality if supported

Some words consist of only one character, but the pronunciation is different depending on whether the character is being spoken as an individual character (such as when spelling) or a word. For example, in English, "a" is both a letter and a word and is pronounced differently in each case. This option allows the synthesizer to differentiate between these two cases if the synthesizer supports this. Most synthesizers do support it.

This option should generally be enabled. However, some Microsoft Speech API synthesizers do not implement this correctly and behave strangely when it is enabled. If you are having problems with the pronunciation of individual characters, try disabling this option.

Delayed descriptions for characters on cursor movement

When this setting is checked, NVDA will say the character description when you move by characters.

For example, while reviewing a line by characters, when the letter "b" is read NVDA will say "Bravo" after a 1 second delay. This can be useful if it is hard to distinguish between pronunciation of symbols, or for hearing impaired users.

The delayed character description will be cancelled if other text is spoken during that time, or if you press the control key.

Modes available in the Cycle speech mode command

This checkable list allows selecting which speech modes are included when cycling between them using NVDA+s. Modes which are unchecked are excluded. By default all modes are included.

For example if you do not need to use "beeps" and "off" mode you should uncheck these two, and keep both "talk" and "on-demand" checked. Note that it is necessary to check at least two modes.

Select Synthesizer

Open Select Synthesizer dialog

Key: NVDA+control+s

The Synthesizer dialog, which can be opened by activating the Change... button in the speech category of the NVDA settings dialog, allows you to select which Synthesizer NVDA should use to speak with. Once you have selected your synthesizer of choice, you can press Ok and NVDA will load the selected Synthesizer. If there is an error loading the synthesizer, NVDA will notify you with a message, and continue using the previous synthesizer.

Synthesizer

This option allows you to choose the synthesizer you wish NVDA to use for speech output.

For a list of the Synthesizers that NVDA supports, please see the Supported Speech Synthesizers section.

One special item that will always appear in this list is "No speech", which allows you to use NVDA with no speech output whatsoever. This may be useful for someone who wishes to only use NVDA with braille, or perhaps to sighted developers who only wish to use the Speech Viewer.

Synth settings ring

If you wish to quickly change speech settings without going to the Speech category of the NVDA settings dialog, there are some NVDA key commands that allow you to move through the most common speech settings from anywhere while running NVDA:

Braille

The Braille category in the NVDA Settings dialog contains options that let you change several aspects of braille input and output. This category contains the following options:

Change braille display

The Change... button in the Braille category of the NVDA Settings dialog activates the Select Braille Display dialog, which allows you to select the active braille display. This dialog opens on top of the NVDA Settings dialog. Saving or dismissing the settings in the Select Braille Display dialog will return you to the NVDA Settings dialog.

Output Table

The next option you will come to in this category is the braille output table combo box. In this combo box, you will find braille tables for different languages, braille standards and grades. The chosen table will be used to translate text into braille to be presented on your braille display. You can move from braille table to braille table in the list by using the arrow keys.

Input Table

Complementary to the previous option, the next setting you will find is the braille input table combo box. The chosen table will be used to translate braille entered on your braille display's Perkins-style keyboard into text. You can move from braille table to braille table in the list by using the arrow keys.

Note that this option is only useful if your braille display has a Perkins-style keyboard and this feature is supported by the braille display driver. If input is not supported on a display which does have a braille keyboard, this will be noted in the Supported Braille Displays section.

Expand to computer braille for the word at the cursor

This option allows the word that is under the cursor to be displayed in non-contracted computer braille.

Show Cursor

This option allows the braille cursor to be turned on and off. It applies to the system caret and review cursor, but not to the selection indicator.

Blink Cursor

This option allows the braille cursor to blink. If blinking is turned off, the braille cursor will constantly be in the "up" position. The selection indicator is not affected by this option, it is always dots 7 and 8 without blinking.

Cursor Blink Rate (ms)

This option is a numerical field that allows you to change the blink rate of the cursor in milliseconds.

Cursor Shape for Focus

This option allows you to choose the shape (dot pattern) of the braille cursor when braille is tethered to focus. The selection indicator is not affected by this option, it is always dots 7 and 8 without blinking.

Cursor Shape for Review

This option allows you to choose the shape (dot pattern) of the braille cursor when braille is tethered to review. The selection indicator is not affected by this option, it is always dots 7 and 8 without blinking.

Show Messages

This is a combobox that allows you to select if NVDA should display braille messages and when they should disappear automatically.

To toggle show messages from anywhere, please assign a custom gesture using the Input Gestures dialog.

Message Timeout (sec)

This option is a numerical field that controls how long NVDA messages are displayed on the braille display. The NVDA message is immediately dismissed when pressing a routing key on the braille display, but appears again when pressing a corresponding key which triggers the message. This option is shown only if "Show Messages" is set to "Use timeout".

Tether Braille

Key: NVDA+control+t

This option allows you to choose whether the braille display will follow the system focus / caret, the navigator object / review cursor, or both. When "automatically" is selected, NVDA will follow the system focus and caret by default. In this case, when the navigator object or the review cursor position is changed by means of explicit user interaction, NVDA will tether to review temporarily, until the focus or the caret changes. If you want it to follow the focus and caret only, you need to configure braille to be tethered to focus. In this case, braille will not follow the NVDA navigator during object navigation or the review cursor during review. If you want braille to follow object navigation and text review instead, you need to configure braille to be tethered to review. In this case, Braille will not follow system focus and system caret.

Move system caret when routing review cursor

This setting determines if the system caret should also be moved with a routing button press. This option is set to Never by default, meaning that routing will never move the caret when routing the review cursor.

When this option is set to Always, and braille tethering is set to "automatically" or "to review", pressing a cursor routing key will also move the system caret or focus when supported. When the current review mode is Screen Review, there is no physical caret. In this case, NVDA tries to focus the object under the text you're routing to. The same applies to object review.

You can also set this option to only move the caret when tethered automatically. In that case, pressing a cursor routing key will only move the system caret or focus when NVDA is tethered to the review cursor automatically, whereas no movement will occur when manually tethered to the review cursor.

This option is shown only if "tether braille" is set to "automatically" or "to review".

To toggle move system caret when routing review cursor from anywhere, please assign a custom gesture using the Input Gestures dialog.

Read by Paragraph

If enabled, braille will be displayed by paragraphs instead of lines. Also, the next and previous line commands will move by paragraph accordingly. This means that you do not have to scroll the display at the end of each line even where more text would fit on the display. This may allow for more fluent reading of large amounts of text. It is disabled by default.

Avoid splitting words when possible

If this is enabled, a word which is too large to fit at the end of the braille display will not be split. Instead, there will be some blank space at the end of the display. When you scroll the display, you will be able to read the entire word. This is sometimes called "word wrap". Note that if the word is too large to fit on the display even by itself, the word must still be split.

If this is disabled, as much of the word as possible will be displayed, but the rest will be cut off. When you scroll the display, you will then be able to read the rest of the word.

Enabling this may allow for more fluent reading, but generally requires you to scroll the display more.

Focus context presentation

This option allows you to choose what context information NVDA will show on the braille display when an object gets focus. Context information refers to the hierarchy of objects containing the focus. For example, when you focus a list item, this list item is part of a list. This list might be contained by a dialog, etc. Please consult the section about object navigation for more information about the hierarchy that applies to objects in NVDA.

When set to fill display for context changes, NVDA will try to display as much context information as possible on the braille display, but only for the parts of the context that have changed. For the example above, this means that when changing focus to the list, NVDA will show the list item on the braille display. Furthermore, if there is enough space left on the braille display, NVDA will try to show that the list item is part of a list. If you then start moving through the list with your arrow keys, it is assumed that you are aware that you are still in the list. Thus, for the remaining list items you focus, NVDA will only show the focused list item on the display. In order for you to read the context again (i.e. that you are in a list and that the list is part of a dialog), you will have to scroll your braille display back.

When this option is set to always fill the display, NVDA will try to show as much context information as possible on the braille display, regardless of whether you have seen the same context information before. This has the advantage that NVDA will fit as much information as possible on the display. However, the downside is that there is always a difference in the position where the focus starts on the braille display. This can make it difficult to skim a long list of items, for example, as you will need to continually move your finger to find the start of the item. This was the default behaviour for NVDA 2017.2 and before.

When you set the focus context presentation option to only show the context information when scrolling back, NVDA never shows context information on your braille display by default. Thus, in the example above, NVDA will display that you focused a list item. However, in order for you to read the context (i.e. that you are in a list and that the list is part of a dialog), you will have to scroll your braille display back.

To toggle focus context presentation from anywhere, please assign a custom gesture using the Input Gestures dialog.

Interrupt speech while scrolling

This setting determines if speech should be interrupted when the Braille display is scrolled backwards/forwards. Previous/next line commands always interrupt speech.

On-going speech might be a distraction while reading Braille. For this reason the option is enabled by default, interrupting speech when scrolling braille.

Disabling this option allows speech to be heard while simultaneously reading Braille.

Show selection

This setting determines if selection indicator (dots 7 and 8) is shown by the braille display. The option is enabled by default so the selection indicator is shown. The selection indicator might be a distraction while reading. Disabling this option may improve readability.

To toggle show selection from anywhere, please assign a custom gesture using the Input Gestures dialog.

Select Braille Display

Open Select Braille Display dialog

Key: NVDA+control+a

The Select Braille Display dialog, which can be opened by activating the Change... button in the Braille category of the NVDA settings dialog, allows you to select which Braille display NVDA should use for braille output. Once you have selected your braille display of choice, you can press Ok and NVDA will load the selected display. If there is an error loading the display driver, NVDA will notify you with a message, and continue using the previous display, if any.

Braille Display

This combo box presents you with several options depending on what braille display drivers are available on your system. Move between these options with the arrow keys.

The automatic option will allow NVDA to search for many supported braille displays in the background. When this feature is enabled and you connect a supported display using USB or bluetooth, NVDA will automatically connect with this display.

No braille means that you are not using braille.

Please see the Supported Braille Displays section for more information about supported braille displays and which of these support automatic detection in the background.

Displays to detect automatically

When braille display is set to "Automatic", the check boxes in this list control allows you to enable and disable display drivers that will be involved in the automatic detection process. This allows you to exclude braille display drivers you do not use on a regular basis. For example, if you only own a display that requires the Baum driver to function, you may leave the Baum driver enabled whereas the other drivers can be disabled.

By default, all drivers that support automatic detection are enabled. Any driver added, for example in a future version of NVDA or in an add-on, will also be enabled by default.

You may consult the documentation for your braille display in the section Supported Braille Displays to check whether the driver supports automatic detection of displays.

Port

This option, if available, allows you to choose what port or type of connection will be used to communicate with the braille display you have selected. It is a combo box containing the possible choices for your braille display.

By default, NVDA employs automatic port detection, which means the connection with the braille device will be established automatically by scanning for available USB and bluetooth devices on your system. However, for some braille displays, you may be able to explicitly choose what port should be used. Common options are "Automatic" (which tells NVDA to employ the default automatic port selection procedure), "USB", "Bluetooth" and legacy serial communication ports if your braille display supports this type of communication.

This option won't be available if your braille display only supports automatic port detection.

You may consult the documentation for your braille display in the section Supported Braille Displays to check for more details on the supported types of communication and available ports.

Please note: If you connect multiple Braille Displays to your machine at the same time which use the same driver (E.g. connecting two Seika displays), it is currently impossible to tell NVDA which display to use. Therefore it is recommended to only connect one Braille Display of a given type / manufacturer to your machine at a time.

Audio

Open Audio settings

Key: NVDA+control+u

The Audio category in the NVDA Settings dialog contains options that let you change several aspects of audio output.

Output device

This option allows you to choose the audio device that NVDA should instruct the selected synthesizer to speak through.

Audio Ducking Mode

Key: NVDA+shift+d

This option allows you to choose if NVDA should lower the volume of other applications while NVDA is speaking, or all the time while NVDA is running.

• No Ducking: NVDA will never lower the volume of other audio.
• Duck when outputting speech and sounds: NVDA will only lower the volume of other audio when NVDA is speaking or playing sounds. This may not work for all synthesizers.
• Always duck: NVDA will keep the volume of other audio lower the whole time NVDA is running.

This option is only available if NVDA has been installed. It is not possible to support audio ducking for portable and temporary copies of NVDA.

Volume of NVDA sounds follows voice volume

When this option is enabled, the volume of NVDA sounds and beeps will follow the volume setting of the voice you are using. If you decrease the volume of the voice, the volume of sounds will decrease. Similarly, if you increase the volume of the voice, the volume of sounds will increase. This option is not available if you have started NVDA with WASAPI disabled for audio output in Advanced Settings.

Volume of NVDA sounds

This slider allows you to set the volume of NVDA sounds and beeps. This setting only takes effect when "Volume of NVDA sounds follows voice volume" is disabled. This option is not available if you have started NVDA with WASAPI disabled for audio output in Advanced Settings.

Vision

The Vision category in the NVDA Settings dialog allows you to enable, disable and configure visual aids.

Note that the available options in this category could be extended by NVDA add-ons. By default, this settings category contains the following options:

Visual Highlight

The check boxes in the Visual Highlight grouping control the behaviour of NVDA's built-in Visual Highlight facility.

• Enable Highlighting: Toggles Visual Highlight on and off.
• Highlight system focus: toggles whether the system focus will be highlighted.
• Highlight navigator object: toggles whether the navigator object will be highlighted.
• Highlight browse mode cursor: Toggles whether the virtual browse mode cursor will be highlighted.

Note that checking and unchecking the "Enable Highlighting" check box wil also change the state of the tree other check boxes accordingly. Therefore, if "Enable Highlighting" is off and you check this check box, the other tree check boxes will also be checked automatically. If you only want to highlight the focus and leave the navigator object and browse mode check boxes unchecked, the state of the "Enable Highlighting" check box will be half checked.

Screen Curtain

You can enable the Screen Curtain by checking the "Make screen black (immediate effect)" check box. A warning that your screen will become black after activation will be displayed. Before continuing (selecting "Yes"), ensure you have enabled speech / braille and will be able to control your computer without the use of the screen. Select "No" if you no longer wish to enable the Screen Curtain. If you are sure, you can choose the Yes button to enable the screen curtain. If you no longer want to see this warning message every time, you can change this behaviour in the dialog that displays the message. You can always restore the warning by checking the "Always show a warning when loading Screen Curtain" check box next to the "Make screen black" check box.

By default, sounds are played when the Screen Curtain is toggled. When you want to change this behaviour, you can uncheck the "Play sound when toggling Screen Curtain" check box.

Settings for third party visual aids

Additional vision enhancement providers can be provided in NVDA add-ons. When these providers have adjustable settings, they will be shown in this settings category in separate groupings. For the supported settings per provider, please refer to the documentation for that provider.

Keyboard

Open Keyboard settings

Key: NVDA+control+k

The Keyboard category in the NVDA Settings dialog contains options that set how NVDA behaves as you use and type on your keyboard. This settings category contains the following options:

Keyboard layout

This combo box lets you choose what type of keyboard layout NVDA should use. Currently the two that come with NVDA are Desktop and Laptop.

Select NVDA Modifier Keys

The checkboxes in this list control what keys can be used as NVDA modifier keys. The following keys are available to choose from:

• The Caps Lock key
• The insert key on the number pad
• The extended insert key (usually found above the arrow keys, near home and end)

If no key is chosen as the NVDA key it may be impossible to access many NVDA commands, therefore you are required to check at least one of the modifiers.

Speak Typed Characters

Key: NVDA+2

When enabled, NVDA will announce all characters you type on the keyboard.

Speak Typed Words

Key: NVDA+3

When enabled, NVDA will announce all words you type on the keyboard.

Speech interrupt for typed characters

If on, this option will cause speech to be interrupted each time a character is typed. This is on by default.

Speech interrupt for Enter key

If on, this option will cause speech to be interrupted each time the Enter key is pressed. This is on by default.

Allow skim reading in Say All

If on, certain navigation commands (such as quick navigation in browse mode or moving by line or paragraph) do not stop Say All, rather Say All jumps to the new position and continues reading.

Beep if Typing Lowercase Letters when Caps Lock is On

When enabled, a warning beep will be heard if a letter is typed with the shift key while Caps Lock is on. Generally, typing shifted letters with Caps Lock is unintentional and is usually due to not realizing that Caps Lock is enabled. Therefore, it can be quite helpful to be warned about this.

Speak Command Keys

Key: NVDA+4

When enabled, NVDA will announce all non-character keys you type on the keyboard. This includes key combinations such as control plus another letter.

Play sound for spelling errors while typing

When enabled, a short buzzer sound will be played when a word you type contains a spelling error. This option is only available if reporting of spelling errors is enabled in NVDA's Document Formatting Settings, found in the NVDA Settings dialog.

Handle keys from other applications

This option allows the user to control if key presses generated by applications such as on-screen keyboards and speech recognition software should be processed by NVDA. This option is on by default, though certain users may wish to turn this off, such as those typing Vietnamese with the UniKey typing software as it will cause incorrect character input.

Mouse

Open Mouse settings

Key: NVDA+control+m

The Mouse category in the NVDA Settings dialog allows NVDA to track the mouse, play mouse coordinate beeps and sets other mouse usage options. This category contains the following options:

Report Mouse Shape Changes

A checkbox, that when checked means that NVDA will announce the shape of the mouse pointer each time it changes. The mouse pointer in Windows changes shape to convey certain information such as when something is editable, or when something is loading etc.

Enable mouse tracking

Key: NVDA+m

When enabled, NVDA will announce the text currently under the mouse pointer, as you move it around the screen. This allows you to find things on the screen, by physically moving the mouse, rather than trying to find them through object navigation.

Text unit resolution

If NVDA is set to announce the text under the mouse as you move it, this option allows you to choose exactly how much text will be spoken. The options are character, word, line and paragraph.

To toggle text unit resolution from anywhere, please assign a custom gesture using the Input Gestures dialog.

Report object when mouse enters it

If this checkbox is checked, NVDA will announce information about objects as the mouse moves inside them. This includes the role (type) of the object as well as states (checked/pressed), cell coordinates in tables, etc. Note that the announcement of some object details might be dependent on how other settings are set, such as in the object presentation or Document Formatting categories.

Play audio coordinates when mouse moves

Checking this checkbox makes NVDA play beeps as the mouse moves, so that the user can work out where the mouse is in regards to the dimensions of the screen. The higher the mouse is on the screen, the higher the pitch of the beeps. The further left or right the mouse is located on the screen, the further left or right the sound will be played (assuming the user has stereo speakers or headphones).

Brightness controls audio coordinates volume

If the "play audio coordinates when mouse moves" checkbox is checked, then checking this checkbox means that the volume of the audio coordinates beeps is controlled by how bright the screen is under the mouse. This setting is unchecked by default.

Ignore mouse input from other applications

This option allows the user to ignore mouse events (including mouse movement and button presses) generated by other applications such as TeamViewer and other remote control software. This option is unchecked by default. If you check this option and you have the "Enable mouse tracking" option enabled, NVDA will not announce what is under the mouse if the mouse is moved by another application.

Touch Interaction

This settings category, only available on computers with touch capabilities, allows you to configure how NVDA interacts with touchscreens. This category contains the following options:

Enable touch interaction support

This checkbox enables NVDA's touch interaction support. If enabled, you can use your fingers to navigate and interact with items on screen using a touchscreen device. If disabled, touchscreen support will be disabled as though NVDA is not running. This setting can also be toggled using NVDA+control+alt+t.

Touch typing mode

This checkbox allows you to specify the method you wish to use when entering text using the touch keyboard. If this checkbox is checked, when you locate a key on the touch keyboard, you can lift your finger and the selected key will be pressed. If this is unchecked, you need to double-tap on the key of the touch keyboard to press the key.

Review Cursor

The Review Cursor category in the NVDA Settings dialog is used to configure NVDA's review cursor behaviour. This category contains the following options:

Follow System Focus

Key: NVDA+7

When enabled, The review cursor will always be placed in the same object as the current system focus whenever the focus changes.

Follow System Caret

Key: NVDA+6

When enabled, the review cursor will automatically be moved to the position of the System caret each time it moves.

Follow mouse cursor

When enabled, the review cursor will follow the mouse as it moves.

Simple Review mode

When enabled, NVDA will filter the hierarchy of objects that can be navigated to exclude objects that aren't of interest to the user; e.g. invisible objects and objects used only for layout purposes.

To toggle simple review mode from anywhere, please assign a custom gesture using the Input Gestures dialog.

Object Presentation

Open Object Presentation settings

Key: NVDA+control+o

The Object Presentation category in the NVDA Settings dialog is used to set how much information NVDA will present about controls such as description, position information and so on. These options don't typically apply to browse mode. These options typically apply to focus reporting and NVDA object navigation, but not reading text content e.g. browse mode.

Report tooltips

A checkbox that when checked tells NVDA to report tooltips as they appear. Many Windows and controls show a small message (or tooltip) when you move the mouse pointer over them, or sometimes when you move the focus to them.

Report notifications

This checkbox, when checked, tells NVDA to report help balloons and toast notifications as they appear.

• Help Balloons are like tooltips, but are usually larger in size, and are associated with system events such as a network cable being unplugged, or perhaps to alert you about Windows security issues.
• Toast notifications have been introduced in Windows 10 and appear in the notification centre in the system tray, informing about several events (i.e. if an update has been downloaded, a new e-mail arrived in your inbox, etc.).

Report Object Shortcut Keys

When this checkbox is checked, NVDA will include the shortcut key that is associated with a certain object or control when it is reported. For example the File menu on a menu bar may have a shortcut key of alt+f.

Report object position information

This option lets you choose whether you wish to have an object's position (e.g. 1 of 4) reported when moving to the object with the focus or object navigation.

Guess Object Position Information when unavailable

If reporting of object position information is turned on, this option allows NVDA to guess object position information when it is otherwise unavailable for a particular control.

When on, NVDA will report position information for more controls such as menus and toolbars, however this information may be slightly inaccurate.

Report Object descriptions

Uncheck this checkbox if you don't wish to have the description reported along with objects (i.e. search suggestions, reporting of whole dialog window right after the dialog opens, etc.).

Progress bar output

Key: NVDA+u

This option controls how NVDA reports progress bar updates to you.

It has the following options:

• Off: Progress bars will not be reported as they change.
• Speak: This option tells NVDA to speak the progress bar in percentages. Each time the progress bar changes, NVDA will speak the new value.
• Beep: This tells NVDA to beep each time the progress bar changes. The higher the beep, the closer the progress bar is to completion.
• Beep and speak: This option tells NVDA to both beep and speak when a progress bar updates.

Report background progress bars

This is an option that, when checked, tells NVDA to keep reporting a progress bar, even if it is not physically in the foreground. If you minimize or switch away from a window that contains a progress bar, NVDA will keep track of it, allowing you to do other things while NVDA tracks the progress bar.

Report dynamic content changes

Key: NVDA+5

Toggles the announcement of new content in particular objects such as terminals and the history control in chat programs.

Play a sound when auto-suggestions appear

Toggles announcement of appearance of auto-suggestions, and if enabled, NVDA will play a sound to indicate this. Auto-suggestions are lists of suggested entries based on text entered into certain edit fields and documents. For example, when you enter text into the search box in Start menu in Windows Vista and later, Windows displays a list of suggestions based on what you typed. For some edit fields such as search fields in various Windows 10 apps, NVDA can notify you that a list of suggestions has appeared when you type text. The auto-suggestions list will close once you move away from the edit field, and for some fields, NVDA can notify you of this when this happens.

Input Composition

The Input Composition category allows you to control how NVDA reports the input of Asian characters, such as with IME or Text Service input methods. Note that due to the fact that input methods vary greatly by available features and by how they convey information, it will most likely be necessary to configure these options differently for each input method to get the most efficient typing experience.

Automatically report all available candidates

This option, which is on by default, allows you to choose whether or not all visible candidates should be reported automatically when a candidate list appears or its page is changed. Having this option on for pictographic input methods such as Chinese New ChangJie or Boshiami is useful, as you can automatically hear all symbols and their numbers and you can choose one right away. However, for phonetic input methods such as Chinese New Phonetic, it may be more useful to turn this option off, as all the symbols will sound the same and you will have to use the arrow keys to navigate the list items individually to gain more information from the character descriptions for each candidate.

Announce Selected Candidate

This option, which is on by default, allows you to choose whether NVDA should announce the selected candidate when a candidate list appears or when the selection is changed. For input methods where the selection can be changed with the arrow keys (such as Chinese New Phonetic) this is necessary, but for some input methods it may be more efficient typing with this option turned off. Note that even with this option off, the review cursor will still be placed on the selected candidate allowing you to use object navigation / review to manually read this or other candidates.

Always include short character descriptions for candidates

This option, which is on by default, allows you to choose whether or not NVDA should provide a short description for each character in a candidate, either when it's selected or when it's automatically read when the candidate list appears. Note that for locales such as Chinese, the announcement of extra character descriptions for the selected candidate is not affected by this option. This option may be useful for Korean and Japanese input methods.

Report changes to the reading string

Some input methods such as Chinese New Phonetic and New ChangJie have a reading string (sometimes known as a precomposition string). You can choose whether or not NVDA should announce new characters being typed into this reading string with this option. This option is on by default. Note some older input methods such as Chinese ChangJie may not use the reading string to hold precomposition characters, but instead use the composition string directly. Please see the next option for configuring reporting of the composition string.

Report changes to the composition string

After reading or precomposition data has been combined into a valid pictographic symbol, most input methods place this symbol into a composition string for temporary storage along with other combined symbols before they are finally inserted into the document. This option allows you to choose whether or not NVDA should report new symbols as they appear in the composition string. This option is on by default.

Browse Mode

Open Browse Mode settings

Key: NVDA+control+b

The Browse Mode category in the NVDA Settings dialog is used to configure NVDA's behaviour when you read and navigate complex documents such as web pages. This category contains the following options:

Maximum Number of Characters on One Line

This field sets the maximum length of a line in browse mode (in characters).

Maximum Lines Per Page

This field sets the amount of lines you will move by when pressing page up or page down while in browse mode.

Use screen layout

Key: NVDA+v

This option allows you to specify whether browse mode should place clickable content (links, buttons and fields) on its own line, or if it should keep it in the flow of text as it is visually shown. Note that this option doesn't apply to Microsoft Office apps such as Outlook and Word, which always use screen layout. When screen layout is enabled, page elements will stay as they are visually shown. For example, a visual line of multiple links will be presented in speech and braille as multiple links on the same line. If it is disabled, then page elements will be placed on their own lines. This may be easier to understand during line by line page navigation and make items easier to interact with for some users.

Enable browse mode on page load

This checkbox toggles whether browse mode should be automatically enabled when loading a page. When this option is disabled, browse mode can still be manually activated on pages or in documents where browse mode is supported. See the Browse Mode section for a list of applications supported by browse mode. Note that this option does not apply to situations where browse mode is always optional, e.g. in Microsoft Word. This option is enabled by default.

Automatic Say All on page load

This checkbox toggles the automatic reading of a page after it loads in browse mode. This option is enabled by default.

Include layout tables

This option affects how NVDA handles tables used purely for layout purposes. When on, NVDA will treat these as normal tables, reporting them based on Document Formatting Settings and locating them with quick navigation commands. When off, they will not be reported nor found with quick navigation. However, the content of the tables will still be included as normal text. This option is turned off by default.

To toggle inclusion of layout tables from anywhere, please assign a custom gesture using the Input Gestures dialog.

Configuring reporting of fields such as links and headings

Please see the options in the Document Formatting category of the NVDA Settings dialog to configure the fields that are reported when navigating, such as links, headings and tables.

Automatic focus mode for focus changes

This option allows focus mode to be invoked if focus changes. For example, when on a web page, if you press tab and you land on a form, if this option is checked, focus mode will automatically be invoked.

Automatic focus mode for caret movement

This option, when checked, allows NVDA to enter and leave focus mode when using arrow keys. For example, if arrowing down a web page and you land on an edit box, NVDA will automatically bring you into focus mode. If you arrow out of the edit box, NVDA will put you back in browse mode.

Audio indication of Focus and Browse modes

If this option is enabled, NVDA will play special sounds when it switches between browse mode and focus mode, rather than speaking the change.

Trap non-command gestures from reaching the document

Enabled by default, this option allows you to choose if gestures (such as key presses) that do not result in an NVDA command and are not considered to be a command key in general, should be trapped from going through to the document you are currently focused on. As an example, if enabled and the letter j was pressed, it would be trapped from reaching the document, even though it is not a quick navigation command nor is it likely to be a command in the application itself. In this case NVDA will tell Windows to play a default sound whenever a key which gets trapped is pressed.

Automatically set system focus to focusable elements

Key: NVDA+8

Disabled by default, this option allows you to choose if the system focus should automatically be set to elements that can take the system focus (links, form fields, etc.) when navigating content with the browse mode caret. Leaving this option disabled will not automatically focus focusable elements when they are selected with the browse mode caret. This might result in faster browsing experience and better responsiveness in browse mode. The focus will yet be updated to the particular element when interacting with it (e.g. pressing a button, checking a check box). Enabling this option may improve support for some websites at the cost of performance and stability.

Document Formatting

Open Document Formatting settings

Key: NVDA+control+d

Most of the options in this category are for configuring what type of formatting you wish to have reported as you move the cursor around documents. For example, if you check the report font name checkbox, each time you arrow onto text with a different font, the name of the font will be announced.

The document formatting options are organized into groups. You can configure reporting of:

• Font
  • Font name
  • Font size
  • Font attributes
  • Superscripts and subscripts
  • Emphasis
  • Highlighted (Marked) text
  • Style
  • Colours
• Document information
  • Comments
  • Bookmarks
  • Editor revisions
  • Spelling errors
• Pages and spacing
  • Page numbers
  • Line numbers
  • Line indentation reporting (Off, Speech, Tones, Both Speech and Tones)
  • Ignore blank lines for line indentation reporting
  • Paragraph indentation (e.g. hanging indent, first line indent)
  • Line spacing (single, double, etc.)
  • Alignment
• Table information
  • Tables
  • Row/column headers (Off, Rows, Columns, Rows and columns)
  • Cell coordinates
  • Cell borders (Off, Styles, Both Colours and Styles)
• Elements
  • Headings
  • Links
  • Graphics
  • Lists
  • Block quotes
  • Groupings
  • Landmarks
  • Articles
  • Frames
  • Clickable

To toggle these settings from anywhere, please assign custom gestures using the Input Gestures dialog.

Report formatting changes after the cursor

If enabled, this setting tells NVDA to try and detect all the formatting changes on a line as it reports it, even if doing this may slow down NVDA's performance.

By default, NVDA will detect the formatting at the position of the System caret / Review Cursor, and in some instances may detect formatting on the rest of the line, only if it is not going to cause a performance decrease.

Enable this option while proof reading documents in applications such as WordPad, where formatting is important.

Line indentation reporting

This option allows you to configure how indentation at the beginning of lines is reported. The Report line indentation with combo box has four options.

• Off: NVDA will not treat indentation specially.
• Speech: If speech is selected, when the amount of indentation changes, NVDA will say something like "twelve space" or "four tab."
• Tones: If Tones is selected, when the amount of indentation changes, tones indicate the amount of change in indent. The tone will increase in pitch every space, and for a tab, it will increase in pitch the equivalent of 4 spaces.
• Both Speech and Tones: This option reads indentation using both of the above methods.

If you tick the "Ignore blank lines for line indentation reporting" checkbox, then indentation changes won't be reported for blank lines. This may be useful when reading a document where blank lines are used to separate indented bloks of text, such as in programming source code.

Document Navigation

This category allows you to adjust various aspects of document navigation.

Paragraph Style

This combo box allows you to select the paragraph style to be used when navigating by paragraphs with control+upArrow and control+downArrow. The available paragraph styles are:

• Handled by application: NVDA will let the application determine the previous or next paragraph, and NVDA will read the new paragraph when navigating. This style works best when the application supports paragraph navigation natively, and is the default.
• Single line break: NVDA will attempt to determine the previous or next paragraph using a single line break as the paragraph indicator. This style works best when reading documents in an application which does not natively support paragraph navigation, and paragraphs in the document are marked by a single press of the enter key.
• Multi line break: NVDA will attempt to determine the previous or next paragraph using at least one blank line (two presses of the enter key) as the paragraph indicator. This style works best when working with documents which use block paragraphs. Note that this paragraph style cannot be used in Microsoft Word or Microsoft Outlook, unless you are using UIA to access Microsoft Word controls.

You may toggle through the available paragraph styles from anywhere by assigning a key in the Input Gestures dialog.

Windows OCR Settings

The settings in this category allow you to configure Windows OCR. This category contains the following options:

Recognition language

This combo box allows you to choose the language to be used for text recognition. To cycle through available languages from anywhere, please assign a custom gesture using the Input Gestures dialog.

Periodically refresh recognized content

When this checkbox is enabled, NVDA will automatically refresh the recognized content when a recognition result has focus. This can be very useful when you want to monitor constantly changing content, such as when watching a video with subtitles. The refresh takes place every one and a half seconds. This option is disabled by default.

Advanced Settings

Warning! The settings in this category are for advanced users and may cause NVDA to not function correctly if configured in the wrong way. Only make changes to these settings if you are sure you know what you are doing or if you have been specifically instructed to by an NVDA developer.

Making changes to advanced settings

In order to make changes to the advanced settings, the controls must be enabled by confirming, with the checkbox, that you understand the risks of modifying these settings

Restoring the default settings

The button restores the default values for the settings, even if the confirmation checkbox is not ticked. After changing settings you may wish to revert to the default values. This may also be the case if you are unsure if the settings have been changed.

Enable loading custom code from Developer Scratchpad Directory

When developing add-ons for NVDA, it is useful to be able to test code as you are writing it. This option when enabled, allows NVDA to load custom appModules, globalPlugins, brailleDisplayDrivers, synthDrivers and vision enhancement providers, from a special developer scratchpad directory in your NVDA user configuration directory. As their equivalents in add-ons, these modules are loaded when starting NVDA or, in the case of appModules and globalPlugins, when reloading plugins. This option is off by default, ensuring that no untested code is ever run in NVDA with out the user's explicit knowledge. If you wish to distribute custom code to others, you should package it as an NVDA add-on.

Open Developer Scratchpad Directory

This button opens the directory where you can place custom code while developing it. This button is only enabled if NVDA is configured to enable loading custom code from the Developer Scratchpad Directory.

Registration for UI Automation events and property changes

This option changes how NVDA registers for events fired by the Microsoft UI Automation accessibility API. The registration for UI Automation events and property changes combo box has three options:

• Automatic: "selective" on Windows 11 Sun Valley 2 (version 22H2) and later, "global" otherwise.
• Selective: NVDA will limit event registration to the system focus for most events. If you suffer from performance issues in one or more applications, We recommend you to try this functionality to see whether performance improves. However, on older versions of Windows, NVDA may have trouble tracking focus in some controls (such as the task manager and emoji panel).
• Global: NVDA registers for many UIA events that are processed and discarded within NVDA itself. While focus tracking is more reliable in more situations, performance is significantly degraded, especially in applications like Microsoft Visual Studio.

Use UI automation to access Microsoft Word document controls

Configures whether or not NVDA should use the UI Automation accessibility API to access Microsoft Word documents, rather than the older Microsoft Word object model. This applies to documents in Microsoft word itself, plus messages in Microsoft Outlook. This setting contains the following values:

• Default (where suitable)
• Only where necessary: where the Microsoft Word object model is not available at all
• Where suitable: Microsoft Word version 16.0.15000 or higher, or where the Microsoft Word object model is unavailable
• Always: where ever UI automation is available in Microsoft word (no matter how complete).

Use UI automation to access Microsoft Excel spreadsheet controls when available

When this option is enabled, NVDA will try to use the Microsoft UI Automation accessibility API in order to fetch information from Microsoft Excel Spreadsheet controls. This is an experimental feature, and some features of Microsoft Excel may not be available in this mode. For instance, NVDA's Elements List for listing formulas and comments, and Browse mode quick navigation to jump to form fields on a spreadsheet features are not available. However, for basic spreadsheet navigating / editing, this option may provide a vast performance improvement. We still do not recommend that the majority of users turn this on by default, though we do welcome users of Microsoft Excel build 16.0.13522.10000 or higher to test this feature and provide feedback. Microsoft Excel's UI automation implementation is ever changing, and versions of Microsoft Office older than 16.0.13522.10000 may not expose enough information for this option to be of any use.

Use enhanced event processing

When this option is enabled, NVDA should remain responsive when being flooded with many UI Automation events, e.g. large amounts of text in a terminal. After changing this option, you will need to restart NVDA for the change to take effect.

Windows Console support

This option selects how NVDA interacts with the Windows Console used by command prompt, PowerShell, and the Windows Subsystem for Linux. It does not affect the modern Windows Terminal. In Windows 10 version 1709, Microsoft added support for its UI Automation API to the console, bringing vastly improved performance and stability for screen readers that support it. In situations where UI Automation is unavailable or known to result in an inferior user experience, NVDA's legacy console support is available as a fallback. The Windows Console support combo box has three options:

• Automatic: Uses UI Automation in the version of Windows Console included with Windows 11 version 22H2 and later. This option is recommended and set by default.
• UIA when available: Uses UI Automation in consoles if available, even for versions with incomplete or buggy implementations. While this limited functionality may be useful (and even sufficient for your usage), use of this option is entirely at your own risk and no support for it will be provided.
• Legacy: UI Automation in the Windows Console will be completely disabled. The legacy fallback will always be used even in situations where UI Automation would provide a superior user experience. Therefore, selecting this option is not recommended unless you know what you are doing.

Use UIA with Microsoft Edge and other Chromium based browsers when available

Allows specifying when UIA will be used when it is available in Chromium based browsers such as Microsoft Edge. UIA support for Chromium based browsers is early in development and may not provide the same level of access as IA2. The combo box has the following options:

• Default (Only when necessary): The NVDA default, currently this is "Only when necessary". This default may change in the future as the technology matures.
• Only when necessary: When NVDA is unable to inject into the browser process in order to use IA2 and UIA is available, then NVDA will fall back to using UIA.
• Yes: If the browser makes UIA available, NVDA will use it.
• No: Don't use UIA, even if NVDA is unable to inject in process. This may be useful for developers debugging issues with IA2 and want to ensure that NVDA does not fall back to UIA.

Annotations

This group of options is used to enable features which add experimental support for ARIA annotations. Some of these features may be incomplete.

To "Report summary of any annotation details at the system caret", press NVDA+d.

The following options exist:

• "Report 'has details' for structured annotations": enables reporting if the text or control has further details.
• "Report aria-description always": When the source of accDescription is aria-description, the description is reported. This is useful for annotations on the web. Note:
  • There are many sources for accDescription several have mixed or unreliable semantics. Historically AT has not been able to differentiate sources of accDescription typically it wasn't spoken due to the mixed semantics.
  • This option is in very early development, it relies on browser features not yet widely available.
  • Expected to work with Chromium 92.0.4479.0+

Report live regions

This option selects whether NVDA reports changes in some dynamic web content in Braille. Disabling this option is equivalent to NVDA's behaviour in versions 2023.1 and earlier, which only reported these content changes in speech.

Speak passwords in all enhanced terminals

This setting controls whether characters are spoken by speak typed characters or speak typed words in situations where the screen does not update (such as password entry) in some terminal programs, such as the Windows Console with UI automation support enabled and Mintty. For security purposes, this setting should be left disabled. However, you may wish to enable it if you experience performance issues or instability with typed character and/or word reporting in consoles, or work in trusted environments and prefer password announcement.

Use enhanced typed character support in legacy Windows Console when available

This option enables an alternative method for detecting typed characters in legacy Windows consoles. While it improves performance and prevents some console output from being spelled out, it may be incompatible with some terminal programs. This feature is available and enabled by default on Windows 10 versions 1607 and later when UI Automation is unavailable or disabled. Warning: with this option enabled, typed characters that do not appear onscreen, such as passwords, will not be suppressed. In untrusted environments, you may temporarily disable speak typed characters and speak typed words when entering passwords.

Diff algorithm

This setting controls how NVDA determines the new text to speak in terminals. The diff algorithm combo box has three options:

• Automatic: This option causes NVDA to prefer Diff Match Patch in most situations, but fall back to Difflib in problematic applications, such as older versions of the Windows Console and Mintty.
• Diff Match Patch: This option causes NVDA to calculate changes to terminal text by character, even in situations where it is not recommended. It may improve performance when large volumes of text are written to the console and allow more accurate reporting of changes made in the middle of lines. However, in some applications, reading of new text may be choppy or inconsistent.
• Difflib: this option causes NVDA to calculate changes to terminal text by line, even in situations where it is not recommended. It is identical to NVDA's behaviour in versions 2020.4 and earlier. This setting may stabilize reading of incoming text in some applications. However, in terminals, when inserting or deleting a character in the middle of a line, the text after the caret will be read out.

Speak new text in Windows Terminal via

This option selects how NVDA determines what text is "new" (and thus what to speak when "report dynamic content changes" is enabled) in Windows Terminal and the WPF Windows Terminal control used in Visual Studio 2022. It does not affect the Windows Console (conhost.exe). The Speak new text in Windows Terminal combo box has three options:

• Default: This option is currently equivalent to "diffing", but it is anticipated to change once support for UIA notifications is further developed.
• Diffing: This option uses the selected diff algorithm to calculate changes each time the terminal renders new text. This is identical to NVDA's behaviour in versions 2022.4 and earlier.
• UIA notifications: This option defers the responsibility of determining what text to speak to Windows Terminal itself, meanning that NVDA no longer has to determine what text currently on-screen is "new". This should markedly improve performance and stability of Windows Terminal, but this feature is not yet complete. In particular, typed characters that are not displayed on-screen, such as passwords, are reported when this option is selected. Additionally, contiguous spans of output of over 1,000 characters may not be reported accurately.

Attempt to cancel speech for expired focus events

This option enables behaviour which attempts to cancel speech for expired focus events. In particular moving quickly through messages in Gmail with Chrome can cause NVDA to speak outdated information. This functionality is enabled by default as of NVDA 2021.1.

Caret move timeout (in MS)

This option allows you to configure the number of milliseconds NVDA will wait for the caret (insertion point) to move in editable text controls. If you find that NVDA seems to be incorrectly tracking the caret E.g. it seems to be always one character behind or is repeating lines, then you may wish to try increasing this value.

Report transparency for colors

This option enables reporting when colors are transparent, useful for addon/appModule developers gathering information to improve user experience with a 3rd party application. Some GDI applications will highlight text with a background color, NVDA (via display model) attempts to report this color. In some situations, the text background may be entirely transparent, with the text layered on some other GUI element. With several historically popular GUI APIs, the text may be rendered with a transparent background, but visually the background color is accurate.

Use WASAPI for audio output

This option enables audio output via the Windows Audio Session API (WASAPI). WASAPI is a more modern audio framework which may improve the responsiveness, performance and stability of NVDA audio output, including both speech and sounds. After changing this option, you will need to restart NVDA for the change to take effect. Disabling WASAPI will disable the following options:

• Volume of NVDA sounds follows voice volume
• Volume of NVDA sounds

Debug logging categories

The checkboxes in this list allow you to enable specific categories of debug messages in NVDA's log. Logging these messages can result in decreased performance and large log files. Only turn one of these on if specifically instructed to by an NVDA developer e.g. when debugging why a braille display driver is not functioning correctly.

Play a sound for logged errors

This option allows you to specify if NVDA will play an error sound in case an error is logged. Choosing Only in test versions (default) makes NVDA play error sounds only if the current NVDA version is a test version (alpha, beta or run from source). Choosing Yes allows to enable error sounds whatever your current NVDA version is.

miscellaneous Settings

Besides the NVDA Settings dialog, The Preferences sub-menu of the NVDA Menu contains several other items which are outlined below.

Speech dictionaries

The speech dictionaries menu (found in the Preferences menu) contains dialogs that allow you to manage the way NVDA pronounces particular words or phrases. There are currently three different types of speech dictionaries. They are:

• Default: rules in this dictionary affect all speech in NVDA.
• Voice: rules in this dictionary affect speech for the synthesizer voice currently being used.
• Temporary: rules in this dictionary affect all speech in NVDA, but only for the current session. These rules are temporary and will be lost if NVDA is restarted.

You need to assign custom gestures using the Input Gestures dialog if you wish to open any of these dictionary dialogs from anywhere.

All dictionary dialogs contain a list of rules which will be used for processing the speech. The dialog also contains Add, Edit, Remove and Remove all buttons.

To add a new rule to the dictionary, press the Add button, and fill in the fields in the dialog box that appears and then press Ok. You will then see your new rule in the list of rules. However, to make sure your rule is actually saved, make sure to press Ok to exit the dictionary dialog completely once you have finished adding/editing rules.

The rules for NVDA's speech dictionaries allow you to change one string of characters into another. For example, you could create a rule which causes NVDA to say the word "frog" instead of "bird" whenever the word "bird" is encountered. In the Add rule dialog, the easiest way to do this is to type the word bird in the Pattern field, and the word frog in the Replacement field. You may also want to type a description of the rule in the Comment field (something like: changes bird to frog).

NVDA's speech dictionaries however are much more powerful than simple word replacement. The Add rule dialog also contains a checkbox to say whether or not you want the rule to be case sensitive (meaning that NVDA should care whether the characters are uppercase or lowercase. NVDA ignores case by default).

Finally, a set of radio buttons allows you to tell NVDA whether your pattern should match anywhere, should only match if it is a complete word or should be treated as a "Regular expression". Setting the pattern to match as a whole word means that the replacement will only be made if the pattern does not occur as part of a larger word. This condition is met if the characters immediately before and after the word are anything other than a letter, a number, or an underscore, or if there are no characters at all. Thus, using the earlier example of replacing the word "bird" with "frog", if you were to make this a whole word replacement, it would not match "birds" or "bluebird".

A regular expression is a pattern containing special symbols that allow you to match on more than one character at a time, or match on just numbers, or just letters, as a few examples. Regular expressions are not covered in this user guide. For an introductory tutorial, please refer to Python's Regular Expression Guide.

Punctuation/symbol pronunciation

This dialog allows you to change the way punctuation and other symbols are pronounced, as well as the symbol level at which they are spoken.

The language for which symbol pronunciation is being edited will be shown in the dialog's title. Note that this dialog respects the "Trust voice's language for processing symbols and characters" option found in the Speech category of the NVDA Settings dialog; i.e. it uses the voice language rather than the NVDA global language setting when this option is enabled.

To change a symbol, first select it in the Symbols list. You can filter the symbols by entering the symbol or a part of the symbol's replacement into the Filter by edit box.

• The Replacement field allows you to change the text that should be spoken in place of this symbol.
• Using the Level field, you can adjust the lowest symbol level at which this symbol should be spoken (none, some, most or all). You can also set the level to character; in this case the symbol will not be spoken regardless of the symbol level in use, with the following two exceptions:
  • When navigating character by character.
  • When NVDA is spelling any text containing that symbol.
• The Send actual symbol to synthesizer field specifies when the symbol itself (in contrast to its replacement) should be sent to the synthesizer. This is useful if the symbol causes the synthesizer to pause or change the inflection of the voice. For example, a comma causes the synthesizer to pause. There are three options:
  • never: Never send the actual symbol to the synthesizer.
  • always: Always send the actual symbol to the synthesizer.
  • only below symbols' level: Send the actual symbol only if the configured speech symbol level is lower than the level set for this symbol. For example, you might use this so that a symbol will have its replacement spoken at higher levels without pausing, while still being indicated with a pause at lower levels.

You can add new symbols by pressing the Add button. In the dialog that appears, enter the symbol and press the OK button. Then, change the fields for the new symbol as you would for other symbols.

You can remove a symbol you previously added by pressing the Remove button.

When you are finished, press the OK button to save your changes or the Cancel button to discard them.

In the case of complex symbols, the Replacement field may have to include some group references of the matched text. For instance, for a pattern matching a whole date, \1, \2, and \3 would need to appear in the field, to be replaced by the corresponding parts of the date. Normal backslashes in the Replacement field should thus be doubled, e.g. "a\b" should be typed in order to get the "a\b" replacement.

Input Gestures

In this dialog, you can customize the input gestures (keys on the keyboard, buttons on a braille display, etc.) for NVDA commands.

Only commands that are applicable immediately before the dialog is opened are shown. For example, if you want to customize commands related to browse mode, you should open the Input Gestures dialog while you are in browse mode.

The tree in this dialog lists all of the applicable NVDA commands grouped by category. You can filter them by entering one or more words from the command's name into the Filter by edit box in any order. Any gestures associated with a command are listed beneath the command.

To add an input gesture to a command, select the command and press the Add button. Then, perform the input gesture you wish to associate; e.g. press a key on the keyboard or a button on a braille display. Often, a gesture can be interpreted in more than one way. For example, if you pressed a key on the keyboard, you may wish it to be specific to the current keyboard layout (e.g. desktop or laptop) or you may wish it to apply for all layouts. In this case, a menu will appear allowing you to select the desired option.

To remove a gesture from a command, select the gesture and press the Remove button.

The Emulated system keyboard keys category contains NVDA commands that emulate keys on the system keyboard. These emulated system keyboard keys can be used to control a system keyboard right from your braille display. To add an emulated input gesture, select the Emulated system keyboard keys category and press the Add button. Then, press the key on the keyboard you wish to emulate. After that, the key will be available from the Emulated system keyboard keys category and you will be able to assign an input gesture to it as described above.

Note:

• Emulated keys must have gestures assigned in order to persist when saving / closing the dialog.
• An input gesture with modifier keys may not be able to be mapped to an emulated gesture without modifier keys. For instance, setting the emulated input a and configuring an input gesture of ctrl+m, may result in the application receiving ctrl+a.

When you are finished making changes, press the OK button to save them or the Cancel button to discard them.

Saving and Reloading the configuration

By default NVDA will automatically save your settings on exit. Note, however, that this option can be changed under the general options in the preferences menu. To save the settings manually at any time, choose the Save configuration item in the NVDA menu.

If you ever make a mistake with your settings and need to revert back to the saved settings, choose the "revert to saved configuration" item in the NVDA menu. You can also reset your settings to their original factory defaults by choosing Reset Configuration To Factory Defaults, which is also found in the NVDA menu.

The following NVDA key commands are also useful:

Configuration Profiles

Sometimes, you may wish to have different settings for different situations. For example, you may wish to have reporting of indentation enabled while you are editing or reporting of font attributes enabled while you are proofreading. NVDA allows you to do this using configuration profiles.

A configuration profile contains only those settings which are changed while the profile is being edited. Most settings can be changed in configuration profiles except for those in the General category of the NVDA Settings dialog, which apply to the entirety of NVDA.

Configuration profiles can be manually activated either from a dialog or using custom added gestures. They can also be activated automatically due to triggers such as switching to a particular application.

Basic Management

You manage configuration profiles by selecting "Configuration profiles" in the NVDA menu. You can also do this using a key command:

• NVDA+control+p: Show the Configuration Profiles dialog.

The first control in this dialog is the profile list from which you can select one of the available profiles. When you open the dialog, the profile you are currently editing is selected. Additional information is also shown for active profiles, indicating whether they are manually activated, triggered and/or being edited.

To rename or delete a profile, press the Rename or Delete buttons, respectively.

Press the Close button to close the dialog.

Creating a Profile

To create a profile, press the New button.

In the New Profile dialog, you can enter a name for the profile. You can also select how this profile should be used. If you only want to use this profile manually, select Manual activation, which is the default. Otherwise, select a trigger which should automatically activate this profile. For convenience, if you haven't entered a name for the profile, selecting a trigger will fill in the name accordingly. See below for more information about triggers.

Pressing OK will create the profile and close the Configuration Profiles dialog so you can edit it.

Manual Activation

You can manually activate a profile by selecting a profile and pressing the Manual activate button. Once activated, other profiles can still be activated due to triggers, but any settings in the manually activated profile will override them. For example, if a profile is triggered for the current application and reporting of links is enabled in that profile but disabled it in the manually activated profile, links will not be reported. However, if you have changed the voice in the triggered profile but have never changed it in the manually activated profile, the voice from the triggered profile will be used. Any settings you change will be saved in the manually activated profile. To deactivate a manually activated profile, select it in the Configuration Profiles dialog and press the Manual deactivate button.

Triggers

Pressing the Triggers button in the Configuration Profiles dialog allows you to change the profiles which should be automatically activated for various triggers.

The Triggers list shows the available triggers, which are as follows:

• Current application: Triggered when you switch to the current application.
• Say all: Triggered while reading with the say all command.

To change the profile which should be automatically activated for a trigger, select the trigger and then select the desired profile from the Profile list. You can select "(normal configuration)" if you don't want a profile to be used.

Press the Close button to return to the Configuration Profiles dialog.

Editing a Profile

If you have manually activated a profile, any settings you change will be saved to that profile. Otherwise, any settings you change will be saved to the most recently triggered profile. For example, if you have associated a profile with the Notepad application and you switch to Notepad, any changed settings will be saved to that profile. Finally, if there is neither a manually activated nor a triggered profile, any settings you change will be saved to your normal configuration.

To edit the profile associated with say all, you must manually activate that profile.

Temporarily Disabling Triggers

Sometimes, it is useful to temporarily disable all triggers. For example, you might wish to edit a manually activated profile or your normal configuration without triggered profiles interfering. You can do this by checking the Temporarily disable all triggers checkbox in the Configuration Profiles dialog.

To toggle disabling triggers from anywhere, please assign a custom gesture using the Input Gestures dialog.

Activating a profile using input gestures

For every profile you add, you are able to assign one or more input gestures to activate it. By default, configuration profiles do not have input gestures assigned. You can add gestures to activate a profile using the Input Gestures dialog. Every profile has its own entry under the configuration profiles category. When you rename a profile, any gesture you added previously will still be available. Removing a profile will automatically delete the gestures associated with it.

Location of Configuration files

Portable versions of NVDA store all settings and add-ons in a directory called userConfig, found in the NVDA directory.

Installed versions of NVDA store all settings and add-ons in a special NVDA directory located in your Windows user profile. This means that each user on the system can have their own NVDA settings. To open your settings directory from anywhere you can use Input Gestures dialog to add a custom gesture. In addition for an installed version of NVDA, on the start menu you can go to programs -> NVDA -> explore user configuration directory.

Settings for NVDA when running during sign-in or on UAC screens are stored in the systemConfig directory in NVDA's installation directory. Usually, this configuration should not be touched. To change NVDA's configuration during sign-in or on UAC screens, configure NVDA as you wish while signed into Windows, save the configuration, and then press the "use currently saved settings during sign-in and on secure screens" button in the General category of the NVDA Settings dialog.

Add-ons and the Add-on Store

Add-ons are software packages which provide new or altered functionality for NVDA. They are developed by the NVDA community, and external organisations such as commercial vendors. Add-ons may do any of the following:

• Add or enhance support for certain applications.
• Provide support for extra Braille displays or speech synthesizers.
• Add or change features in NVDA.

NVDA's Add-on Store allows you to browse and manage add-on packages. All add-ons that are available in the Add-on Store can be downloaded for free. However, some of them may require users to pay for a license or additional software before they can be used. Commercial speech synthesizers are an example of this type of add-on. If you install an add-on with paid components and change your mind about using it, the add-on can be easily removed.

The Add-on Store is accessed from the Tools submenu of the NVDA menu. To access the Add-on Store from anywhere, assign a custom gesture using the Input Gestures dialog.

Browsing add-ons

When opened, the Add-on Store displays a list of add-ons. If you have not installed an add-on before, the Add-on Store will open to a list of add-ons available to install. If you have installed add-ons, the list will display currently installed add-ons.

Selecting an add-on, by moving to it with the up and down arrow keys, will display the details for the add-on. Add-ons have associated actions that you can access through an actions menu, such as install, help, disable, and remove. Available actions will change based on whether the add-on is installed or not, and whether it is enabled or disabled.

Add-on list views

There are different views for installed, updatable, available and incompatible add-ons. To change the view of add-ons, change the active tab of the add-ons list using ctrl+tab. You can also tab to the list of views, and move through them with the leftArrow and rightArrow keys.

Filtering for enabled or disabled add-ons

Normally, an installed add-on is "enabled", meaning that it is running and available within NVDA. However, some of your installed add-ons may be set to the "disabled" state. This means that they will not be used, and their functions won't be available during your current NVDA session. You may have disabled an add-on because it conflicted with another add-on, or with a certain application. NVDA may also disable certain add-ons, if they are found to be incompatible during an NVDA upgrade; though you will be warned if this is going to happen. Add-ons can also be disabled if you simply don't need them for a prolonged period, but don't want to uninstall them because you expect to want them again in the future.

The lists of installed and incompatible add-ons can be filtered by their enabled or disabled state. The default shows both enabled and disabled add-ons.

Include incompatible add-ons

Available and updatable add-ons can be filtered to include incompatible add-ons that are available to install.

Filter add-ons by channel

Add-ons can be distributed through up to four channels:

• Stable: The developer has released this as a tested add-on with a released version of NVDA.
• Beta: This add-on may need further testing, but is released for user feedback. Suggested for early adopters.
• Dev: This channel is suggested to be used by add-on developers to test unreleased API changes. NVDA alpha testers may need to use a "Dev" version of their add-ons.
• External: Add-ons installed from external sources, outside of the Add-on Store.

To list add-ons only for specific channels, change the "Channel" filter selection.

Searching for add-ons

To search add-ons, use the "Search" text box. You can reach it by pressing shift+tab from the list of add-ons. Type a keyword or two for the kind of add-on you're looking for, then tab to the list of add-ons. Add-ons will be listed if the search text can be found in the add-on ID, display name, publisher, author or description.

Add-on actions

Add-ons have associated actions, such as install, help, disable, and remove. For an add-on in the add-on list, these actions can be accessed through a menu opened by pressing the applications key, enter, right clicking or double clicking the add-on. This menu can also be accessed through an Actions button in the selected add-on's details.

Installing add-ons

Just because an add-on is available in the NVDA Add-on Store, does not mean that it has been approved or vetted by NV Access or anyone else. It is very important to only install add-ons from sources you trust. The functionality of add-ons is unrestricted inside NVDA. This could include accessing your personal data or even the entire system.

You can install and update add-ons by browsing Available add-ons. Select an add-on from the "Available add-ons" or "Updatable add-ons" tab. Then use the update, install, or replace action to start the installation.

You can also install multiple add-ons at once. This can be done by selecting multiple add-ons in the available add-ons tab, then activating the context menu on the selection and choosing the "Install selected add-ons" action.

To install an add-on you have obtained outside of the Add-on Store, press the "Install from external source" button. This will allow you to browse for an add-on package (.nvda-addon file) somewhere on your computer or on a network. Once you open the add-on package, the installation process will begin.

If NVDA is installed and running on your system, you can also open an add-on file directly from the browser or file system to begin the installation process.

When an add-on is being installed from an external source, NVDA will ask you to confirm the installation. Once the add-on is installed, NVDA must be restarted for the add-on to start running, although you may postpone restarting NVDA if you have other add-ons to install or update.

Removing Add-ons

To remove an add-on, select the add-on from the list and use the Remove action. NVDA will ask you to confirm removal. As with installing, NVDA must be restarted for the add-on to be fully removed. Until you do, a status of "Pending removal" will be shown for that add-on in the list. As with installing, you can also remove multiple add-ons at once.

Disabling and Enabling Add-ons

To disable an add-on, use the "disable" action. To enable a previously disabled add-on, use the "enable" action. You can disable an add-on if the add-on status indicates it is "enabled", or enable it if the add-on is "disabled". For each use of the enable/disable action, add-on status changes to indicate what will happen when NVDA restarts. If the add-on was previously "disabled", the status will show "enabled after restart". If the add-on was previously "enabled", the status will show "disabled after restart". Just like when you install or remove add-ons, you need to restart NVDA in order for changes to take effect. You can also enable or disable multiple add-ons at once by selecting multiple add-ons in the available add-ons tab, then activating the context menu on the selection and choosing the appropriate action.

Reviewing add-ons and reading reviews

Before installing an add-on, you may want to read reviews by others. Also, it may be helpful to other users to provide feedback about add-ons you have tried. To read reviews for an add-on, select an add-on from the Available or Updatable add-ons tab, and use the "Community reviews" action. This links to a GitHub Discussion webpage, where you will be able to read and write reviews for the add-on. Please be aware that this doesn't replace direct communication with add-on developers. Instead, the purpose of this feature is to share feedback to help users decide if an add-on may be useful for them.

Incompatible Add-ons

Some older add-ons may no longer be compatible with the version of NVDA that you have. If you are using an older version of NVDA, some newer add-ons may not be compatible either. Attempting to install an incompatible add-on will result in an error explaining why the add-on is considered incompatible.

For older add-ons, you can override the incompatibility at your own risk. Incompatible add-ons may not work with your version of NVDA, and can cause unstable or unexpected behaviour including crashing. You can override compatibility when enabling or installing an add-on. If the incompatible add-on causes issues later, you can disable or remove it.

If you are having trouble running NVDA, and you have recently updated or installed an add-on, especially if it is an incompatible add-on, you may want to try running NVDA temporarily with all add-ons disabled. To restart NVDA with all add-ons disabled, choose the appropriate option when quitting NVDA. Alternatively, use the command line option --disable-addons.

You can browse available incompatible add-ons using the available and updatable add-ons tabs. You can browse installed incompatible add-ons using the incompatible add-ons tab.

Extra Tools

Log Viewer

The log viewer, found under Tools in the NVDA menu, allows you to view the logging output that has occurred since the latest session of NVDA was started.

Apart from reading the content, you can also Save a copy of the log file, or refresh the viewer so that it loads new log output generated after the Log viewer was opened. These actions are available under the Log menu in the log viewer.

The file which is displayed when you open the log viewer is saved on your computer at the file location %temp%\nvda.log. A new log file is created each time NVDA is started. When this happens, the previous NVDA session's log file is moved to %temp%\nvda-old.log.

You can also copy a fragment of the current log file to the clipboard without opening the log viewer.

Speech Viewer

For sighted software developers or people demoing NVDA to sighted audiences, a floating window is available that allows you to view all the text that NVDA is currently speaking.

To enable the speech viewer, check the "Speech Viewer" menu item under Tools in the NVDA menu. Uncheck the menu item to disable it.

The speech viewer window contains a check box labelled "Show speech viewer on startup". If this is checked, the speech viewer will open when NVDA is started. The speech viewer window will always attempt to re-open with the same dimensions and location as when it was closed.

While the speech viewer is enabled, it constantly updates to show you the most current text being spoken. However, if you hover your mouse over or focus inside the viewer, NVDA will temporarily stop updating the text, so that you are able to easily select or copy the existing content.

To toggle the speech viewer from anywhere, please assign a custom gesture using the Input Gestures dialog.

Braille Viewer

For sighted software developers or people demoing NVDA to sighted audiences, a floating window is available that allows you to view braille output, and the text equivalent for each braille character. The braille viewer can be used at the same time as a physical braille display, it will match the number of cells on the physical device. While the braille viewer is enabled, it constantly updates to show you the braille that would be displayed on a physical braille display.

To enable the braille viewer, check the "Braille Viewer" menu item under Tools in the NVDA menu. Uncheck the menu item to disable it.

Physical braille displays typically have buttons to scroll forwards or backwards, to enable scrolling with the braille viewer tool use the Input Gestures dialog to assign keyboard shortcuts which "Scrolls the braille display back" and "Scrolls the braille display forward"

The braille viewer window contains a check box labelled "Show braille viewer on startup". If this is checked, the braille viewer will open when NVDA is started. The braille viewer window will always attempt to re-open with the same dimensions and location as when it was closed.

The braille viewer window contains a check box labeled "Hover for cell routing", the default is unchecked. If checked, hovering the mouse over a braille cell will enable trigger the "route to braille cell" command for that cell. This is often used to move the caret or trigger the action for a control. This can be useful for testing NVDA is able to correctly reverse map a from braille cell. To prevent unintentionally routing to cells, the command is delayed. The mouse must hover until the cell turns green. The cell will start as a light yellow colour, transition to orange, then suddenly become green.

To toggle the braille viewer from anywhere, please assign a custom gesture using the Input Gestures dialog.

Python Console

The NVDA Python console, found under Tools in the NVDA menu, is a development tool which is useful for debugging, general inspection of NVDA internals or inspection of the accessibility hierarchy of an application. For more information, please see the NVDA Developer Guide.

Add-on Store

This will open the NVDA Add-on Store. For more information, read the in-depth section: Add-ons and the Add-on Store.

Create portable copy

This will open a dialog which allows you to create a portable copy of NVDA out of the installed version. Either way, when running a portable copy of NVDA, in the extra tool sub menu the menu item will be called "install NVDA on this PC" instead of "create portable copy).

The dialog to create a portable copy of NVDA or to install NVDA on this PC will prompt you to choose a folder path in which NVDA should create the portable copy or in which NVDA should be installed.

In this dialog you can enable or disable the following:

• Copy current user configuration (this includes the files in %appdata%\roaming\NVDA or in the user configuration of your portable copy and also includes add-ons and other modules)
• Start the new portable copy after creation or start NVDA after installation (starts NVDA automatically after the portable copy creation or the installation)

Run COM registration fixing tool...

Installing and uninstalling programs on a computer can, in certain cases, cause COM DLL files to get unregistered. As COM Interfaces such as IAccessible depend on correct COM DLL registrations, issues can appear in case the correct registration is missing.

This can happen i.e. after installing and uninstalling Adobe Reader, Math Player and other programs.

The missing registration can cause issues in browsers, desktop apps, task bar and other interfaces.

Specifically, following issues can be solved by running this tool:

• NVDA reports "unknown" when navigating in browsers such as Firefox, Thunderbird etc.
• NVDA fails to switch between focus mode and browse mode
• NVDA is very slow when navigating in browsers while using browse mode
• And possibly other issues.

Reload plugins

This item, once activated, reloads app modules and global plugins without restarting NVDA, which can be useful for developers. App modules manage how NVDA interacts with specific applications. Global plugins manage how NVDA interacts with all applications.

The following NVDA key commands may also be useful:

Supported Speech Synthesizers

This section contains information about the speech synthesizers supported by NVDA. For an even more extensive list of free and commercial synthesizers that you can purchase and download for use with NVDA, please see the extra voices page.

eSpeak NG

The eSpeak NG synthesizer is built directly into NVDA and does not require any other special drivers or components to be installed. On Windows 8.1 NVDA uses eSpeak NG by default (Windows OneCore is used in Windows 10 and later by default). As this synthesizer is built into NVDA, this is a great choice for when running NVDA off a USB thumb drive on other systems.

Each voice that comes with eSpeak NG speaks a different language. There are over 43 different languages supported by eSpeak NG.

There are also many variants which can be chosen to alter the sound of the voice.

Microsoft Speech API version 4 (SAPI 4)

SAPI 4 is an older Microsoft standard for software speech synthesizers. NVDA still supports this for users who already have SAPI 4 synthesizers installed. However, Microsoft no longer support this and needed components are no longer available from Microsoft.

When using this synthesizer with NVDA, the available voices (accessed from the Speech category of the NVDA Settings dialog or by the Synth Settings Ring) will contain all the voices from all the installed SAPI 4 engines found on your system.

Microsoft Speech API version 5 (SAPI 5)

SAPI 5 is a Microsoft standard for software speech synthesizers. Many speech synthesizers that comply with this standard may be purchased or downloaded for free from various companies and websites, though your system will probably already come with at least one SAPI 5 voice preinstalled. When using this synthesizer with NVDA, the available voices (accessed from the Speech category of the NVDA Settings dialog or by the Synth Settings Ring) will contain all the voices from all the installed SAPI 5 engines found on your system.

Microsoft Speech Platform

The Microsoft Speech Platform provides voices for many languages which are normally used in the development of server-based speech applications. These voices can also be used with NVDA.

To use these voices, you will need to install two components:

• Microsoft Speech Platform - Runtime (Version 11), x86
• Microsoft Speech Platform - Runtime Languages (Version 11)
  • This page includes many files for both speech recognition and text-to-speech. Choose the files containing the TTS data for the desired languages/voices. For example, the file MSSpeech_TTS_en-US_ZiraPro.msi is a U.S. English voice.

Windows OneCore Voices

Windows 10 and later includes voices known as "OneCore" or "mobile" voices. Voices are provided for many languages, and they are more responsive than the Microsoft voices available using Microsoft Speech API version 5. On Windows 10 and later, NVDA uses Windows OneCore voices by default (eSpeak NG is used in other releases).

To add new Windows OneCore voices, go to "Speech Settings", within Windows system settings. Use the "Add voices" option and search for the desired language. Many languages include multiple variants. "United Kingdom" and "Australia" are two of the English variants. "France", "Canada" and "Switzerland" are French variants available. Search for the broader language (such as English or French), then locate the variant in the list. Select any languages desired and use the "add" button to add them. Once added, restart NVDA.

Please see Supported languages and voices for a list of available voices.

Supported Braille Displays

This section contains information about the Braille displays supported by NVDA.

Displays supporting automatic detection in the background

NVDA has the ability to detect many braille displays in the background automatically, either via USB or bluetooth. This behaviour is achieved by selecting the Automatic option as the preferred braille display from NVDA's Braille Settings dialog. This option is selected by default.

The following displays support this automatic detection functionality.

• Handy Tech displays
• Baum/Humanware/APH/Orbit braille displays
• HumanWare Brailliant BI/B series
• HumanWare BrailleNote
• SuperBraille
• Optelec ALVA 6 series
• HIMS Braille Sense/Braille EDGE/Smart Beetle/Sync Braille Series
• Eurobraille Esys/Esytime/Iris displays
• Nattiq nBraille displays
• Seika Notetaker: MiniSeika (16, 24 cells), V6, and V6Pro (40 cells)
• Tivomatic Caiku Albatross 46/80 displays
• Any Display that supports the Standard HID Braille protocol

Freedom Scientific Focus/PAC Mate Series

All Focus and PAC Mate displays from Freedom Scientific are supported when connected via USB or bluetooth. You will need the Freedom Scientific braille display drivers installed on your system. If you do not have them already, you can obtain them from the Focus Blue Braille Display Driver page. Although this page only mentions the Focus Blue display, the drivers support all Freedom Scientific Focus and Pacmate displays.

By default, NVDA can automatically detect and connect to these displays either via USB or bluetooth. However, when configuring the display, you can explicitly select "USB" or "Bluetooth" ports to restrict the connection type to be used. This might be useful if you want to connect the focus display to NVDA using bluetooth, but still be able to charge it using USB power from your computer. NVDA's automatic braille display detection will also recognize the display on USB or Bluetooth.

Following are the key assignments for this display with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

For newer Focus models that contain rocker bar keys (focus 40, focus 80 and focus blue):

For Focus 80 only:

Optelec ALVA 6 series/protocol converter

Both the ALVA BC640 and BC680 displays from Optelec are supported when connected via USB or bluetooth. Alternatively, you can connect an older Optelec display, such as a Braille Voyager, using a protocol converter supplied by Optelec. You do not need any specific drivers to be installed to use these displays. Just plug in the display and configure NVDA to use it.

Note: NVDA might be unable to use an ALVA BC6 display over Bluetooth when it is paired using the ALVA Bluetooth utility. When you have paired your device using this utility and NVDA is unable to detect your device, we recommend you to pair your ALVA display the regular way using the Windows Bluetooth settings.

Note: while some of these displays do have a braille keyboard, they handle translation from braille to text themselves by default. This means that NVDA's braille input system is not in use in the default situation (i.e. the input braille table setting has no effect). For ALVA displays with recent firmware, it is possible to disable this HID keyboard simulation using an input gesture.

Following are key assignments for this display with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

Handy Tech Displays

NVDA supports most displays from Handy Tech when connected via USB, serial port or bluetooth. For older USB displays, you will need to install the USB drivers from Handy Tech on your system.

The following displays are not supported out of the box, but can be used via Handy Tech's universal driver and NVDA add-on:

• Braillino
• Bookworm
• Modular displays with firmware version 1.13 or lower. Please note that the firmware of this displays can be updated.

Following are the key assignments for Handy Tech displays with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

MDV Lilli

The Lilli braille display available from MDV is supported. You do not need any specific drivers to be installed to use this display. Just plug in the display and configure NVDA to use it.

This display does not support NVDA's automatic background braille display detection functionality.

Following are the key assignments for this display with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

Baum/Humanware/APH/Orbit Braille Displays

Several Baum, HumanWare, APH and Orbit displays are supported when connected via USB, bluetooth or serial. These include:

• Baum: SuperVario, PocketVario, VarioUltra, Pronto!, SuperVario2, Vario 340
• HumanWare: Brailliant, BrailleConnect, Brailliant2
• APH: Refreshabraille
• Orbit: Orbit Reader 20

Some other displays manufactured by Baum may also work, though this has not been tested.

If connecting via USB to displays which do not use HID, you must first install the USB drivers provided by the manufacturer. The VarioUltra and Pronto! use HID. The Refreshabraille and Orbit Reader 20 can use HID if configured appropriately.

The USB serial mode of the Orbit Reader 20 is currently only supported in Windows 10 and later. USB HID should generally be used instead.

Following are the key assignments for these displays with NVDA. Please see your display's documentation for descriptions of where these keys can be found.

For displays which have a joystick:

hedo ProfiLine USB

The hedo ProfiLine USB from hedo Reha-Technik is supported. You must first install the USB drivers provided by the manufacturer.

This display does not yet support NVDA's automatic background braille display detection functionality.

Following are the key assignments for this display with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

hedo MobilLine USB

The hedo MobilLine USB from hedo Reha-Technik is supported. You must first install the USB drivers provided by the manufacturer.

This display does not yet support NVDA's automatic background braille display detection functionality.

Following are the key assignments for this display with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

HumanWare Brailliant BI/B Series / BrailleNote Touch

The Brailliant BI and B series of displays from HumanWare, including the BI 14, BI 32, BI 20X, BI 40, BI 40X and B 80, are supported when connected via USB or bluetooth. If connecting via USB with the protocol set to HumanWare, you must first install the USB drivers provided by the manufacturer. USB drivers are not required if the protocol is set to OpenBraille.

The following extra devices are also supported (and do not require any special drivers to be installed):

• APH Mantis Q40
• APH Chameleon 20
• Humanware BrailleOne
• NLS eReader

Following are the key assignments for the Brailliant BI/B and BrailleNote touch displays with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

Key assignments for All models

Key assignments for Brailliant BI 32, BI 40 and B 80

Key assignments for Brailliant BI 14

HIMS Braille Sense/Braille EDGE/Smart Beetle/Sync Braille Series

NVDA supports Braille Sense, Braille EDGE, Smart Beetle and Sync Braille displays from Hims when connected via USB or bluetooth. If connecting via USB, you will need to install the USB drivers from HIMS on your system.

Following are the key assignments for these displays with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

Seika Braille Displays

The following Seika Braille displays from Nippon Telesoft are supported in two groups with different functionality:

• Seika Version 3, 4, and 5 (40 cells), Seika80 (80 cells)
• MiniSeika (16, 24 cells), V6, and V6Pro (40 cells)

You can find more information about the displays on their Demo and Driver Download page.

Seika Version 3, 4, and 5 (40 cells), Seika80 (80 cells)

• These displays do not yet support NVDA's automatic background braille display detection functionality.
• Select "Seika Braille Displays" to manually configure
• A device drivers must be installed before using Seika v3/4/5/80. The drivers are provided by the manufacturer.

The Seika Braille Display key assignments follow. Please see the display's documentation for descriptions of where these keys can be found.

MiniSeika (16, 24 cells), V6, and V6Pro (40 cells)

• NVDA's automatic background braille display detection functionality is supported via USB and Bluetooth.
• Select "Seika Notetaker" or "auto" to configure.
• No extra drivers are required when using a Seika Notetaker braille display.

The Seika Notetaker key assignments follow. Please see the display's documentation for descriptions of where these keys can be found.

Papenmeier BRAILLEX Newer Models

The following Braille displays are supported:

• BRAILLEX EL 40c, EL 80c, EL 20c, EL 60c (USB)
• BRAILLEX EL 40s, EL 80s, EL 2d80s, EL 70s, EL 66s (USB)
• BRAILLEX Trio (USB and bluetooth)
• BRAILLEX Live 20, BRAILLEX Live and BRAILLEX Live Plus (USB and bluetooth)

These displays do not support NVDA's automatic background braille display detection functionality. There is an option in the display's USB driver which can cause an issue with loading the display. Please try the following:

1. Please make sure that you have installed the latest driver.
2. Open the Windows Device Manager.
3. Scroll down the list to "USB Controllers" or "USB Devices".
4. Select "Papenmeier Braillex USB Device".
5. Open the properties and switch to the "Advanced" tab. Sometimes the "Advanced" tab doesn't appear. If this is the case, disconnect the braille display from the computer, exit NVDA, wait a moment and reconnect the braille display. Repeat this 4 to 5 times if necessary. If the "Advanced" tab is still not displayed, please restart the computer.
6. Disable the "Load VCP" option.

Most devices have an Easy Access Bar (EAB) that allows intuitive and fast operation. The EAB can be moved in four directions where generally each direction has two switches. The C and Live series are the only exceptions to this rule.

The c-series and some other displays have two routing rows whereby the upper row is used to report formatting information. Holding one of the upper routing keys and pressing the EAB on c-series devices emulates the second switch state. The live series displays have one routing row only and the EAB has one step per direction. The second step may be emulated by pressing one of the routing keys and pressing the EAB in the corresponding direction. Pressing and holding the up, down, right and left keys (or EAB) causes the corresponding action to be repeated.

Generally, the following keys are available on these braille displays:

Following are the Papenmeier command assignments for NVDA:

The Trio model has four additional keys which are in front of the braille keyboard. These are (ordered from left to right):

• left thumb key (lt)
• space
• space
• right thumb key (rt)

Currently, the right thumb key is not in use. The inner keys are both mapped to space.

Papenmeier Braille BRAILLEX Older Models

The following Braille displays are supported:

• BRAILLEX EL 80, EL 2D-80, EL 40 P
• BRAILLEX Tiny, 2D Screen

Note that these displays can only be connected via a serial port. Due to this, these displays do not support NVDA's automatic background braille display detection functionality. You should select the port to which the display is connected after you have chosen this driver in the Select Braille Display dialog.

Some of these devices have an Easy Access Bar (EAB) that allows intuitive and fast operation. The EAB can be moved in four directions where generally each direction has two switches. Pressing and holding the up, down, right and left keys (or EAB) causes the corresponding action to be repeated. Older devices do not have an EAB; front keys are used instead.

Generally, the following keys are available on braille displays:

Following are the Papenmeier command assignments for NVDA:

Devices with EAB:

BRAILLEX Tiny:

BRAILLEX 2D Screen:

HumanWare BrailleNote

NVDA supports the BrailleNote notetakers from Humanware when acting as a display terminal for a screen reader. The following models are supported:

• BrailleNote Classic (serial connection only)
• BrailleNote PK (Serial and bluetooth connections)
• BrailleNote MPower (Serial and bluetooth connections)
• BrailleNote Apex (USB and Bluetooth connections)

For BrailleNote Touch, please refer to the Brailliant BI Series / BrailleNote Touch section.

Except for BrailleNote PK, both braille (BT) and QWERTY (QT) keyboards are supported. For BrailleNote QT, PC keyboard emulation isn't supported. You can also enter braille dots using the QT keyboard. Please check the braille terminal section of the BrailleNote manual guide for details.

If your device supports more than one type of connection, when connecting your BrailleNote to NVDA, you must set the braille terminal port in braille terminal options. Please check the BrailleNote manual for details. In NVDA, you may also need to set the port in the Select Braille Display dialog. If you are connecting via USB or bluetooth, you can set the port to "Automatic", "USB" or "Bluetooth", depending on the available choices. If connecting using a legacy serial port (or a USB to serial converter) or if none of the previous options appear, you must explicitly choose the communication port to be used from the list of hardware ports.

Before connecting your BrailleNote Apex using its USB client interface, you must install the drivers provided by HumanWare.

On the BrailleNote Apex BT, you can use the scroll wheel located between dots 1 and 4 for various NVDA commands. The wheel consists of four directional dots, a centre click button, and a wheel that spins clockwise or counterclockwise.

Following are the BrailleNote command assignments for NVDA. Please check your BrailleNote's documentation to find where these keys are located.

Following are commands assigned to BrailleNote QT when it is not in braille input mode.

Following are commands assigned to the scroll wheel:

EcoBraille

NVDA supports EcoBraille displays from ONCE. The following models are supported:

• EcoBraille 20
• EcoBraille 40
• EcoBraille 80
• EcoBraille Plus

In NVDA, you can set the serial port to which the display is connected in the Select Braille Display dialog. These displays do not support NVDA's automatic background braille display detection functionality.

Following are the key assignments for EcoBraille displays. Please see the EcoBraille documentation for descriptions of where these keys can be found.

SuperBraille

The SuperBraille device, mostly available in Taiwan, can be connected to by either USB or serial. As the SuperBraille does not have any physical typing keys or scrolling buttons, all input must be performed via a standard computer keyboard. Due to this, and to maintain compatibility with other screen readers in Taiwan, two key bindings for scrolling the braille display have been provided:

Eurobraille displays

The b.book, b.note, Esys, Esytime and Iris displays from Eurobraille are supported by NVDA.
These devices have a braille keyboard with 10 keys. Please refer to the display's documentation for descriptions of these keys. Of the two keys placed like a space bar, the left key is corresponding to the backspace key and the right key to the space key.

These devices are connected via USB and have one stand-alone USB keyboard. It is possible to enable/disable this keyboard by toggling "HID Keyboard simulation" using an input gesture. The braille keyboard functions described directly below is when "HID Keyboard simulation" is disabled.

Braille keyboard functions

b.book keyboard commands

b.note keyboard commands

Esys keyboard commands

Esytime keyboard commands

Nattiq nBraille Displays

NVDA supports displays from Nattiq Technologies when connected via USB. Windows 10 and later detects the Braille Displays once connected, you may need to install USB drivers if using older versions of Windows (below Win10). You can get them from the manufacturer's website.

Following are the key assignments for Nattiq Technologies displays with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

BRLTTY

BRLTTY is a separate program which can be used to support many more braille displays. In order to use this, you need to install BRLTTY for Windows. You should download and install the latest installer package, which will be named, for example, brltty-win-4.2-2.exe. When configuring the display and port to use, be sure to pay close attention to the instructions, especially if you are using a USB display and already have the manufacturer's drivers installed.

For displays which have a braille keyboard, BRLTTY currently handles braille input itself. Therefore, NVDA's braille input table setting is not relevant.

BRLTTY is not involved in NVDA's automatic background braille display detection functionality.

Following are the BRLTTY command assignments for NVDA. Please see the BRLTTY key binding lists for information about how BRLTTY commands are mapped to controls on braille displays.

Tivomatic Caiku Albatross 46/80

The Caiku Albatross devices, which were manufactured by Tivomatic and available in Finland, can be connected to by either USB or serial. You do not need any specific drivers to be installed to use these displays. Just plug in the display and configure NVDA to use it.

Note: Baud rate 19200 is strongly recommended. If required, switch Baud rate setting value to 19200 from the braille device's menu. Although the driver supports 9600 baud rate, it has no way to control what baud rate the display uses. Because 19200 is the display default baud rate, the driver tries it at first. If baud rates are not the same, the driver may behave unexpectedly.

Following are key assignments for these displays with NVDA. Please see the display's documentation for descriptions of where these keys can be found.

Standard HID Braille displays

This is an experimental driver for the new Standard HID Braille Specification, agreed upon in 2018 by Microsoft, Google, Apple and several assistive technology companies including NV Access. The hope is that all future Braille Display models created by any manufacturer, will use this standard protocol which will remove the need for manufacturer-specific Braille drivers.

NVDA's automatic braille display detection will also recognize any display that supports this protocol.

Following are the current key assignments for these displays.

Advanced Topics

Secure Mode

System administrators may wish to configure NVDA to restrict unauthorized system access. NVDA allows the installation of custom add-ons, which can execute arbitrary code, including when NVDA is elevated to administrator privileges. NVDA also allows users to execute arbitrary code through the NVDA Python Console. NVDA secure mode prevents users from modifying their NVDA configuration, and otherwise limits unauthorized system access.

NVDA runs in secure mode when executed on secure screens, unless the serviceDebug system wide parameter is enabled. To force NVDA to always start in secure mode, set the forceSecureMode system wide parameter. NVDA can also be started in secure mode with the -s command line option.

Secure mode disables:

• Saving configuration and other settings to disk
• Saving the gesture map to disk
• Configuration Profile features such as creation, deletion, renaming profiles etc.
• Updating NVDA and creating portable copies
• The Add-on Store
• The NVDA Python console
• The Log Viewer and logging
• The Braille Viewer and Speech Viewer
• Opening external documents from the NVDA menu, such as the user guide or contributors file.

Installed copies of NVDA store their configuration including add-ons in %APPDATA%\nvda. To prevent NVDA users from modifying their configuration or add-ons directly, user access to this folder must also be restricted.

NVDA users often rely on configuring their NVDA profile to suit their needs. This may include installing and configuring custom add-ons, which should be vetted independently to NVDA. Secure mode freezes changes to NVDA configuration, so please ensure that NVDA is configured appropriately before forcing secure mode.

Secure Screens

NVDA runs in secure mode when executed on secure screens unless the serviceDebug system wide parameter is enabled.

When running from a secure screen, NVDA uses a system profile for preferences. NVDA user preferences can be copied for use in secure screens.

Secure screens include:

• The Windows sign-in screen
• The User Access Control dialog, active when performing an action as an administrator
  • This includes installing programs

Command Line Options

NVDA can accept one or more additional options when it starts which alter its behaviour. You can pass as many options as you need. These options can be passed when starting from a shortcut (in the shortcut properties), from the Run dialog (Start Menu -> Run or Windows+r) or from a Windows command console. Options should be separated from the name of NVDA's executable file and from other options by spaces. For example, a useful option is --disable-addons, which tells NVDA to suspend all running add-ons. This allows you to determine whether a problem is caused by an add-on and to recover from serious problems caused by add-ons.

As an example, you can exit the currently running copy of NVDA by entering the following in the Run dialog:

nvda -q

Some of the command line options have a short and a long version, while some of them have only a long version. For those which have a short version, you can combine them like this:

Some of the command line options accept additional parameters; e.g. how detailed the logging should be or the path to the user configuration directory. Those parameters should be placed after the option, separated from the option by a space when using the short version or an equals sign (=) when using the long version; e.g.:

Following are the command line options for NVDA:

System Wide Parameters

NVDA allows some values to be set in the system registry which alter the system wide behaviour of NVDA. These values are stored in the registry under one of the following keys:

• 32-bit system: HKEY_LOCAL_MACHINE\SOFTWARE\nvda
• 64-bit system: HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\nvda

The following values can be set under this registry key:

Further Information

If you require further information or assistance regarding NVDA, please visit the NVDA web site. Here, you can find additional documentation, as well as technical support and community resources. This site also provides information and resources concerning NVDA development.