# Preferences

To configure StarDict, click the Preferences button at the right-bottom corner of the Main window or click the Main menu button and choose Preferences.

## Dictionary

### Scan Selection

Only scan while modifier key is being pressed.

  Only do scanning while the modifier key being pressed. The modifier key is set by the Scan modifier key option.

  Default: FALSE.

Hide floating window when modifier key released.

  When this option is set, the Floating window is hidden when user releases the modifier key. Note: the window is hidden only if the pointer has the same position it had when the window was shown. In addition to hiding the window, the last selected text is forgotten, which allow you to lookup the same text again simply pressing the modifier key. When this option is not set, releasing the modifier key has no effect on the Floating window.

  This option has effect only if Only scan while modifier key is being pressed. is checked.

  Default: TRUE.

Scan modifier key

  This option allows to choose a modifier keys or a key combination that enables scanning.

  This option has effect only if Only scan while modifier key is being pressed. is checked.

  Default key: `Win` (depends on StarDict edition).

Scan clipboard.

  Enables Clipboard scanning. If enabled, when new text is copied into the clipboard, StarDict lookup the text into the Floating window.

  This option is only available in Windows edition of StarDict.

  Default: FALSE.

Scan mode shortcut

  The Scan mode shortcut enables or disables the Scan mode. Check the Use scan hotkey checkbox to enable this shortcut. You may change the shortcut in the field to the right of the label. Click inside the field and press the key combination you want to assign to this action.

  Default: TRUE

  Default shortcut: `Ctrl`+`Alt`+`x`.

### Font

Use custom font.

  Allows you to override the system's default for StarDict. If this option is turned on, the font selelected in the Dictionary font option will be used instead of the system font.

  Font settings apply immediately.

  Default: FALSE.

### Cache

Create cache files to speed up loading.

  Opening a dictionary the first time, StarDict does some calculations to access dictionary contents speedily. StarDict may save the results in special cache files that will be used the next time StarDict starts. With cache files StarDict starts quicker, since it does not need to do the same calculations again. It's highly recommended to enable caching. In the first place, StarDict tries to save a cache file along with the dictionary. If it fails, for example, because the directory is write-protected, StarDict creates a file under the user home directory, in StarDict's directory.

  Default: TRUE.

Sort word list by collation function.

  Normally, StarDict uses an index of words to look up a word in a dictionary. When the word is present in the index, the corresponding article is shown. Otherwise adjacent words will be checked and may be used as result. StarDict uses heuristic algorithms to decide whether the particular word may be suggested as result of the search or not. The order of words in an index is very important and it would be handy if index items were sorted by alphabet or according to other rules. Collation functions allows you to specify a number of predefined sorting orders, that may be helpful when working with particular languages.

  To use a collation function check the Sort word list by collation function checkbox and select the desired function from the Collation function list. The collation function will be applied as soon as you close the Preferences dialog. It may take a considerable amount of time to apply the new collation function, please, be patient.

  It's highly recommended to enable the Create cache files to speed up loading. option, otherwise StarDict will do sorting each time the application starts.

  Default: FALSE.

Clean all cache files

  Remove all StarDict cache files.

### Export

StarDict may export search results into a file. You have two options: export only the found word or export the entire search result, the contents of the Definition area.

Only export words.

  When this option is set, StarDict exports only the found word, otherwise exports the complete article.

  Default: TRUE.

File name

  Name of the file where to export data.

### Sound

There are a number of cases when StarDict needs to play sound files. StarDict may accompany GUI actions with sounds. StarDict may pronounce the words you search in the dictionary. Some articles may contain linked sound files you can play.

To play sound files StarDict may harness platform-specific services or use commands you specify on this page.

This page allows to configure some aspects of the TTS subsystem. The TTS subsystem is used to pronounce words by computer.

Enable sound event.

  Whether to enable sound events. StarDict will play sound event when button is active, released, and when a menu pops up.

  Default: TRUE.

Command for playing sound files:

  Specifies a command for playing sound files. You may specify a program name (with or without full path) accompaned with any options required. The file name to play will be appended to this command at run time.

Always use sound play command

  On some platforms StarDict use platform-specific services to play sound files first, then retreats to the custom command provided by the user if the service is unable to play the file. You may specify to always use the custom command selecting this option.

  Default: FALSE.

RealPeopleTTS search path:

  Allows to specify locations of RealPeopleTTS bundles. RealPeopleTTS bundle is a collection of sound files containing speech samples performed by real people. Normally, one file contains one recoded word, the file is named after that word. Sound files are organized into a number of directories. In the text field you must specify a path to the top level directory of the bundle. The order of paths in the text field is important. StarDict checks directories from top to bottom, the first found file will be used.

  ###### Default:

  In Windows edition of StarDict

    C:\Program Files\WyabdcRealPeopleTTS, C:\Program Files\OtdRealPeopleTTS, WyabdcRealPeopleTTS, OtdRealPeopleTTS

  In other editions of StarDict

    /usr/share/WyabdcRealPeopleTTS, /usr/share/OtdRealPeopleTTS

Enable TTS program.

  Allows to use the command below to read words. You need to restart StarDict for changes to take effect.

  Default: FALSE.

TTS Command line:

  This field allows to specify a command to use to pronounce words. You need to provide a print-like string, with "%s" specifing the place where the word (or phrase) to pronounce will be inserted. You need to restart StarDict for changes to take effect. Do not forget to check the checkbox above if you want to use this command.

  Default: nothing.

### Video

Command for playing video files:

  Specifies a command for playing video files. You may specify a program name (with or without full path) accompaned with any options required. The file name to play will be appended to this command at run time. Video files may be linked with dictionary articles.

### Article rendering

Highlight search term

  Whether to highlight the search term in the Definition area. A search term is a word that was found in dictionaries, a head word of an article.

  Default: FALSE.

### Dict management

Add new dictionaries to active dictionary group

  At start time StarDict scans known directories for dictionary files. This options specifies what to do with new dictionaries. When this option is on, new dictionaries are added to the active dictionary group. Otherwise you have to add new dictionaries to a group manually.

  Disabling this option may be useful if you have multiple groups and you want to control precisely what each group contains. Often the last active dictionary group is not appropriate for new dictionaries.

  Default: TRUE.

Add new plug-ins to active dictionary group

  At start time StarDict scans known directories for plug-in files. This options specifies what to do with new plug-ins (belonging to Virtual Dictionary and Network dictionary plug-in categories). When this option is on, new plug-ins are added to the active dictionary group. Otherwise you have to add new plug-ins to a group manually.

  Disabling this option may be useful if you have multiple groups and you want to control precisely what each group contains. Often the last active dictionary group is not appropriate for new plug-ins.

  Default: TRUE.

## Network

### Net Dict

StarDict may look up words in network dictionaries using a custom StarDict network protocol. This configuration page allows you to register an account, select a server to use, and specify other related parameters.

At the present time StarDict may be configured to query only one server. When network dictionaries are enabled, each time you ask StarDict to lookup a word or phrase, the application sends a request to the configured server. Note that network dictionaries are enabled globally, they are used in both Main and Floating windows, they do not depend on the dictionary group selected.

To configure the list of dictionaries on the server, use the Manage Dictionaries dialog, Network dictionaries tab.

You need to register on the server to use this feature. Click Register an account button on this page to register an account.

Enabling network dictionaries poses a security risk. Your text will be sent to remote servers. Additionally, since network requests do not use any encryption, anyone able to sniff communication can see that text.

Enable network dictionaries

  Enables network dictionaries.

  Default: FALSE.

### Web browser

StarDict may need to open a web link to start Internet search, show StarDict project website, show a web page to download new dictionaries, new version of the application and for other reasons. This configuration page allows to specify how a web link should be opened.

Command for opening URLs

  This option allows you to specify a command to use for opening URLs. Some editions of StarDict use platform-specific services for opening URLs by default. To use the custom command you need to check the checkbox below. For other editions of StarDict the custom command is the only way to open a web link.

  You may specify a program name (with or without full path) accompaned with any options required. The URL to open will be appended to this command at run time.

  Default: firefox (depends on edition).

Always use this command for opening URLs.

  This option is only available in editions of StarDict that can use other ways to open a web link.

  Check this option to use the custom command to open web links instead of platform-specific services.

  Default: FALSE.

## Main Window

### Input

Search while typing

  When this option is checked, StarDict search for the word you are typing in the search field automatically. StarDict monitors key-press events, it starts searching the word entered as soon as there is no activity for more than a specified amount of time. The time span can be changed in the field below. If the time span is 0, search is started immediately after you change the search field.

  When this option is not checked, you need to press `Enter` in order for StarDict to start searching the word.

  Default: TRUE

Word change timeout

  A word change timeout in milliseconds. See the option above for details.

  Default: 300 ms

Show the first word when not found.

  When StarDict is unable to find the exact word requested, the application may propose another word that is close to the original. When this option is checked, the closest word will be shown in the Definition area, otherwise, StarDict tells that the original word is not found. Note, that this option applies to simple queries only, that is the queries that do not use regular expressions, patterns, fuzzy matchs and so on.

  Default: TRUE

### Options

Skin

  Allows to customize graphical appearance of the application. Select the Default item to restore the original appearance of StarDict, no skins applied. You need to restart the application in order for changes to take effect. For instructions on how to prepare a custom skin see the doc/Skins file in StarDict sources.

  Default: Default.

Hide main window when starting StarDict.

  Controls whether the Main window appears when you first start the program. If you select this option, you will only see the Notification area icon after starting StarDict. You may still get to the Main window by clicking on this icon.

  Default: FALSE.

Use open main window hotkey

  This option enable the hotkey that opens the Main window, and allows to change that hotkey. When enabled, when user presses the hotkey, the Main window is presented to the user.

  Default: TRUE.

  Default hotkey: `Ctrl`+`Alt`+`z`

Transparency

  Allows to make the Main window transparent. Moving the slider you may change transparency degree. Transparency is measured in percents, it can range from 0 to 80, where 0 ‒ fully opaque, 80 ‒ almost fully transparent. Moving the slider has an immediate effect on the window.

  On X11 this has any effect only on X screens with a compositing manager running. On Windows it should work always.

  Default: 0 ‒ fully opaque.

### Search website

StarDict may use Web search engines, Web dictionaries, databases providing web-based interface and other web sites providing information by request. The text to search is incorporated into URL. Normally, the text is assigned to a GET request parameter. For example, to search for word stardict in Google search engine you may use the following URL http://www.google.com/search?q=stardict. You can search websites in StarDict right-clicking the Internet search button in the Main window.

StarDict does not handle the web request itself, it only composes a URL and invokes an external program like a web browser or use platform-specific services to open the URL.

On this page you may see a list of websites. Use Add and Remove buttons to add new sites and remove existing records. Use Up and Down arrow buttons to reorder records in the list. Each record consists of three items:

#### Website record

Website name

  This is a label you see in menu. Use a meaningful name.

Website link

  Link to the main page of the website. This link is opened when there is nothing to search for, the Search field is empty.

Website search link

  Link to perform request. %s identifies the place where to insert the search text. For example, http://www.google.com/search?q=%s.

## Notification area icon

### Options

When middle mouse button is clicked:

  Specifies an action to perform when user clicks the middle mouse button on the Notification area icon. There are the following choices:

  - Query selection in floating window

  - Query selection in main window

  - Do nothing

  In the Do nothing case StarDict simply ignores middle button clicks, otherwise StarDict get text of the current selection, search for it and displays the results either in the Floating window or in the Main window.

  In case there are a number of windows on desktop having text selected, there might be a confusion what text will be used. StarDict works with the X Primary selection. Only one application can own a selection at a time, so when you select something in an application that application becomes the selection owner, the previous owner loses selection ownership. Now back to the question. StarDict will use the text that was selected last.

  Default: Query selection in floating window.

## Floating Window

### Options

Pronounce the word when it pops up.

  When set, pronounce the word when the Floating window shows translation.

  Default: FALSE.

Show floating window if word not found.

  This option allows to configure what to do if the word to be shown in the Floating window is not found. You have two choices: 1) do not show the Floating window at all ‒ this option is unset, 2) show the Floating window with text indicating that the word was not found ‒ this option is set.

  Default: TRUE.

### Settings

Max window width.

  Sets the Floating window's max width.

  Default: 320.

Max window height.

  Sets the Floating window's max height.

  Default: 240.

Use custom background color:

  Enables to use custom color for background in the Floating window and select that color.

  Default: FALSE.

Transparency

  Allows to make the Floating window transparent. Moving the slider you may change transparency degree. Transparency is measured in percents, it can range from 0 to 80, where 0 ‒ fully opaque, 80 ‒ almost fully transparent. Moving the slider has an immediate effect on the window.

  On X11 this has any effect only on X screens with a compositing manager running. On Windows it should work always.

  Default: 0 ‒ fully opaque.