hunspell

package: hunspell

title: hunspell(5)

text:
# hunspell(5)

## NAME
hunspell - format of Hunspell dictionaries and affix files

## DESCRIPTION
Hunspell(1) Hunspell requires two files to define the way a language is being spell checked: a dictionary file containing words and applicable flags, and an affix file that specifies how these flags will control spell checking. An optional file is the personal dictionary file.

## Dictionary file
A dictionary file (*.dic) contains a list of words, one per line. The first line of the dictionaries (except personal dictionaries) contains the approximate word count (for optimal hash memory size). Each word may optionally be followed by a slash ("/") and one or more flags, which represents the word attributes, for example affixes.

Note: Dictionary words can contain also slashes when escaped like "\/" syntax.

It's worth to add not only words, but word pairs to the dictionary to get correct suggestions for common misspellings with missing space, as in the following example, for the bad "alot" and "inspite" (see also "REP" and field "ph:" about correct suggestions for common misspellings):

```
3
word
a lot
in spite
```

## Personal dictionary file
Personal dictionaries are simple word lists. Asterisk at the first character position signs prohibition. A second word separated by a slash sets the affixation.

```
foo
Foo/Simpson
*bar
```

In this example, "foo" and "Foo" are personal words, plus Foo will be recognized with affixes of Simpson (Foo's etc.) and bar is a forbidden word.

## Short example
Dictionary file:

```
3
hello
try/B
work/AB
```

The flags B and A specify attributes of these words.

Affix file:

```
SET UTF-8
TRY esianrtolcdugmphbyfvkwzESIANRTOLCDUGMPHBYFVKWZ'
REP 2
REP f ph
REP ph f
PFX A Y 1
PFX A 0 re .
SFX B Y 2
SFX B 0 ed [^y]
SFX B y ied y
```

In the affix file, prefix A and suffix B have been defined. Flag A defines a `re-' prefix. Class B defines two `-ed' suffixes. First B suffix can be added to a word if the last character of the word isn't `y'. Second suffix can be added to the words terminated with an `y'.

All accepted words with this dictionary and affix combination are: "hello", "try", "tried", "work", "worked", "rework", "reworked".

## AFFIX FILE GENERAL OPTIONS
Hunspell source distribution contains more than 80 examples for option usage.

SET encoding

Set character encoding of words and morphemes in affix and dictionary files. Possible values: UTF-8, ISO8859-1 - ISO8859-10, ISO8859-13 - ISO8859-15, KOI8-R, KOI8-U, cp1251, ISCII-DEVANAGARI.

```
SET UTF-8
```

FLAG value

Set flag type. Default type is the extended ASCII (8-bit) character. `UTF-8' parameter sets UTF-8 encoded Unicode character flags. The `long' value sets the double extended ASCII character flag type, the `num' sets the decimal number flag type. Decimal flags numbered from 1 to 65000, and in flag fields are separated by comma.

```
FLAG long
```

COMPLEXPREFIXES

Set twofold prefix stripping (but single suffix stripping) eg. for morphologically complex languages with right-to-left writing system.

LANG langcode

Set language code for language-specific functions of Hunspell. Use it to activate special casing of Azeri (LANG az), Turkish (LANG tr) and Crimean Tatar (LANG crh), also not generalized syllable-counting compounding rules of Hungarian (LANG hu).

IGNORE characters

Sets characters to ignore dictionary words, affixes and input words. Useful for optional characters, as Arabic (harakat) or Hebrew (niqqud) diacritical marks (see tests/ignore.* test dictionary in Hunspell distribution).

AF number_of_flag_vector_aliases

AF flag_vector

Hunspell can substitute affix flag sets with ordinal numbers in affix rules (alias compression, see makealias tool). First example with alias compression:

```
3
hello
try/1
work/2
```

AF definitions in the affix file:

```
AF 2
AF A
AF AB
```

It is equivalent of the following dic file:

```
3
hello
try/A
work/AB
```

See also tests/alias* examples of the source distribution.

Note I: If affix file contains the FLAG parameter, define it before the AF definitions.

Note II: Use makealias utility in Hunspell distribution to compress aff and dic files.

AM number_of_morphological_aliases

AM morphological_fields

Hunspell can substitute also morphological data with ordinal numbers in affix rules (alias compression). See tests/alias* examples.

## AFFIX FILE OPTIONS FOR SUGGESTION
Suggestion parameters can optimize the default n-gram (similarity search in the dictionary words based on the common 1, 2, 3, 4-character length common character-sequences), character swap and deletion suggestions of Hunspell. REP is suggested to fix the typical and especially bad language specific bugs, because the REP suggestions have the highest priority in the suggestion list. PHONE is for languages with not pronunciation based orthography.

For short common misspellings, it's important to use the ph: field (see later) to give the best suggestions.

KEY characters_separated_by_vertical_line_optionally

Hunspell searches and suggests words with one different character replaced by a neighbor KEY character. Not neighbor characters in KEY string separated by vertical line characters. Suggested KEY parameters for QWERTY and Dvorak keyboard layouts:

```
KEY qwertyuiop|asdfghjkl|zxcvbnm
KEY pyfgcrl|aeouidhtns|qjkxbmwvz
```

Using the first QWERTY layout, Hunspell suggests "nude" and "node" for "*nide". A character may have more neighbors, too:

```
KEY qwertzuop|yxcvbnm|qaw|say|wse|dsx|sy|edr|fdc|dx|rft|gfv|fc|tgz|hgb|gv|zhu|jhn|hb|uji|kjm|jn|iko|lkm
```

TRY characters

Hunspell can suggest right word forms, when they differ from the bad input word by one TRY character. The parameter of TRY is case sensitive.

NOSUGGEST flag

Words signed with NOSUGGEST flag are not suggested (but still accepted when typed correctly). Proposed flag for vulgar and obscene words (see also SUBSTANDARD).

MAXCPDSUGS num

Set max. number of suggested compound words generated by compound rules. The number of the suggested compound words may be greater from the same 1-character distance type.

MAXNGRAMSUGS num

Set max. number of n-gram suggestions. Value 0 switches off the n-gram suggestions (see also MAXDIFF).

MAXDIFF [0-10]

Set the similarity factor for the n-gram based suggestions (5 = default value; 0 = fewer n-gram suggestions, but min. 1; 10 = MAXNGRAMSUGS n-gram suggestions).

ONLYMAXDIFF

Remove all bad n-gram suggestions (default mode keeps one, see MAXDIFF).

NOSPLITSUGS

Disable word suggestions with spaces.

SUGSWITHDOTS

Add dot(s) to suggestions, if input word terminates in dot(s). (Not for LibreOffice dictionaries, because LibreOffice has an automatic dot expansion mechanism.)

REP number_of_replacement_definitions

REP what replacement

This table specifies modifications to try first. First REP is the header of this table and one or more REP data line are following it. With this table, Hunspell can suggest the right forms for the typical spelling mistakes when the incorrect form differs by more than 1 letter from the right form (see also "ph:"). The search string supports the regex boundary signs (^ and $). For example a possible English replacement table definition to handle misspelled consonants:

```
REP 5
REP f ph
REP ph f
REP tion$ shun
REP ^cooccurr co-occurr
REP ^alot$ a_lot
```

Note I: It's very useful to define replacements for the most typical one-character mistakes, too: with REP you can add higher priority to a subset of the TRY suggestions (suggestion list begins with the REP suggestions).

Note II: Suggesting separated words, specify spaces with underlines:

```
REP 1
REP onetwothree one_two_three
```

Note III: Replacement table can be used for a stricter compound word checking with the option CHECKCOMPOUNDREP.

MAP number_of_map_definitions

MAP string_of_related_chars_or_parenthesized_character_sequences

We can define language-dependent information on characters and character sequences that should be considered related (i.e. nearer than other chars not in the set) in the affix file (.aff) by a map table. With this table, Hunspell can suggest the right forms for words, which incorrectly choose the wrong letter or letter groups from a related set more than once in a word (see REP). For example a possible mapping could be for the German umlauted ü versus the regular u; the word Frühstück really should be written with umlauted u's and not regular ones

```
MAP 1
MAP uü
```

Use parenthesized groups for character sequences (eg. for composed Unicode characters):

```
MAP 3
MAP ß(ss)  (character sequence)
MAP ﬁ(fi)  ("fi" compatibility characters for Unicode fi ligature)
MAP (ọ́)o   (composed Unicode character: ó with bottom dot)
```

PHONE number_of_phone_definitions

PHONE what replacement

PHONE uses a table-driven phonetic transcription algorithm borrowed from Aspell. It is useful for languages with not pronunciation based orthography. You can add a full alphabet conversion and other rules for conversion of special letter sequences. For detailed documentation see http://aspell.net/man-html/Phonetic-Code.html. Note: Multibyte UTF-8 characters have not worked with bracket expression yet. Dash expression has signed bytes and not UTF-8 characters yet.

WARN flag

This flag is for rare words, which are also often spelling mistakes, see option -r of command line Hunspell and FORBIDWARN.

FORBIDWARN

Words with flag WARN aren't accepted by the spell checker using this parameter.

## OPTIONS FOR COMPOUNDING
BREAK number_of_break_definitions

BREAK character_or_character_sequence

Define new break points for breaking words and checking word parts separately. Use ^ and $ to delete characters at end and start of the word. Rationale: useful for compounding with joining character or strings (for example, hyphen in English and German or hyphen and n-dash in Hungarian). Dashes are often bad break points for tokenization, because compounds with dashes may contain not valid parts, too.) With BREAK, Hunspell can check both side of these compounds, breaking the words at dashes and n-dashes:

```
BREAK 2
BREAK -
BREAK --    # n-dash
```

Breaking are recursive, so foo-bar, bar-foo and foo-foo--bar-bar would be valid compounds. Note: The default word break of Hunspell is equivalent of the following BREAK definition:

```
BREAK 3
BREAK -
BREAK ^-
BREAK -$
```

Hunspell doesn't accept the "-word" and "word-" forms by this BREAK definition:

```
BREAK 1
BREAK -
```

Switching off the default values:

```
BREAK 0
```

Note II: COMPOUNDRULE is better for handling dashes and other compound joining characters or character strings. Use BREAK, if you want to check words with dashes or other joining characters and there is no time or possibility to describe precise compound rules with COMPOUNDRULE (COMPOUNDRULE handles only the suffixation of the last word part of a compound word).

Note III: For command line spell checking of words with extra characters, set WORDCHARS parameters: WORDCHARS --- (see tests/break.*) example

COMPOUNDRULE number_of_compound_definitions

COMPOUNDRULE compound_pattern

Define custom compound patterns with a regex-like syntax. The first COMPOUNDRULE is a header with the number of the following COMPOUNDRULE definitions. Compound patterns consist compound flags, parentheses, star and question mark meta characters. A flag followed by a `*' matches a word sequence of 0 or more matches of words signed with this compound flag. A flag followed by a `?' matches a word sequence of 0 or 1 matches of a word signed with this compound flag. See tests/compound*.* examples. Note: en_US dictionary of OpenOffice.org uses COMPOUNDRULE for ordinal number recognition (1st, 2nd, 11th, 12th, 22nd, 112th, 1000122nd etc.).

Note II: In the case of long and numerical flag types use only parenthesized flags: (1500)*(2000)?

Note III: COMPOUNDRULE flags work completely separately from the compounding mechanisms using COMPOUNDFLAG, COMPOUNDBEGIN, etc. compound flags. (Use these flags on different entries for words).

COMPOUNDMIN num

Minimum length of words used for compounding. Default value is 3 letters.

COMPOUNDFLAG flag

Words signed with COMPOUNDFLAG may be in compound words (except when word shorter than COMPOUNDMIN). Affixes with COMPOUNDFLAG also permits compounding of affixed words.

COMPOUNDBEGIN flag

Words signed with COMPOUNDBEGIN (or with a signed affix) may be first elements in compound words.

COMPOUNDLAST flag

Words signed with COMPOUNDLAST (or with a signed affix) may be last elements in compound words.

COMPOUNDMIDDLE flag

Words signed with COMPOUNDMIDDLE (or with a signed affix) may be middle elements in compound words.

ONLYINCOMPOUND flag

Suffixes signed with ONLYINCOMPOUND flag may be only inside of compounds (Fuge-elements in German, fogemorphemes in Swedish). ONLYINCOMPOUND flag works also with words (see tests/onlyincompound.*). Note: also valuable to flag compounding parts which are not correct as a word by itself.

COMPOUNDPERMITFLAG flag

Prefixes are allowed at the beginning of compounds, suffixes are allowed at the end of compounds by default. Affixes with COMPOUNDPERMITFLAG may be inside of compounds.

COMPOUNDFORBIDFLAG flag

Suffixes with this flag forbid compounding of the affixed word. Dictionary words with this flag are removed from the beginning and middle of compound words, overriding the effect of COMPOUNDPERMITFLAG.

COMPOUNDMORESUFFIXES

Allow twofold suffixes within compounds.

COMPOUNDROOT flag

COMPOUNDROOT flag signs the compounds in the dictionary (Now it is used only in the Hungarian language specific code).

COMPOUNDWORDMAX number

Set maximum word count in a compound word. (Default is unlimited.)

CHECKCOMPOUNDDUP

Forbid word duplication in compounds (e.g. foofoo).

CHECKCOMPOUNDREP

Forbid compounding, if the (usually bad) compound word may be a non-compound word with a REP fault. Useful for languages with `compound friendly' orthography.

CHECKCOMPOUNDCASE

Forbid upper case characters at word boundaries in compounds.

CHECKCOMPOUNDTRIPLE

Forbid compounding, if compound word contains triple repeating letters (e.g. foo|ox or xo|oof). Bug: missing multi-byte character support in UTF-8 encoding (works only for 7-bit ASCII characters).

SIMPLIFIEDTRIPLE

Allow simplified 2-letter forms of the compounds forbidden by CHECKCOMPOUNDTRIPLE. It's useful for Swedish and Norwegian (and for the old German orthography: Schiff|fahrt -> Schiffahrt).

CHECKCOMPOUNDPATTERN number_of_checkcompoundpattern_definitions

CHECKCOMPOUNDPATTERN endchars[/flag] beginchars[/flag] [replacement]

Forbid compounding, if the first word in the compound ends with endchars, and next word begins with beginchars and (optionally) they have the requested flags. The optional replacement parameter allows simplified compound form. The special "endchars" pattern 0 (zero) limits the rule to the unmodified stems (stems and stems with zero affixes):

```
CHECKCOMPOUNDPATTERN 0/x /y
```

Note: COMPOUNDMIN doesn't work correctly with the compound word alternation, so it may need to set COMPOUNDMIN to lower value.

FORCEUCASE flag

Last word part of a compound with flag FORCEUCASE forces capitalization of the whole compound word. Eg. Dutch word "straat" (street) with FORCEUCASE flags will allowed only in capitalized compound forms, according to the Dutch spelling rules for proper names.

COMPOUNDSYLLABLE max_syllable vowels

Need for special compounding rules in Hungarian. First parameter is the maximum syllable number, that may be in a compound, if words in compounds are more than COMPOUNDWORDMAX. Second parameter is the list of vowels (for calculating syllables).

SYLLABLENUM flags

Need for special compounding rules in Hungarian.

## AFFIX FILE OPTIONS FOR AFFIX CREATION
PFX flag cross_product number

PFX flag stripping prefix [condition [morphological_fields...]]

SFX flag cross_product number

SFX flag stripping suffix [condition [morphological_fields...]]

An affix is either a prefix or a suffix attached to root words to make other words. We can define affix classes with arbitrary number affix rules. Affix classes are signed with affix flags. The first line of an affix class definition is the header. The fields of an affix class header: (0) Option name (PFX or SFX)

(1) Flag (name of the affix class)

(2) Cross product (permission to combine prefixes and suffixes). Possible values: Y (yes) or N (no)

(3) Line count of the following rules.

Fields of an affix rules:

(0) Option name

(1) Flag

(2) stripping characters from beginning (at prefix rules) or end (at suffix rules) of the word

(3) affix (optionally with flags of continuation classes, separated by a slash)

(4) condition.

Zero stripping or affix are indicated by zero. Zero condition is indicated by dot. Condition is a simplified, regular expression-like pattern, which must be met before the affix can be applied. (Dot signs an arbitrary character. Characters in braces sign an arbitrary character from the character subset. Dash hasn't got special meaning, but circumflex (^) next the first brace sets the complementer character set.)

(5) Optional morphological fields separated by spaces or tabulators.

## AFFIX FILE OTHER OPTIONS
CIRCUMFIX flag

Affixes signed with CIRCUMFIX flag may be on a word when this word also has a prefix with CIRCUMFIX flag and vice versa (see circumfix.* test files in the source distribution).

FORBIDDENWORD flag

This flag signs forbidden word form. Because affixed forms are also forbidden, we can subtract a subset from set of the accepted affixed and compound words. Note: usefull to forbid erroneous words, generated by the compounding mechanism.

FULLSTRIP

With FULLSTRIP, affix rules can strip full words, not only one less characters, before adding the affixes, see fullstrip.* test files in the source distribution). Note: conditions may be word length without FULLSTRIP, too.

KEEPCASE flag

Forbid uppercased and capitalized forms of words signed with KEEPCASE flags. Useful for special orthographies (measurements and currency often keep their case in uppercased texts) and writing systems (e.g. keeping lower case of IPA characters). Also valuable for words erroneously written in the wrong case. Note: With CHECKSHARPS declaration, words with sharp s and KEEPCASE flag may be capitalized and uppercased, but uppercased forms of these words may not contain sharp s, only SS. See germancompounding example in the tests directory of the Hunspell distribution.

ICONV number_of_ICONV_definitions

ICONV pattern pattern2

Define input conversion table. Note: useful to convert one type of quote to another one, or change ligature.

OCONV number_of_OCONV_definitions

OCONV pattern pattern2

Define output conversion table.

LEMMA_PRESENT flag

Deprecated. Use "st:" field instead of LEMMA_PRESENT.

NEEDAFFIX flag

This flag signs virtual stems in the dictionary, words only valid when affixed. Except, if the dictionary word has a homonym or a zero affix. NEEDAFFIX works also with prefixes and prefix + suffix combinations (see tests/needaffix5.*).

PSEUDOROOT flag

Deprecated. (Former name of the NEEDAFFIX option.)

SUBSTANDARD flag

SUBSTANDARD flag signs affix rules and dictionary words (allomorphs) not used in morphological generation and root words removed from suggestion. See also NOSUGGEST.

WORDCHARS characters

WORDCHARS extends tokenizer of Hunspell command line interface with additional word character. For example, dot, dash, n-dash, numbers, percent sign are word character in Hungarian.

CHECKSHARPS

SS letter pair in uppercased (German) words may be upper case sharp s (ß). Hunspell can handle this special casing with the CHECKSHARPS declaration (see also KEEPCASE flag and tests/germancompounding example) in both spelling and suggestion.

## Morphological analysis
Hunspell's dictionary items and affix rules may have optional space or tabulator separated morphological description fields, started with 3-character (two letters and a colon) field IDs:

```
 word/flags po:noun is:nom
```

Example: We define a simple resource with morphological informations, a derivative suffix (ds:) and a part of speech category (po:):

Affix file:

```
 SFX X Y 1

 SFX X 0 able . ds:able
```

Dictionary file:

```
 drink/X po:verb
```

Test file:

```
 drink

 drinkable
```

Test:

```
 $ analyze test.aff test.dic test.txt

 > drink

 analyze(drink) = po:verb

 stem(drink) = po:verb

 > drinkable

 analyze(drinkable) = po:verb ds:able

 stem(drinkable) = drinkable
```

You can see in the example, that the analyzer concatenates the morphological fields in item and arrangement style.

## Optional data fields
Default morphological and other IDs (used in suggestion, stemming and morphological generation):

ph:

Alternative transliteration for better suggestions, ie. misspellings related to the special orthography and pronunciation of the word. The best way to handle common misspellings, so it's worth to add ph: field to the most affected few thousand dictionary words (or word pairs etc.) to get correct suggestions for their misspellings.

For example:

```
Wednesday ph:wendsay ph:wensday
Marseille ph:maarsayl
```

Hunspell adds all ph: transliterations to the inner REP table, so it will always suggest the correct word for the specified misspellings with the highest priority.

The previous example is equivalent of the following REP definition:

```
REP 6
REP wendsay Wednesday
REP Wendsay Wednesday
REP wensday Wednesday
REP Wensday Wednesday
REP maarsayl Marseille
REP Maarsayl Marseille
```

The asterisk at the end of the ph: pattern means stripping the terminating character both from the pattern and the word in the associated REP rule:

```
pretty ph:prity*
```

will result

```
REP 1
REP prit prett
```

REP rule, resulting the following correct suggestions

```
*prity -> pretty
*pritier -> prettier
*pritiest -> prettiest
```

Moreover, ph: fields can handle suggestions with more than two words, also different suggestions for the same misspelling:

```
do not know ph:dunno
don't know ph:dunno
```

results

```
*dunno -> do not know, don't know
```

Note: if available, ph: is used in n-gram similarity, too.

The ASCII arrow "->" in a ph: pattern means a REP rule (see REP), creating arbitrary replacement rule associated to the dictionary item:

```
happy/B ph:hepy ph:hepi->happi
```

results

```
*hepy -> happy
*hepiest -> happiest
```

st:

Stem. Optional: default stem is the dictionary item in morphological analysis. Stem field is useful for virtual stems (dictionary words with NEEDAFFIX flag) and morphological exceptions instead of new, single used morphological rules.

```
feet  st:foot  is:plural
mice  st:mouse is:plural
teeth st:tooth is:plural
```

Word forms with multiple stems need multiple dictionary items:

```
lay po:verb st:lie is:past_2
lay po:verb is:present
lay po:noun
```

al:

Allomorph(s). A dictionary item is the stem of its allomorphs. Morphological generation needs stem, allomorph and affix fields.

```
sing al:sang al:sung
sang st:sing
sung st:sing
```

po:

Part of speech category.

ds:

Derivational suffix(es). Stemming doesn't remove derivational suffixes. Morphological generation depends on the order of the suffix fields. In affix rules:

```
SFX Y Y 1
SFX Y 0 ly . ds:ly_adj
```

In the dictionary:

```
ably st:able ds:ly_adj
able al:ably
```

is:

Inflectional suffix(es). All inflectional suffixes are removed by stemming. Morphological generation depends on the order of the suffix fields.

```
feet st:foot is:plural
```

ts:

Terminal suffix(es). Terminal suffix fields are inflectional suffix fields "removed" by additional (not terminal) suffixes. Useful for zero morphemes and affixes removed by splitting rules.

```
work/D ts:present
```

```
SFX D Y 2
SFX D   0 ed . is:past_1
SFX D   0 ed . is:past_2
```

Typical example of the terminal suffix is the zero morpheme of the nominative case.

sp:

Surface prefix. Temporary solution for adding prefixes to the stems and generated word forms. See tests/morph.* example.

pa:

Parts of the compound words. Output fields of morphological analysis for stemming.

dp:

Planned: derivational prefix.

ip:

Planned: inflectional prefix.

tp:

Planned: terminal prefix.

## Twofold suffix stripping
Ispell's original algorithm strips only one suffix. Hunspell can strip another one yet (or a plus prefix in COMPLEXPREFIXES mode).

The twofold suffix stripping is a significant improvement in handling of immense number of suffixes, that characterize agglutinative languages.

A second `s' suffix (affix class Y) will be the continuation class of the suffix `able' in the following example:

```
 SFX Y Y 1

 SFX Y 0 s .

 SFX X Y 1

 SFX X 0 able/Y .
```

Dictionary file:

```
 drink/X
```

Test file:

```
 drink

 drinkable

 drinkables
```

Test:

```
 $ hunspell -m -d test <test.txt

 drink st:drink

 drinkable st:drink fl:X

 drinkables st:drink fl:X fl:Y
```

Theoretically with the twofold suffix stripping needs only the square root of the number of suffix rules, compared with a Hunspell implementation. In our practice, we could have elaborated the Hungarian inflectional morphology with twofold suffix stripping.

## Extended affix classes
Hunspell can handle more than 65000 affix classes. There are three new syntax for giving flags in affix and dictionary files.

FLAG long command sets 2-character flags:

```
  FLAG long

  SFX Y1 Y 1

  SFX Y1 0 s 1
```

Dictionary record with the Y1, Z3, F? flags:

```
  foo/Y1Z3F?
```

FLAG num command sets numerical flags separated by comma:

```
  FLAG num

  SFX 65000 Y 1

  SFX 65000 0 s 1
```

Dictionary example:

```
  foo/65000,12,2756
```

The third one is the Unicode character flags.

## Homonyms
Hunspell's dictionary can contain repeating elements that are homonyms:

```
 work/A    po:verb

 work/B    po:noun
```

An affix file:

```
 SFX A Y 1

 SFX A 0 s . sf:sg3

 SFX B Y 1

 SFX B 0 s . is:plur
```

Test file:

```
 works
```

Test:

```
 $ hunspell -d test -m <testwords

 work st:work po:verb is:sg3

 work st:work po:noun is:plur
```

This feature also gives a way to forbid illegal prefix/suffix combinations.

## Prefix--suffix dependencies
An interesting side-effect of multi-step stripping is, that the appropriate treatment of circumfixes now comes for free. For instance, in Hungarian, superlatives are formed by simultaneous prefixation of leg- and suffixation of -bb to the adjective base. A problem with the one-level architecture is that there is no way to render lexical licensing of particular prefixes and suffixes interdependent, and therefore incorrect forms are recognized as valid, i.e. *legvén = leg + vén `old'. Until the introduction of clusters, a special treatment of the superlative had to be hardwired in the earlier HunSpell code. This may have been legitimate for a single case, but in fact prefix--suffix dependences are ubiquitous in category-changing derivational patterns (cf. English payable, non-payable but *non-pay or drinkable, undrinkable but *undrink). In simple words, here, the prefix un- is legitimate only if the base drink is suffixed with -able. If both these patters are handled by on-line affix rules and affix rules are checked against the base only, there is no way to express this dependency and the system will necessarily over- or undergenerate.

In next example, suffix class R have got a prefix `continuation' class (class P).

```
PFX P Y 1
PFX P   0 un . [prefix_un]+
SFX S Y 1
SFX S   0 s . +PL
SFX Q Y 1
SFX Q   0 s . +3SGV
SFX R Y 1
SFX R   0 able/PS . +DER_V_ADJ_ABLE
```

Dictionary:

```
2
drink/RQ	[verb]
drink/S	[noun]
```

Morphological analysis:

```
> drink
drink[verb]
drink[noun]
> drinks
drink[verb]+3SGV
drink[noun]+PL
> drinkable
drink[verb]+DER_V_ADJ_ABLE
> drinkables
drink[verb]+DER_V_ADJ_ABLE+PL
> undrinkable
[prefix_un]+drink[verb]+DER_V_ADJ_ABLE
> undrinkables
[prefix_un]+drink[verb]+DER_V_ADJ_ABLE+PL
> undrink
Unknown word.
> undrinks
Unknown word.
```

## Circumfix
Conditional affixes implemented by a continuation class are not enough for circumfixes, because a circumfix is one affix in morphology. We also need CIRCUMFIX option for correct morphological analysis.

```
# circumfixes: ~ obligate prefix/suffix combinations
# superlative in Hungarian: leg- (prefix) AND -bb (suffix)
# nagy, nagyobb, legnagyobb, legeslegnagyobb
# (great, greater, greatest, most greatest)
CIRCUMFIX X
PFX A Y 1
PFX A 0 leg/X .
PFX B Y 1
PFX B 0 legesleg/X .
SFX C Y 3
SFX C 0 obb . +COMPARATIVE
SFX C 0 obb/AX . +SUPERLATIVE
SFX C 0 obb/BX . +SUPERSUPERLATIVE
```

Dictionary:

```
1
nagy/C	[MN]
```

Analysis:

```
> nagy
nagy[MN]
> nagyobb
nagy[MN]+COMPARATIVE
> legnagyobb
nagy[MN]+SUPERLATIVE
> legeslegnagyobb
nagy[MN]+SUPERSUPERLATIVE
```

## Compounds
Allowing free compounding yields decrease in precision of recognition, not to mention stemming and morphological analysis. Although lexical switches are introduced to license compounding of bases by Ispell, this proves not to be restrictive enough. For example:

```
# affix file
COMPOUNDFLAG X
```

```
2
foo/X
bar/X
```

With this resource, foobar and barfoo also are accepted words.

This has been improved upon with the introduction of direction-sensitive compounding, i.e., lexical features can specify separately whether a base can occur as leftmost or rightmost constituent in compounds. This, however, is still insufficient to handle the intricate patterns of compounding, not to mention idiosyncratic (and language specific) norms of hyphenation.

The Hunspell algorithm currently allows any affixed form of words, which are lexically marked as potential members of compounds. Hunspell improved this, and its recursive compound checking rules makes it possible to implement the intricate spelling conventions of Hungarian compounds. For example, using COMPOUNDWORDMAX, COMPOUNDSYLLABLE, COMPOUNDROOT, SYLLABLENUM options can be set the noteworthy Hungarian `6-3' rule. Further example in Hungarian, derivate suffixes often modify compounding properties. Hunspell allows the compounding flags on the affixes, and there are two special flags (COMPOUNDPERMITFLAG and (COMPOUNDFORBIDFLAG) to permit or prohibit compounding of the derivations.

Suffixes with this flag forbid compounding of the affixed word.

We also need several Hunspell features for handling German compounding:

```
# German compounding
# set language to handle special casing of German sharp s
LANG de_DE
# compound flags
COMPOUNDBEGIN U
COMPOUNDMIDDLE V
COMPOUNDEND W
# Prefixes are allowed at the beginning of compounds,
# suffixes are allowed at the end of compounds by default:
# (prefix)?(root)+(affix)?
# Affixes with COMPOUNDPERMITFLAG may be inside of compounds.
COMPOUNDPERMITFLAG P
# for German fogemorphemes (Fuge-element)
# Hint: ONLYINCOMPOUND is not required everywhere, but the
# checking will be a little faster with it.
ONLYINCOMPOUND X
# forbid uppercase characters at compound word bounds
CHECKCOMPOUNDCASE
# for handling Fuge-elements with dashes (Arbeits-)
# dash will be a special word
COMPOUNDMIN 1
WORDCHARS -
# compound settings and fogemorpheme for `Arbeit'
SFX A Y 3
SFX A 0 s/UPX .
SFX A 0 s/VPDX .
SFX A 0 0/WXD .
SFX B Y 2
SFX B 0 0/UPX .
SFX B 0 0/VWXDP .
# a suffix for `Computer'
SFX C Y 1
SFX C 0 n/WD .
# for forbid exceptions (*Arbeitsnehmer)
FORBIDDENWORD Z
# dash prefix for compounds with dash (Arbeits-Computer)
PFX - Y 1
PFX - 0 -/P .
# decapitalizing prefix
# circumfix for positioning in compounds
PFX D Y 29
PFX D A a/PX A
PFX D Ä ä/PX Ä

 .

 .
PFX D Y y/PX Y
PFX D Z z/PX Z
```

Example dictionary:

```
4
Arbeit/A-
Computer/BC-
-/W
Arbeitsnehmer/Z
```

Accepted compound compound words with the previous resource:

```
Computer
Computern
Arbeit
Arbeits-
Computerarbeit
Computerarbeits-
Arbeitscomputer
Arbeitscomputern
Computerarbeitscomputer
Computerarbeitscomputern
Arbeitscomputerarbeit
Computerarbeits-Computer
Computerarbeits-Computern
```

Not accepted compoundings:

```
computer
arbeit
Arbeits
arbeits
ComputerArbeit
ComputerArbeits
Arbeitcomputer
ArbeitsComputer
Computerarbeitcomputer
ComputerArbeitcomputer
ComputerArbeitscomputer
Arbeitscomputerarbeits
Computerarbeits-computer
Arbeitsnehmer
```

This solution is still not ideal, however, and will be replaced by a pattern-based compound-checking algorithm which is closely integrated with input buffer tokenization. Patterns describing compounds come as a separate input resource that can refer to high-level properties of constituent parts (e.g. the number of syllables, affix flags, and containment of hyphens). The patterns are matched against potential segmentations of compounds to assess wellformedness.

## Unicode character encoding
Both Ispell and Myspell use 8-bit ASCII character encoding, which is a major deficiency when it comes to scalability. Although a language like Hungarian has a standard ASCII character set (ISO 8859-2), it fails to allow a full implementation of Hungarian orthographic conventions. For instance, the '--' symbol (n-dash) is missing from this character set contrary to the fact that it is not only the official symbol to delimit parenthetic clauses in the language, but it can be in compound words as a special 'big' hyphen.

MySpell has got some 8-bit encoding tables, but there are languages without standard 8-bit encoding, too. For example, a lot of African languages have non-latin or extended latin characters.

Similarly, using the original spelling of certain foreign names like Ångström or Molière is encouraged by the Hungarian spelling norm, and, since characters 'Å' and 'è' are not part of ISO 8859-2, when they combine with inflections containing characters only in ISO 8859-2 (like elative -ből, allative -től or delative -ről with double acute), these result in words (like Ångströmről or Molière-től.) that can not be encoded using any single ASCII encoding scheme.

The problems raised in relation to 8-bit ASCII encoding have long been recognized by proponents of Unicode. It is clear that trading efficiency for encoding-independence has its advantages when it comes a truly multi-lingual application. There is implemented a memory and time efficient Unicode handling in Hunspell. In non-UTF-8 character encodings Hunspell works with the original 8-bit strings. In UTF-8 encoding, affixes and words are stored in UTF-8, during the analysis are handled in mostly UTF-8, under condition checking and suggestion are converted to UTF-16. Unicode text analysis and spell checking have a minimal (0-20%) time overhead and minimal or reasonable memory overhead depends from the language (its UTF-8 encoding and affixation).

## Conversion of aspell dictionaries
Aspell dictionaries can be easily converted into hunspell. Conversion steps:

dictionary (xx.cwl -> xx.wl):

```
preunzip xx.cwl
wc -l < xx.wl > xx.dic
cat xx.wl >> xx.dic
```

affix file

If the affix file exists, copy it:

```
cp xx_affix.dat xx.aff
```

If not, create it with the suitable character encoding (see xx.dat)

```
echo "SET ISO8859-x" > xx.aff
```

or

```
echo "SET UTF-8" > xx.aff
```

It's useful to add a TRY option with the characters of the dictionary with frequency order to set edit distance suggestions:

```
echo "TRY qwertzuiopasdfghjklyxcvbnmQWERTZUIOPASDFGHJKLYXCVBNM" >>xx.aff
```

## SEE ALSO
hunspell (1), ispell (1), ispell (4)


package: hwclock

title: adjtime_config(5)

text:
# adjtime_config(5)

## NAME
adjtime_config - information about hardware clock setting and drift factor

## SYNOPSIS
/etc/adjtime

## DESCRIPTION
The file /etc/adjtime contains descriptive information about the hardware mode clock setting and clock drift factor. The file is read and write by hwclock(8); and read by programs like rtcwake to get RTC time mode.

The file is usually located in /etc, but tools like hwclock(8) or rtcwake(8) can use alternative location by command line options if write access to /etc is unwanted. The default clock mode is "UTC" if the file is missing.

The Hardware Clock is usually not very accurate. However, much of its inaccuracy is completely predictable - it gains or loses the same amount of time every day. This is called systematic drift. The util hwclock(8) keeps the file /etc/adjtime, that keeps some historical information. For more details see "The Adjust Function" and "The Adjtime File" sections from hwclock(8) man page.

The adjtime file is formatted in ASCII.

### First line
Three numbers, separated by blanks:

drift factor

the systematic drift rate in seconds per day (floating point decimal)

last adjust time

the resulting number of seconds since 1969 UTC of most recent adjustment or calibration (decimal integer)

adjustment status

zero (for compatibility with clock(8)) as a floating point decimal

### Second line
last calibration time

The resulting number of seconds since 1969 UTC of most recent calibration. Zero if there has been no calibration yet or it is known that any previous calibration is moot (for example, because the Hardware Clock has been found, since that calibration, not to contain a valid time). This is a decimal integer.

### Third line
clock mode

Supported values are UTC or LOCAL. Tells whether the Hardware Clock is set to Coordinated Universal Time or local time. You can always override this value with options on the hwclock(8) command line.

## FILES
/etc/adjtime

## SEE ALSO
hwclock(8), rtcwake(8)

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
adjtime_config is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.

branch: sisyphus


package: ibus

title: 00-upstream-settings(5)

summary: dconf configuration file

text:
# 00-upstream-settings(5)

## NAME
00-upstream-settings - dconf configuration file

## SYNOPSIS
/etc/dconf/db/ibus.d/00-upstream-settings

## DESCRIPTION
IBus is an Intelligent Input Bus. It is a new input framework for Linux OS. It provides full featured and user friendly input method user interface. It also may help developers to develop input method easily.

00-upstream-settings is a text configuration file of dconf and can be converted to /etc/dconf/db/ibus by dconf update command with a write privilege in /etc/dconf/db. /etc/dconf/db/ibus is a database file of dconf and saves the IBus default settings. The saved keys and values can be readed by dconf command.

```
env DCONF_PROFILE=ibus dconf list /desktop/ibus/
```

```

```

## BUGS
If you find a bug, please report it at https://github.com/ibus/ibus/issues

## SEE ALSO
dconf(1) ibus(5)


ibus

title: ibus(5)

summary: dconf database file for IBus

text:
# ibus(5)

## NAME
IBUS - dconf database file for IBus

## SYNOPSIS
/etc/dconf/db/ibus

## DESCRIPTION
IBus is an Intelligent Input Bus. It is a new input framework for Linux OS. It provides full featured and user friendly input method user interface. It also may help developers to develop input method easily.

/etc/dconf/db/ibus is a database file dconf and saves the IBus default settings. It can be generated from /etc/dconf/db/ibus.d/00-upstream-settings by dconf update command with a write privilege in /etc/dconf/db. The saved keys and values can be readed by dconf command.

```
env DCONF_PROFILE=ibus dconf list /desktop/ibus/
```

```

```

## BUGS
If you find a bug, please report it at https://github.com/ibus/ibus/issues

## SEE ALSO
dconf(1) 00-upstream-settings(5)


icewm-env

package: icewm

title: icewm-env(5)

text:
# icewm-env(5)

### NAME

```
 icewm-env - icewm environment configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/env
 $XDG_CONFIG_HOME/icewm/env
 $HOME/.icewm/env
 /etc/X11/icewm/env
 /usr/share/X11/icewm/env
```

### DESCRIPTION
icewm-session(1) loads additional environment variables from the file env before it does anything else. These variables are then propagated to all other processes, including icewm(1), via their environment.

### FORMAT
Each line is subjected to POSIX shell expansion by wordexp(3). Comment lines starting by a hash-sign ("#") are ignored. icewm-session(1) will load those expanded lines that contain a name, followed by an equals sign, followed by the value (which may be empty).

The word unset begins a line with names to be removed from the environment.

### EXAMPLES

```
 # This is a comment.
 # And another.
 XDG_CURRENT_DESKTOP="ICEWM"
 XDG_MENU_PREFIX="unexicon-"
 START_DATE=`date`
 START_FROM=`pwd`
```

### FILES
icewm-session(1) looks for the env file in the following locations:

```
 $ICEWM_PRIVCFG/env
 $XDG_CONFIG_HOME/icewm/env
 $HOME/.icewm/env
 /etc/X11/icewm/env
 /usr/share/X11/icewm/env
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm(1), icewm-session(1), icewm-startup(5).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


title: icewm-focus_mode(5)

text:
# icewm-focus_mode(5)

### NAME

```
 icewm-focus_mode - icewm focus mode configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/focus_mode
 $XDG_CONFIG_HOME/icewm/focus_mode
 $HOME/.icewm/focus_mode
 /etc/X11/icewm/focus_mode
 /usr/share/X11/icewm/focus_mode
```

### DESCRIPTION
Defines the initial value for "FocusMode". Its default value is "FocusMode=1" (Click-to-focus). This can be changed via the menu. icewm will save the Focus menu choice in this file.

### FORMAT
The file contains a single line containing the preferences assignment for FocusMode.

### EXAMPLES
The following is my focus_mode file:

```
 FocusMode=2
```

### FILES
Locations for the focus_mode file are as follows:

```
 $ICEWM_PRIVCFG/focus_mode
 $XDG_CONFIG_HOME/icewm/focus_mode
 $HOME/.icewm/focus_mode
 /usr/share/X11/icewm/focus_mode
 /usr/local/share/icewm/focus_mode
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm(1), icewm-preferences(5).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


icewm-keys

title: icewm-keys(5)

text:
# icewm-keys(5)

### NAME

```
 icewm-keys - icewm keys configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/keys
 $XDG_CONFIG_HOME/icewm/keys
 $HOME/.icewm/keys
 /etc/X11/icewm/keys
 /usr/share/X11/icewm/keys
```

### DESCRIPTION
The "keys" file defines global keybindings to launch applications. A keybinding has three parts: the word key, a double-quoted string with an X11 key combination and a program with its arguments. These are separated by one or more spaces. Empty lines are allowed. Comment lines start with a hash.

For example, the following defines a hotkey to restart icewm:

```
    key "Ctrl+Shift+r"      icesh restart
```

See the output of "xmodmap -pk" for a list of the many keystroke names you can use in icewm key definitions. Since IceWM version 3.4.0, bindings can not only be defined by their keystroke name, but also by their key label. In addition, the shifted key is now definable as well. For example, the key with + and = can be bound in either of the following four ways, which are identical:

```
    key "Ctrl+Shift+equal"  xterm
    key "Ctrl+Shift+="      xterm
    key "Ctrl+plus"         xterm
    key "Ctrl++"            xterm
```

To bind the mouse, use "Pointer_Button1" for button 1, and so on. This only works when the mouse is over the root window. See below for examples.

Sometimes you may want to start an application just once. For this, use the "runonce" keyword, which accepts an additional resource argument.

The command "icesh keys" instructs icewm to reload this file.

### FORMAT
The syntax of the keys file is as follows:

key "key_combination" program options

Where,

key

The word key begins the definition of a keybinding.

key_combination

A combination of modifiers and a key, like "Ctrl+Alt+Delete". Valid modifiers are Alt, AltGr, Ctrl, Hyper, Meta, Shift, Super. Each modifier must be followed by a single plus-sign. The key is either a keystroke name or a key label. Instead of a key, mouse pointer buttons can be specified by "Pointer_Button1" and up, like "Shift+Pointer_Button3".

program options

program is the name of the executable or its path. It may start with a tilde or an environment variable, which will be expanded. The options are passed as arguments to the program.

runonce

Is an alternative to key. Its syntax is:

runonce "hotkey" "wmclass" program options

Here wmclass is the resource name and/or class. The class must be prefixed by a dot. The program is only run when no other application window with the same wmclass exists. Icewm ignores key repeat events for this hotkey.

switchkey

Is an alternative to key. In this case the program must print on standard output the definition of a dynamic icewm-menu(1). This menu will presented as a popup menu.

### EXAMPLES
Following is the example keys file that ships with icewm(1):

```
    # This is an example for IceWM's hotkey definition file.
    #
    # A list of all valid keyboard symbols can be found in
    # /usr/include/X11/keysymdef.h, XF86keysym.h, ...
    # Omit the XK_ prefixs and replace XF86XK_ prefixes by XF86.
    # Valid modifiers are Alt, AltGr, Ctrl, Shift, Meta, Super, Hyper.
    #
    key "Alt+Ctrl+t" xterm
    key "Alt+Ctrl+b" xdg-open about:blank
    key "Alt+Ctrl+s" xdg-open https://www.google.com
    key "Super+KP_Subtract" amixer sset PCM 5%-
    key "Super+KP_Add" amixer sset PCM 5%+
    # "Multimedia key" bindings for XFree86. Gather the
    # keycodes of your advanced function keys by watching the
    # output of the xev command whilst pressing those keys
    # and map those symbols using xmodmap.
    key "XF86AudioLowerVolume" amixer sset PCM 5%-
    key "XF86AudioRaiseVolume" amixer sset PCM 5%+
    key "XF86AudioMute" amixer sset PCM 0%
    key "XF86HomePage" xdg-open about:blank
    key "XF86Search" xdg-open https://www.google.com
    key "XF86Eject" eject
    # display and select monitor setup configurations
    switchkey "Super+p" icewm-menu-xrandr
    # display and select from all terminals
    switchkey "Super+q"     icesh -Z switchmenu
```

Following shows how to add mouse button bindings on the root window to change the current workspace rolling the mouse wheel on the desktop:

```
    key "Pointer_Button4"   icesh goto prev
    key "Pointer_Button5"   icesh goto next
```

These are key bindings for single window tile operations to replace the KeyWinArrange key bindings from the preferences file:

```
    key "Ctrl+Alt+KP_Home"  icesh -f sizeto 49% 49% top left
    key "Ctrl+Alt+KP_Up"    icesh -f sizeto 100% 49% top left
    key "Ctrl+Alt+KP_Prior" icesh -f sizeto 49% 49% top right
    key "Ctrl+Alt+KP_Right" icesh -f sizeto 49% 100% top right
    key "Ctrl+Alt+KP_Next"  icesh -f sizeto 49% 49% bottom right
    key "Ctrl+Alt+KP_Down"  icesh -f sizeto 100% 49% bottom left
    key "Ctrl+Alt+KP_End"   icesh -f sizeto 49% 49% bottom left
    key "Ctrl+Alt+KP_Left"  icesh -f sizeto 49% 100% top left
    key "Ctrl+Alt+KP_Begin" icesh -f sizeto 49% 49% center
```

### FILES
Locations for the keys file are as follows:

```
 $ICEWM_PRIVCFG/keys
 $XDG_CONFIG_HOME/icewm/keys
 $HOME/.icewm/keys
 /etc/X11/icewm/keys
 /usr/share/X11/icewm/keys
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm(1).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


icewm-menu

title: icewm-menu(5)

text:
# icewm-menu(5)

### NAME

```
 icewm-menu - icewm menu configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/menu
 $XDG_CONFIG_HOME/icewm/menu
 $HOME/.icewm/menu
 /etc/X11/icewm/menu
 /usr/share/X11/icewm/menu
```

### DESCRIPTION
The menu file is responsible for configuring most of the icewm(1) root menu and the start menu.

A menu that gives access to applications; usually customized by the user. The icewm-menu-fdo(1) program generates a default menu that contains most of the systems desktop applications. Similar programs are xdg_menu(1), mmaker(1), xde-menu(1) and xdgmenumaker(1).

### FORMAT
The file contains lines with the following syntax:

prog "title" icon program options

Specifies a program to execute when the menu item is selected.

restart "title" icon program options

Specifies a program to replace the window manager when the menu item is selected. This is for launching other window managers from within icewm(1).

runonce "title" icon "[name][.class]" program options

Specifies a program to execute when the menu item is selected; however, if a window of the specified name and class is present, the program will not be run again.

menu "title" icon { # contained items }

Specifies a sub-menu. The lines that appear between the braces can be any menu item described here.

menufile "title" icon "filename"

Specifies a file from which to collect sub-menu items (lines) and place them at this point in the menu.

menuprog "title" icon program options

Specifies a program that will print sub-menu items on standard output, which will be collected and placed in the sub-menu at this point.

menuprogreload "title" icon timeout program options

Similar to menuprog, but after at least timeout seconds the menu is regenerated.

include "filename"

Read additional entries from the file filename

includeprog program options

Read additional entries from the output of program options.

separator

A separator for menu items.

Where

prog, restart, runonce, menu, menufile, menuprog, menuprogreload, include, includeprog, separator

These are literal string keywords.

"title"

This is the title string associated with the menu item that is displayed in the menu. When the title contains spaces, the title must be surrounded by double quotes ("").

icon

Is the name of the icon file (with or without extension) or the full path to an icon file.

"[name][.class]"

name is the resource name of a window launched by program and class is the resource class of the window. Only one of name or class need be specified. This is used to determine whether the program is already running and is used with the runonce keyword.

program options

program is the name of the executable or full path to the executable file that will be run in response to selecting the menu item. When used with the menuprog keyword, the program must print on standard output the contents of the menu and is used for dynamic menus. options are the options and arguments passed to the program verbatim.

filename

filename is the name of the file relative to one of the icewm(1) configuration directories, or the full path to a file. The file is used with the menufile keyword and specifies the file from which to read further menu items.

### EXAMPLES
Following is the example menu file that ships with icewm(1):

```
 # This is an example for IceWM's menu definition file.
 #
 # Place your variants in /etc/X11/icewm or in $HOME/.icewm
 # since modifications to this file will be discarded when you
 # (re)install icewm.
 #
 prog xterm xterm xterm
 prog rxvt xterm rxvt -bg black -cr green -fg white -C -fn 9x15 -sl 500
 prog fte fte fte
 prog NEdit nedit nedit
 prog Mozilla mozilla mozilla
 prog XChat xchat xchat
 prog Gimp gimp gimp
 separator
 menuprog "Desktop Apps" folder icewm-menu-fdo
 menufile Programs folder programs
 menufile Tool_bar folder toolbar
```

### FILES
Locations for the menu file are as follows:

```
 $ICEWM_PRIVCFG/menu
 $XDG_CONFIG_HOME/icewm/menu
 $HOME/.icewm/menu
 /etc/X11/icewm/menu
 /usr/share/X11/icewm/menu
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm(1), icewm-menu-fdo(1).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


icewm-preferences

title: icewm-preferences(5)

text:
# icewm-preferences(5)

### NAME

```
 icewm-preferences - icewm preferences configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/preferences
 $XDG_CONFIG_HOME/icewm/preferences
 $HOME/.icewm/preferences
 /etc/X11/icewm/preferences
 /usr/share/X11/icewm/preferences
```

### DESCRIPTION
Contains general settings like paths, colors and fonts, but also options to control the icewm focus behaviour and the applets that are started in the task bar. The icewm installation will provide a default preferences file, that can be copied to the icewm user configuration directory and modified.

### FOCUS AND BEHAVIOR
The following preferences affect focus and general behavior of icewm(1):

Alpha=0

Use a 32-bit visual for alpha blending

Synchronize=0

Synchronize X11 for debugging (slow)

LogEvents=0

Enable event logging for debugging

OutputFile=""

Redirect all output to FILE. A leading tilde or environment variable is expanded. This file is truncated on startup if it exceeds 5 KB.

Splash=""

Splash image on startup (IceWM.jpg)

Trace=""

Enable tracing for the given list of modules. Modules that are traceable include conf, font, icon, prog, systray.

ClickToFocus=1

Focus windows by clicking in them.

FocusOnAppRaise=0

Focus windows when applications request that they be raised.

RequestFocusOnAppRaise=1

Request focus (flashing in taskbar) when application requests raise.

RaiseOnFocus=1

Raise windows when focused.

FocusOnClickClient=1

Focus window when client area clicked.

RaiseOnClickClient=1

Raise window when client area clicked.

RaiseOnClickTitleBar=1

Raise window when title bar is clicked.

RaiseOnClickButton=1

Raise window when frame button is clicked.

RaiseOnClickFrame=1

Raise window when frame border is clicked.

LowerOnClickWhenRaised=0

Lower the active window when clicked again.

PassFirstClickToClient=1

Pass focusing click on client area to client.

FocusChangesWorkspace=0

Change to the workspace of newly focused windows.

FocusCurrentWorkspace=0

Move newly focused windows to current workspace.

FocusOnMap=1

Focus normal window when initially mapped.

FocusOnMapTransient=0

Focus dialog window when initially mapped.

FocusOnMapTransientActive=1

Focus dialog window when initially mapped only if parent frame focused.

MapInactiveOnTop=1

Put new windows on top even if not focusing them.

PointerColormap=1

Colormap focus follows pointer.

DontRotateMenuPointer=1

Don't rotate the cursor for popup menus.

LimitSize=1

Limit size of windows to screen.

LimitPosition=1

Limit position of windows to screen.

LimitByDockLayer=0

Let the Dock layer limit the workspace (incompatible with GNOME Panel).

ConsiderHBorder=0

Consider border frames when maximizing horizontally.

ConsiderVBorder=0

Consider border frames when maximizing vertically.

ConsiderSizeHintsMaximized=1

Consider XSizeHints if frame is maximized. Turning this off allows the titlebar to cover the width of the screen.

CenterMaximizedWindows=0

Center maximized windows that can't fit the screen (like terminals).

HideBordersMaximized=0

Hide window borders if window is maximized.

SizeMaximized=0

Maximized windows can be resized.

ShowMoveSizeStatus=1

Show position status window during move/resize.

ShowWorkspaceStatus=1

Show name of current workspace while switching.

MinimizeToDesktop=0

Display mini-icons on desktop for minimized windows.

MiniIconsPlaceHorizontal=0

Place the mini-icons horizontal instead of vertical.

MiniIconsRightToLeft=0

Place new mini-icons from right to left.

MiniIconsBottomToTop=0

Place new mini-icons from bottom to top.

StrongPointerFocus=0

Always maintain focus under mouse window. Makes some keyboard support non-functional or unreliable.

OpaqueMove=1

Opaque window move.

OpaqueResize=1

Opaque window resize.

ManualPlacement=0

Windows initially placed manually by user.

SmartPlacement=1

Smart window placement (minimal overlap).

HideTitleBarWhenMaximized=0

Hide title bar when maximized.

CenterLarge=0

Center large windows.

CenterTransientsOnOwner=1

Center dialogs on owner window.

MenuMouseTracking=0

Menus track mouse even with no mouse buttons held.

AutoRaise=0

Raise windows when the mouse pointer enters, after a delay of AutoRaiseDelay milliseconds. Note that "RaiseOnFocus=1" may interfere.

DelayPointerFocus=1

Delay pointer focusing when mouse moves.

Win95Keys=1

Support the Windows/Super key modifier to activate special functions. The left Super key toggles the Start menu, while the right Super key toggles the Window list window.

ModSuperIsCtrlAlt=0

Treat the Super/Win key modifier as a synonym for the Ctrl+Alt modifier combination. The default key bindings have many occurrences of Ctrl+Alt. If you enable this, then the Super modifier is an alternative way to activate them.

UseMouseWheel=0

Support mouse wheel. When pressing Ctrl+Alt rotating the mouse wheel on the root window will cycle the focus over the windows.

TaskBarTaskGrouping=0

Group applications with the same class name under a single task button. 0 disables it, 1 shows the number of windows, 2 shows bread crumbs, 3 shows a number + bread crumbs.

ShowPopupsAbovePointer=0

Show popup menus above mouse pointer.

ReplayMenuCancelClick=0

Send the clicks outside menus to target window.

ClientWindowMouseActions=1

Allow mouse actions on client windows. This is buggy with some programs.

GrabRootWindow=1

Manage root window (EXPERIMENTAL - normally enabled!).

SnapMove=1

Snap to nearest screen edge/window when moving windows.

SnapDistance=8 [0-64]

Distance in pixels before windows snap together.

ArrangeWindowsOnScreenSizeChange=1

Automatically arrange windows when screen size changes.

AllowFullscreen=1

Allow to switch a window to fullscreen.

FullscreenUseAllMonitors=0

Span over all available screens if window goes into fullscreen.

MsgBoxDefaultAction=0 [0-1]

Preselect to Cancel (0) or the OK (1) button in message boxes.

NetWorkAreaBehaviour=0 [0-2]

NET_WORKAREA behaviour: 0 (single/multi-monitor with STRUT information, like metacity), 1 (always full desktop), 2 (single monitor with STRUT, multi-monitor without STRUT).

### QUICK SWITCH
QuickSwitch=1

Enable Alt+Tab window switching.

QuickSwitchToMinimized=1

Enable Alt+Tab to minimized windows.

QuickSwitchToHidden=1

Enable Alt+Tab to hidden windows.

QuickSwitchToUrgent=1

Prioritize Alt+Tab to urgent windows.

QuickSwitchToAllWorkspaces=0

Include windows from all workspaces in Alt+Tab.

QuickSwitchGroupWorkspaces=1

Group windows by workspace together in Alt+Tab.

QuickSwitchPersistence=0

Time in seconds to remember the state of Alt+Tab.

QuickSwitchPreview=0

Use a QuickSwitch that shows previews of applications.

QuickSwitchRaiseCandidate=0

Raise a selected window while Alt+Tabbing in the QuickSwitch.

QuickSwitchAllIcons=1

Show all reachable icons when quick switching.

QuickSwitchTextFirst=0

Show the window title above (all reachable) icons.

QuickSwitchSmallWindow=0

Create a smaller QuickSwitch window of 1/3 screen width.

QuickSwitchVertical=1

Place the icons and titles vertical instead of horizontal.

QuickSwitchHugeIcon=0

Show the huge (48x48) of the window icon for the active window.

QuickSwitchFillSelection=0

Fill the rectangle highlighting the current icon.

### EDGE SWITCHING
EdgeSwitch=0

Workspace switches by moving mouse to left/right screen edge.

HorizontalEdgeSwitch=0

Workspace switches by moving mouse to left/right screen edge.

VerticalEdgeSwitch=0

Workspace switches by moving mouse to top/bottom screen edge.

ContinuousEdgeSwitch=1

Workspace switches continuously when moving mouse to screen edge.

EdgeResistance=32 [0-10000]

Resistance in pixels when trying to move windows off the screen (10000 = infinite).

### TASK BAR
The following preferences affect the icewm(1) task bar:

ShowTaskBar=1

Show task bar.

TaskBarAtTop=0

Task bar at top of the screen.

TaskBarKeepBelow=0

Keep the task bar below regular windows.

TaskBarAutoHide=0

Auto hide task bar after delay.

TaskBarFullscreenAutoShow=1

Auto show task bar when fullscreen window active.

TaskBarShowClock=1

Show clock on task bar.

TaskBarShowAPMStatus=0

Show battery status monitor on task bar.

TaskBarShowAPMAuto=1

Enable TaskBarShowAPMStatus if a battery is present.

TaskBarShowAPMTime=1

Show battery status on task bar in time-format

TaskBarShowAPMGraph=1

Show battery status in graph mode.

TaskBarShowMailboxStatus=1

Show mailbox status on task bar.

TaskBarMailboxStatusBeepOnNewMail=0

Beep when new mail arrives.

TaskBarMailboxStatusCountMessages=0

Count messages in mailbox.

TaskBarShowWorkspaces=1

Show workspace switching buttons on task bar.

TaskBarShowWindows=1

Show windows on the taskbar.

TaskBarShowShowDesktopButton=1

Show 'show desktop' button on taskbar. If set to 2, it will move the icon to the right side, after the clock.

ShowEllipsis=1

Show Ellipsis in taskbar items.

TaskBarShowTray=1

Show windows in the tray.

TaskBarEnableSystemTray=1

Enable the system tray in the taskbar.

TrayShowAllWindows=1

Show windows from all workspaces on tray.

TaskBarShowTransientWindows=1

Show transient (dialogs, ...) windows on task bar.

TaskBarShowAllWindows=0

Show windows from all workspaces on task bar.

TaskBarShowWindowIcons=1

Show icons of windows on task buttons of the task bar.

TaskBarShowWindowTitles=1

Show titles of windows on task buttons of the task bar.

TaskBarShowStartMenu=1

Show 'Start' menu on task bar.

TaskBarShowWindowListMenu=1

Show 'window list' menu on task bar.

TaskBarShowCPUStatus=1

Show CPU status on task bar (Linux & Solaris).

CPUStatusShowRamUsage=1

Show RAM usage in CPU status tool tip.

CPUStatusShowSwapUsage=1

Show swap usage in CPU status tool tip.

CPUStatusShowAcpiTemp=1

Show ACPI temperature in CPU status tool tip.

CPUStatusShowAcpiTempInGraph=0

Show ACPI temperature in CPU status bar.

CPUStatusShowCpuFreq=1

Show CPU frequency in CPU status tool tip.

NetStatusShowOnlyRunning=0

Show network status only for connected devices, such as an active Ethernet link or associated wireless interface. If false, any network interface that has been brought up will be displayed.

TaskBarShowMEMStatus=1

Show memory usage status on task bar (Linux only).

TaskBarShowNetStatus=1

Show network status on task bar (Linux only).

TaskBarShowCollapseButton=0

Show a button to collapse the taskbar.

TaskBarDoubleHeight=0

Use double-height task bar.

TaskBarWorkspacesLeft=1

Place workspace pager on left, not right.

TaskBarWorkspacesTop=0

Place workspace pager on top row when using dual-height taskbar.

TaskBarWorkspacesLimit=""

Limit the number of taskbar workspaces buttons that are shown on the workspaces pane of the taskbar. If the numeric value has a "p" suffix then the limitation is in pixels. A "%" suffix limits by percentage of desktop width. By default a "B" suffix is assumed for number of buttons.

TaskBarUseMouseWheel=1

Enable mouse wheel cycling over workspaces and task buttons in taskbar.

PagerShowPreview=1

Show a mini desktop preview on each workspace button.

PagerShowWindowIcons=1

Draw window icons inside large enough preview windows on pager (if PagerShowPreview=1).

PagerShowMinimized=1

Draw even minimized windows as unfilled rectangles (if PagerShowPreview=1).

PagerShowBorders=1

Draw border around workspace buttons (if PagerShowPreview=1).

PagerShowLabels=1

Show workspace name label on workspace button (if PagerShowPreview=1)

PagerShowNumbers=1

Show number of workspace on workspace button (if PagerShowPreview=1).

TaskBarLaunchOnSingleClick=1

Execute taskbar applet commands (like MailCommand, ClockCommand, ...) on single click.

EnableAddressBar=1

Enable address bar functionality in taskbar.

ShowAddressBar=1

Show address bar in task bar.

MultiByte=1

Overrides automatic multiple byte detection.

ConfirmLogout=1

Confirm logout.

ShapesProtectClientWindow=1

Don't cut client windows by shapes set trough frame corner pixmap.

XRRDisable=1

Disable use of new XRANDR API for dual head (nvidia workaround).

PreferFreetypeFonts=1

Favour Xft fonts over core X11 fonts where possible.

MailBoxPath=""

A list of paths of your mailboxes separated by spaces. If this is empty, $MAILPATH or $MAIL is used instead. Path to a mbox file. Remote mail boxes are accessed by specifying an URL using the Common Internet Scheme Syntax (RFC 1738):

```
    `scheme://[user[:password]@]server[:port][/path]`.

```

Supported schemes are "pop3", "imap" and "file". When the scheme is omitted file:// is prepended silently. IMAP subfolders can be accessed by using the path component. Reserved characters like slash ("/"), at ("@") and colon (":") can be specified using escape sequences with a hexadecimal encoding like %2f for the slash or %40 for the at sign. For example:

```
    file:///var/spool/mail/captnmark
    pop3://markus:%2f%40%3a@maol.ch/
    imap://mathias@localhost/INBOX.Maillisten.icewm-user

```

NetworkStatusDevice="eth0 wlan0"

Network devices for which to show status.

TimeFormat="%X"

The clock time format. See the strftime manpage for the meaning of all the percent options. It is possible to define multiple clocks for different time zones in a single TimeFormat. A new clock is defined by the beginning of the string, and by each time zone specification that starts with "TZ=...", followed by a space. For example, TimeFormat="%X TZ=Asia/Aden %T TZ=Asia/Baku %T" defines 3 clocks.

TimeFormatAlt=""

Alternate Clock Time format shown every other second.

DateFormat="%c"

Clock Date format for tooltip (strftime format string).

DockApps="right high desktop"

Support DockApps (right, left, center, down, high, above, dock, ontop, normal, below, desktop, or empty to disable). The first five control positioning, while the next six set the layer. Control with Ctrl+Mouse.

XRRPrimaryScreenName=""

Screen/output name of the primary screen.

AcpiIgnoreBatteries=""

List of battery names (directories) in /proc/acpi/battery to ignore. Useful when more slots are built-in, but only one battery is used.

TaskBarCPUSamples=20 [2-1000]

The width of the CPU Monitor applet in pixels.

TaskBarMEMSamples=20 [2-1000]

The width of the Memory Monitor applet in pixels.

TaskBarNetSamples=20 [2-1000]

The width of the Net Monitor applet in pixels.

TaskbarButtonWidthDivisor=3 [1-25]

Default number of tasks in taskbar.

TaskBarWidthPercentage=100 [0-100]

Task bar width as percentage of the screen width.

TaskBarJustify="left"

Taskbar justify left, right or center.

TaskBarApmGraphWidth=10 [1-1000]

Width of battery Monitor.

XineramaPrimaryScreen=0 [0-63]

Primary screen for xinerama (taskbar, ...).

KeyboardLayouts=""

A comma-separated list of keyboard layouts. A layout may be enclosed in double quotes. Each layout is a name with optional arguments, that is to be parsed by the "setxkbmap" program. To support changing keyboard layouts, the "setxkbmap" program must be installed. The first in the list is the default layout. Programs may have their own keyboard layout defined in the winoptions file. The first two letters of a layout are used to locate an icon image file.

### MENUS
AutoReloadMenus=1

Reload menu files automatically.

ShowProgramsMenu=0

Show programs submenu.

ShowSettingsMenu=1

Show settings submenu.

ShowFocusModeMenu=1

Show focus mode submenu.

ShowThemesMenu=1

Show themes submenu.

ShowLogoutMenu=1

Show logout menu.

ShowHelp=1

Show the help menu item.

ShowLogoutSubMenu=1

Show logout submenu.

ShowAbout=1

Show the about menu item.

ShowRun=1

Show the run menu item.

ShowWindowList=1

Show the window menu item.

MenuMaximalWidth=0 [0-16384]

Maximal width of popup menus, 2/3 of the screen's width if set to zero.

NestedThemeMenuMinNumber=25 [0-1234]

Minimal number of themes after which the Themes menu becomes nested (0=disabled).

### TIMINGS
DelayFuzziness=10 (0-100)

Delay fuzziness, to allow merging of multiple timer timeouts into one (notebook power saving).

ClickMotionDistance=4 [0-32]

Pointer motion distance before click gets interpreted as drag.

ClickMotionDelay=200 [0-2000]

Delay before click gets interpreted as drag.

MultiClickTime=400 [0-5000]

Multiple click time.

MenuActivateDelay=40 [0-5000]

Delay before activating menu items.

SubmenuMenuActivateDelay=300 [0-5000]

Delay before activating menu submenus.

ToolTipIcon=1

Show an application icon in toolbar and tray tooltips.

ToolTipDelay=1000 [0-5000]

Delay before tooltip window is displayed.

ToolTipTime=0 [0-60000]

Time before tooltip window is hidden (0 means never).

AutoHideDelay=300 [0-5000]

Delay before task bar is hidden.

AutoShowDelay=500 [0-5000]

Delay before task bar is shown.

AutoRaiseDelay=400 [0-5000]

Delay before windows are auto raised if "AutoRaise=1".

PointerFocusDelay=200 [0-1000]

Delay for pointer focus switching.

EdgeSwitchDelay=600 [0-5000]

Screen edge workspace switching delay.

ScrollBarStartDelay=500 [0-5000]

Initial scroll bar autoscroll delay.

ScrollBarDelay=30 [0-5000]

Scroll bar autoscroll delay.

AutoScrollStartDelay=500 [0-5000]

Auto scroll start delay.

AutoScrollDelay=60 [0-5000]

Auto scroll delay.

WorkspaceStatusTime=2500 [0-2500]

Time before workspace status window is hidden.

MailCheckDelay=30 [0-86400]

Delay between new-mail checks. (seconds).

TaskBarCPUDelay=500 [10-3600000]

Delay between CPU Monitor samples in ms.

TaskBarMEMDelay=500 [10-3600000]

Delay between Memory Monitor samples in ms.

TaskBarNetDelay=500 [10-3600000]

Delay between Net Monitor samples in ms.

FocusRequestFlashTime=0 [0-86400]

Number of seconds the taskbar app will blink when requesting focus (0 = forever).

FocusRequestFlashInterval=250 [0-30000]

Taskbar blink interval (ms) when requesting focus (0 = blinking disabled).

BatteryPollingPeriod=10 [2-3600]

Delay between power status updates (seconds).

PingTimeout=3 [0-86400]

Timeout in seconds for applications to respond to the _NET_WM_PING protocol.

### BUTTONS AND KEYS
UseRootButtons=255 [0-255]

Bitmask of root window button click to use in window manager.

ButtonRaiseMask=1 [0-255]

Bitmask of buttons that raise the window when pressed.

DesktopWinMenuButton=0 [0-20]

Desktop mouse-button click to show the window list menu.

DesktopWinListButton=2 # [0-20]

Desktop mouse-button click to show the window list

DesktopMenuButton=3 [0-20]

Desktop mouse-button click to show the root menu.

TitleBarMaximizeButton=1 [0-5]

Title bar mouse-button double-click to maximize the window to full screen with the frame border visible. Press Shift to maximize only in the vertical direction. Press Alt+Shift to maximize only in the horizontal direction.

TitleBarRollupButton=2 [0-5]

Title bar mouse-button double-click to rollup the window. Press Shift to maximize in the horizontal direction.

### WORKSPACES
WorkspaceNames=" 1 ", " 2 ", " 3 ", " 4 "

Create four workspaces with names 1 , 2 , 3 and 4 .

### PATHS
IconPath="/usr/local/share/icons:/usr/local/share/pixmaps:/usr/share/icons:/usr/share/pixmaps"

Icon search path (colon separated). Also, the icons/ subdirectory in IceWM resource folders are searched first.

IconThemes="*:-HighContrast"

List of icon themes (colon separated), acting as additional filter of icon subdirectories in any of the IconPath folders. Expressions can be wildcards, also special wildcards (starting with -) can exclude matched themes from selection.

MailBoxPath=""

A colon separated list of paths of your mailboxes. If this is empty, $MAILPATH or $MAIL is used instead.

### PROGRAMS
MailCommand="xterm -name mutt -e mutt"

Command to run on mailbox.

MailClassHint="mutt.XTerm"

WM_CLASS to allow runonce for MailCommand.

NewMailCommand=""

Command to run when new mail arrives.

LockCommand=""

Command to lock display/screensaver.

ClockCommand="xclock -name icewm -title Clock"

Command to run on clock.

ClockClassHint="icewm.XClock"

WM_CLASS to allow runonce for ClockCommand.

RunCommand=""

Command to select and run a program.

OpenCommand=""

Command to open a file or directory from the Start menu.

TerminalCommand="xterm"

Terminal emulator must accept -e option.

LogoutCommand=""

Command to start logout.

LogoutCancelCommand=""

Command to cancel logout.

ShutdownCommand="/bin/sh -c "{ test -e /run/systemd/system && systemctl poweroff || loginctl poweroff; }""

Command to shutdown the system.

RebootCommand="/bin/sh -c "{ test -e /run/systemd/system && systemctl reboot || loginctl reboot; }""

Command to reboot the system.

SuspendCommand="test -e /run/systemd/system && systemctl suspend || loginctl suspend"

Command to send the system to standby mode

SuspendCommand="test -e /run/systemd/system && systemctl hibernate || loginctl hibernate"

Command to hibernate the system.

CPUStatusCommand="xterm -name top -title Process\ Status -e top"

Command to run on CPU status.

CPUStatusClassHint="top.XTerm"

WM_CLASS to allow runonce for CPUStatusCommand.

CPUStatusCombine=1 0/1

Combine all CPUs to one.

NetStatusCommand="xterm -name netstat -title 'Network Status' -e netstat -c"

Command to run on Net status.

NetStatusClassHint="netstat.XTerm"

WM_CLASS to allow runonce for NetStatusCommand.

AddressBarCommand=""

Command to run for address bar entries.

InputIgnorePrefix="nohup|(nice[[:space:]]+-n[[:space:]]*[[:digit:]]+)|sudo|(LANG|LC_[[:alnum:]]]*)(=|=[^[:space:]]+)"

Regular expression (POSIX Extended flavor) which marks the begin of a command line in command input fields. Such prefixes are ignored while the auto-completion action is performed, typically for commands acting as pass-through wrapper, executing the specified command.

### WINDOW MENUS
WinMenuItems="rmsnxfhualytiecw"

Items supported in menu window (rmsnxfhualytieckw)

RolloverButtonsSupported=0

Does it support the 'O' title bar button images (for mouse rollover).

ShowMenuButtonIcon=1 # 0/1

Show application icon over menu button

### THEME SETTINGS
The following sections show settings that can be set in theme files. They can also be set in the preferences file, but themes will override the values set there. To override the theme values, the settings should be set in prefoverrides file: see icewm-prefoverrides(5). Default values are shown following the equal sign.

THEME DESCRIPTION

ThemeAuthor=""

Theme author, e-mail address, credits.

ThemeDescription=""

Description of the theme, credits.

Look="nice"

Choose a theme look from one of: "win95", "motif", "warp3", "warp4", "nice", "metal2", "gtk2", and some others.

Gradients=""

List of gradient pixmaps in the current theme.

THEME BORDERS, ICONS, MARGINS AND BUTTONS

BorderSizeX=6 [0-128]

Horizontal window border.

BorderSizeY=6 [0-128]

Vertical window border.

DlgBorderSizeX=2 [0-128]

Horizontal dialog window border.

DlgBorderSizeY=2 [0-128]

Vertical dialog window border.

CornerSizeX=24 [0-64]

Resize corner width.

CornerSizeY=24 [0-64]

Resize corner height.

TitleBarHeight=20 [0-128]

Title bar height.

TitleBarJustify=0 [0-100]

Justification of the window title.

TitleBarHorzOffset=0 [-128-128]

Horizontal offset for the window title text.

TitleBarVertOffset=0 [-128-128]

Vertical offset for the window title text.

MenuButtonIconVertOffset=0 [-128-128]

Vertical offset for the menu button icon.

ScrollBarX=16 [0-64]

Scrollbar width.

ScrollBarY=16 [0-64]

Scrollbar (button) height.

MenuIconSize=16 [8-128]

Menu icon size.

SmallIconSize=16 [8-128]

Dimension of the small icons.

LargeIconSize=32 [8-128]

Dimension of the large icons.

HugeIconSize=48 [8-128]

Dimension of the large icons.

QuickSwitchHorzMargin=3 [0-64]

Horizontal margin of the quickswitch window.

QuickSwitchVertMargin=3 [0-64]

Vertical margin of the quickswitch window.

QuickSwitchIconMargin=4 [0-64]

Vertical margin in the quickswitch window.

QuickSwitchIconBorder=2 [0-64]

Distance between the active icon and it's border.

QuickSwitchSeparatorSize=6 [0-64]

Height of the separator between (all reachable) icons and text, 0 to avoid it.

TitleButtonsLeft="s"

Titlebar buttons from left to right (x=close, m=max, i=min, h=hide, r=rollup, s=sysmenu, d=depth).

TitleButtonsRight="xmir"

Titlebar buttons from right to left (x=close, m=max, i=min, h=hide, r=rollup, s=sysmenu, d=depth).

TitleButtonsSupported="xmis"

Titlebar buttons supported by theme (x,m,i,r,h,s,d).

TitleBarCentered=0 # 0/1

Draw window title centered (obsoleted by TitleBarJustify).

TitleBarJoinLeft=0 # 0/1

Join title*S and title*T.

TitleBarJoinRight=0 # 0/1

Join title*T and title*B.

TaskBarClockLeds=0 # 0/1

Task bar clock/battery monitor uses nice pixmap LCD display (but then it doesn't display correctly in many languages anymore, e.g., for Japanese and Korean it works only when a real font is used and not the LCD pixmaps.)

TaskBarGraphHeight=20 [16-1000]

Height of taskbar monitoring applets.

TaskbuttonIconOffset=0 # [0-16]

Width of taskbutton side icons.

TrayIconMaxWidth=32 # [16-128]

Maximum scaled width of tray icons.

TrayIconMaxHeight=24 # [16-128]

Maximum scaled height of tray icons.

TrayDrawBevel=0 # 0/1

Surround the tray with plastic border.

THEME FONTS

TitleFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

TitleFontNameXft="sans-serif:size=12"

Name of the title bar font.

MenuFontName="-*-sans-bold-r-*-*-*-100-*-*-*-*-*-*"

MenuFontNameXft="sans-serif:size=10:bold"

Name of the menu font.

StatusFontName="-*-monospace-bold-r-*-*-*-120-*-*-*-*-*-*"

StatusFontNameXft="monospace:size=12:bold"

Name of the status display font.

QuickSwitchFontName="-*-monospace-bold-r-*-*-*-120-*-*-*-*-*-*"

QuickSwitchFontNameXft="monospace:size=12:bold"

Name of the font for Alt+Tab switcher window.

NormalButtonFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

NormalButtonFontNameXft="sans-serif:size=12"

Name of the normal button font.

ActiveButtonFontName="-*-sans-bold-r-*-*-*-120-*-*-*-*-*-*"

ActiveButtonFontNameXft="sans-serif:size=12:bold"

Name of the active button font.

NormalTaskBarFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

NormalTaskBarFontNameXft="sans-serif:size=12"

Name of the normal task bar item font.

ActiveTaskBarFontName="-*-sans-bold-r-*-*-*-120-*-*-*-*-*-*"

ActiveTaskBarFontNameXft="sans-serif:size=12:bold"

Name of the active task bar item font.

ToolButtonFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

ToolButtonFontNameXft="sans-serif:size=12"

Name of the tool button font (fallback: NormalButtonFontName).

NormalWorkspaceFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

NormalWorkspaceFontNameXft="sans-serif:size=12"

Name of the normal workspace button font (fallback: NormalButtonFontName).

ActiveWorkspaceFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

ActiveWorkspaceFontNameXft="sans-serif:size=12"

Name of the active workspace button font (fallback: ActiveButtonFontName).

MinimizedWindowFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

MinimizedWindowFontNameXft="sans-serif:size=12"

Name of the mini-window font.

ListBoxFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

ListBoxFontNameXft="sans-serif:size=12"

Name of the window list font.

ToolTipFontName="-*-sans-medium-r-*-*-*-120-*-*-*-*-*-*"

ToolTipFontNameXft="sans-serif:size=12"

Name of the tool tip font.

ClockFontName="-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*"

ClockFontNameXft="monospace:size=12"

Name of the task bar clock font.

TempFontName="-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*"

TempFontNameXft="monospace:size=12"

Name of the task bar temperature font.

ApmFontName="-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*"

ApmFontNameXft="monospace:size=12"

Name of the task bar battery font.

InputFontName="-*-monospace-medium-r-*-*-*-140-*-*-*-*-*-*"

InputFontNameXft="monospace:size=12"

Name of the input field font.

LabelFontName="-*-sans-medium-r-*-*-*-140-*-*-*-*-*-*"

LabelFontNameXft="sans-serif:size=12"

Name of the label font.

THEME COLORS

ColorDialog = "rgb:C0/C0/C0"

Background of dialog windows.

ColorNormalBorder = "rgb:C0/C0/C0"

Border of inactive windows.

ColorActiveBorder = "rgb:C0/C0/C0"

Border of active windows.

ColorNormalButton = "rgb:C0/C0/C0"

Background of regular buttons.

ColorNormalButtonText = "rgb:00/00/00"

Text color of regular buttons.

ColorActiveButton = "rgb:E0/E0/E0"

Background of pressed buttons.

ColorActiveButtonText = "rgb:00/00/00"

Text color of pressed buttons.

ColorNormalTitleButton = "rgb:C0/C0/C0"

Background of titlebar buttons.

ColorNormalTitleButtonText = "rgb:00/00/00"

Text color of titlebar buttons.

ColorToolButton = ""

Background of toolbar buttons, ColorNormalButton is used if empty.

ColorToolButtonText = ""

Text color of toolbar buttons, ColorNormalButtonText is used if empty.

ColorNormalWorkspaceButton = ""

Background of workspace buttons, ColorNormalButton is used if empty.

ColorNormalWorkspaceButtonText = ""

Text color of workspace buttons, ColorNormalButtonText is used if empty.

ColorActiveWorkspaceButton = ""

Background of the active workspace button, ColorActiveButton is used if empty.

ColorActiveWorkspaceButtonText = ""

Text color of the active workspace button, ColorActiveButtonText is used if empty.

ColorNormalTitleBar = "rgb:80/80/80"

Background of the titlebar of regular windows.

ColorNormalTitleBarText = "rgb:00/00/00"

Text color of the titlebar of regular windows.

ColorNormalTitleBarShadow = ""

Text shadow of the titlebar of regular windows.

ColorActiveTitleBar = "rgb:00/00/A0"

Background of the titlebar of active windows.

ColorActiveTitleBarText = "rgb:FF/FF/FF"

Text color of the titlebar of active windows.

ColorActiveTitleBarShadow = ""

Text shadow of the titlebar of active windows.

ColorNormalMinimizedWindow = "rgb:C0/C0/C0"

Background for mini icons of regular windows.

ColorNormalMinimizedWindowText = "rgb:00/00/00"

Text color for mini icons of regular windows.

ColorActiveMinimizedWindow = "rgb:E0/E0/E0"

Background for mini icons of active windows.

ColorActiveMinimizedWindowText = "rgb:00/00/00"

Text color for mini icons of active windows.

ColorNormalMenu = "rgb:C0/C0/C0"

Background of pop-up menus.

ColorNormalMenuItemText = "rgb:00/00/00"

Text color of regular menu items.

ColorActiveMenuItem = "rgb:A0/A0/A0"

Background of selected menu item, leave empty to force transparency.

ColorActiveMenuItemText = "rgb:00/00/00"

Text color of selected menu items.

ColorDisabledMenuItemText = "rgb:80/80/80"

Text color of disabled menu items.

ColorDisabledMenuItemShadow = ""

Shadow of regular menu items.

ColorMoveSizeStatus = "rgb:C0/C0/C0"

Background of move/resize status window.

ColorMoveSizeStatusText = "rgb:00/00/00"

Text color of move/resize status window.

ColorQuickSwitch = "rgb:C0/C0/C0"

Background of the quick switch window.

ColorQuickSwitchText = "rgb:00/00/00"

Text color in the quick switch window.

ColorQuickSwitchActive = ""

Rectangle around the active icon in the quick switch window.

ColorQuickSwitchBorder = ""

The color for the quick switch border. When empty, a one pixel wide elevation border will be drawn, based on the quick switch background.

ColorDefaultTaskBar = "rgb:C0/C0/C0"

Background of the taskbar.

ColorNormalTaskBarApp = "rgb:C0/C0/C0"

Background for task buttons of regular windows.

ColorNormalTaskBarAppText = "rgb:00/00/00"

Text color for task buttons of regular windows.

ColorActiveTaskBarApp = "rgb:E0/E0/E0"

Background for task buttons of the active window.

ColorActiveTaskBarAppText = "rgb:00/00/00"

Text color for task buttons of the active window.

ColorMinimizedTaskBarApp = "rgb:A0/A0/A0"

Background for task buttons of minimized windows.

ColorMinimizedTaskBarAppText = "rgb:00/00/00"

Text color for task buttons of minimized windows.

ColorInvisibleTaskBarApp = "rgb:80/80/80"

Background for task buttons of windows on other workspaces.

ColorInvisibleTaskBarAppText = "rgb:00/00/00"

Text color for task buttons of windows on other workspaces.

ColorScrollBar = "rgb:A0/A0/A0"

Scrollbar background (sliding area).

ColorScrollBarSlider = "rgb:C0/C0/C0"

Background of the slider button in scrollbars.

ColorScrollBarButton = "rgb:C0/C0/C0"

Background of the arrow buttons in scrollbars.

ColorScrollBarArrow = "rgb:C0/C0/C0"

Background of the arrow buttons in scrollbars (obsolete).

ColorScrollBarButtonArrow = "rgb:00/00/00"

Color of active arrows on scrollbar buttons.

ColorScrollBarInactiveArrow = "rgb:80/80/80"

Color of inactive arrows on scrollbar buttons.

ColorListBox = "rgb:C0/C0/C0"

Background of listboxes.

ColorListBoxText = "rgb:00/00/00"

Text color in listboxes.

ColorListBoxSelection = "rgb:80/80/80"

Background of selected listbox items.

ColorListBoxSelectionText = "rgb:00/00/00"

Text color of selected listbox items.

ColorToolTip = "rgb:E0/E0/00"

Background of tooltips.

ColorToolTipText = "rgb:00/00/00"

Text color of tooltips.

ColorLabel = "rgb:C0/C0/C0"

Background of labels, leave empty to force transparency.

ColorLabelText = "rgb:00/00/00"

Text color of labels.

ColorInput = "rgb:FF/FF/FF"

Background of text entry fields (e.g., the addressbar).

ColorInputText = "rgb:00/00/00"

Text color of text entry fields (e.g., the addressbar).

ColorInputSelection = "rgb:80/80/80"

Background of selected text in an entry field.

ColorInputSelectionText = "rgb:00/00/00"

Selected text in an entry field.

ColorClock = "rgb:00/00/00"

Background of non-LCD clock, leave empty to force transparency.

ColorClockText = "rgb:00/FF/00"

Text color of non-LCD clock.

ColorKeyboardLayoutText = ""

Color of keyboard layout indicator.

ColorApm = "rgb:00/00/00"

Background of battery monitor, leave empty to force transparency.

ColorApmText = "rgb:00/FF/00"

Text color of battery monitor.

ColorApmBattery = "rgb:FF/FF/00"

Color of battery monitor when discharging.

ColorApmLine = "rgb:00/FF/00"

Color of battery monitor when charging.

ColorApmGraphBg = "rgb:00/00/00"

Background color for graph mode.

ColorCPUStatusUser = "rgb:00/FF/00"

User load on the CPU monitor.

ColorCPUStatusSystem = "rgb:FF/00/00"

System load on the CPU monitor.

ColorCPUStatusInterrupts = "rgb:FF/FF/00"

Interrupts on the CPU monitor.

ColorCPUStatusIoWait = "rgb:60/00/60"

IO Wait on the CPU monitor.

ColorCPUStatusSoftIrq = "rgb:00/FF/FF"

Soft Interrupts on the CPU monitor.

ColorCPUStatusNice = "rgb:00/00/FF"

Nice load on the CPU monitor.

ColorCPUStatusIdle = "rgb:00/00/00"

Idle (non) load on the CPU monitor, leave empty to force transparency.

ColorCPUStatusSteal = "rgb:FF/8A/91"

Involuntary Wait on the CPU monitor.

ColorCPUStatusTemp = "rgb:60/60/C0"

Temperature of the CPU.

ColorMEMStatusUser = "rgb:40/40/80"

User program usage in the memory monitor.

ColorMEMStatusBuffers = "rgb:60/60/C0"

OS buffers usage in the memory monitor.

ColorMEMStatusCached = "rgb:80/80/FF"

OS cached usage in the memory monitor.

ColorMEMStatusFree = "rgb:00/00/00"

Free memory in the memory monitor.

ColorNetSend = "rgb:FF/FF/00"

Outgoing load on the network monitor.

ColorNetReceive = "rgb:FF/00/FF"

Incoming load on the network monitor.

ColorNetIdle = "rgb:00/00/00"

Idle (non) load on the network monitor, leave empty to force transparency.

DESKTOP BACKGROUND

The following themeable preferences are read by icewmbg(1):

DesktopBackgroundCenter=0 0/1

Display desktop background centered and not tiled.

DesktopBackgroundScaled=0 0/1

Resize desktop background to full screen.

DesktopBackgroundColor=""

A comma-separated list of zero or more desktop background colors.

DesktopBackgroundImage=""

A comma-separated list of zero or more desktop background images. Each image may be a path with a glob(7) pattern, or start with a tilde or environment variable.

ShuffleBackgroundImages=0 0/1

Choose a random selection from the list of background images.

SupportSemitransparency=1 0/1

Support for semitransparent terminals like Eterm or gnome-terminal.

DesktopTransparencyColor=""

Color(s) to announce for semitransparent windows.

DesktopTransparencyImage=""

Image(s) to announce for semitransparent windows. This is a list similar to DesktopBackgroundImage.

DesktopBackgroundMultihead=0 0/1

Paint the background image over all multihead monitors combined.

CycleBackgroundsPeriod=0

Seconds between cycling over all background images, default zero is off.

### EXAMPLES

```
    Alpha=1
    Splash="IceWM.jpg"
    LimitSize=0
    LimitPosition=0
    LimitByDockLayer=1
    QuickSwitchToAllWorkspaces=1
    QuickSwitchHugeIcon=1
    QuickSwitchFillSelection=1
    TaskBarMailboxStatusBeepOnNewMail=1
    TaskBarMailboxStatusCountMessages=1
    TaskBarShowMEMStatus=0
    TaskBarShowCollapseButton=1
    TaskBarWorkspacesLimit="8"
    ShowProgramsMenu=1
    ShowAddressBar=0
    ToolTipDelay=200
    ToolTipTime=5000
    AutoHideDelay=900
    AutoShowDelay=100
    EdgeResistance=3
    KeySysWinMenu=""
    KeySysWinListMenu="Shift+Ctrl+Esc"
```

The above example shows how to tell icewm to not bind a specific key: KeySysWinMenu in this case.

### FILES
Locations for the preferences file are as follows:

```
 $ICEWM_PRIVCFG/preferences
 $XDG_CONFIG_HOME/icewm/preferences
 $HOME/.icewm/preferences
 /etc/X11/icewm/preferences
 /usr/share/X11/icewm/preferences
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm(1), icewm-prefoverride(5).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


icewm-prefoverride

title: icewm-prefoverride(5)

text:
# icewm-prefoverride(5)

### NAME

```
 icewm-prefoverride - override themable preferences file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/prefoverride
 $XDG_CONFIG_HOME/icewm/prefoverride
 $HOME/.icewm/prefoverride
 /etc/X11/icewm/prefoverride
 /usr/share/X11/icewm/prefoverride
```

### DESCRIPTION
Settings that override the settings from a theme. Some of the icewm preferences that control the look may be set by the theme. However, the settings in this prefoverride file override that. It is safe to leave this file empty initially. Note that this file is meant for themable preferences and a few icewm startup settings cannot be set here, like "Splash".

### FILES
Locations for the prefoverride file are as follows:

```
 $ICEWM_PRIVCFG/prefoverride
 $XDG_CONFIG_HOME/icewm/prefoverride
 $HOME/.icewm/prefoverride
 /etc/X11/icewm/prefoverride
 /usr/share/X11/icewm/prefoverride
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm(1), icewm-preferences(5).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


icewm-programs

title: icewm-programs(5)

text:
# icewm-programs(5)

### NAME

```
 icewm-programs - icewm programs configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/programs
 $XDG_CONFIG_HOME/icewm/programs
 $HOME/.icewm/programs
 /etc/X11/icewm/programs
 /usr/share/X11/icewm/programs
```

### DESCRIPTION
The programs file is an automatically generated menu configuration file of installed programs. This file should be automatically generated by xdg_menu, wmconfig (Redhat), menu (Debian), or icewm-menu-fdo, perhaps as part of the login or X startup sequence.

### FORMAT
The format of the file contains one of the following line syntax:

prog "title" icon program options

Specifies a program to execute when the menu item is selected.

restart "title" icon program options

Specifies a program to replace the window manager when the menu item is selected. This is for launching other window managers from within icewm(1).

runonce "title" icon "[name][.class]" program options

Specifies a program to execute when the menu item is selected; however, if a window of the specified name and class is present, the program will not be run again.

menu "title" icon { # contained items }

Specifies a sub-menu. The lines that appear between the braces can be any menu item described here.

menufile "title" icon "filename"

Specifies a file from which to collect sub-menu items (lines) and place them at this point in the menu.

menuprog "title" icon program options

Specifies a program that will print sub-menu items on standard output and will be collected and placed in the sub-menu at this point.

menuprogreload "title" icon timeout program options

Similar to menuprog, but after at least timeout seconds the menu is regenerated.

include "filename"

Read additional entries from the file filename

includeprog program options

Read additional entries from the output of program options.

separator

A separator for menu items.

Where

prog, restart, runonce, menu, menufile, menuprog, menuprogreload, include, includeprog, separator

These are literal string keywords.

"title"

This is the title string associated with the menu item that is displayed in the menu. When the title contains spaces, the title must be surrounded by double quotes (""").

icon

Is the name of the icon file (with or without extension) or the full path to an icon file.

"[name][.class]"

name is the resource name of a window launched by program and class is the resource class of the window. Only one of name or class need be specified. This is used to determine whether the program is already running. It is used with the runonce keyword.

program options

program is the name of the executable or full path to the executable file that will be run in response to selecting the menu item. When used with the menuprog keyword, the program must print on standard output the contents of the menu and is used for dynamic menus. options is the options and arguments passed to the program verbatim.

filename

filename is the name of the file relative to one of the icewm(1) configuration directories, or the full path to a file. The file is used with the menufile keyword and specifies the file from which to read further menu items.

### EXAMPLES
Following is the example programs file that ships with icewm(1):

```
 # This file is intended to be customized by the distributions.
 # (they should place it in /etc/X11/icewm)
 #
 # mostly obsolete, fixme
 menu Editors folder {
     prog vim vim gvim
     prog emacs emacs emacs
     prog Lyx emacs lyx
 }
 menu "WWW" folder {
     prog Galeon galeon galeon
     prog Arena arena arena
     prog Lynx lynx xterm -e lynx
     prog Links lynx xterm -e links
 }
 menu "Document Viewers" folder {
     prog "DVI Previewer" xdvi xdvi
     prog "Ghostview" ghostview gv
 }
 menu Graphics folder {
     prog Gimp gimp gimp
     prog XV xv xv
     prog XPaint xpaint xpaint
     prog XFig xfig xfig
 }
 menu Games folder {
     prog Xboard xboard xboard
     prog "Tux Racer" tuxracer tuxracer
 }
 menu System folder {
     prog "Control Panel" redhat control-panel
 }
 menu Utilities folder {
     prog XPlayCD xplaycd xplaycd
     prog XMixer xmixer xmixer
     prog Clock xclock xclock
     prog Magnify xmag xmag
     prog Calculator xcalc xcalc
     prog Colormap xcolormap xcmap
     prog Clipboard xclipboard xclipboard
     prog xkill bomb xkill
     prog xload xload xload
     prog xosview xosview xosview
     separator
     prog "Screen Saver" xlock xlock -nolock
     prog "Screen Lock" xlock xlock
 }
 menu "Window Managers" folder {
     restart icewm - icewm
     restart metacity - metacity
     restart wmaker - wmaker
     restart fluxbox - fluxbox
     restart blackbox - blackbox
     restart enlightenment - enlightenment
     restart fvwm2 - fvwm2
     restart fvwm - fvwm
     restart sawfish - sawfish
     restart sawfish2 - sawfish2
 }
```

### FILES
Locations for the programs file are as follows:

```
 $ICEWM_PRIVCFG/programs
 $XDG_CONFIG_HOME/icewm/programs
 $HOME/.icewm/programs
 /etc/X11/icewm/programs
 /usr/share/X11/icewm/programs
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm(1), icewm-menu(5), icewm-menu-fdo(1).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


icewm-shutdown

title: icewm-shutdown(5)

text:
# icewm-shutdown(5)

### NAME

```
 icewm-shutdown - icewm shutdown configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/shutdown
 $XDG_CONFIG_HOME/icewm/shutdown
 $HOME/.icewm/shutdown
 /etc/X11/icewm/shutdown
 /usr/share/X11/icewm/shutdown
```

### DESCRIPTION
Contains commands to be executed on icewm shutdown. This is an executable script with commands to be executed in the last stage of icewm termination. Typically they may undo some of the effects of the startup script. It is run by icewm-session(1) when icewm terminates.

### FILES
Locations for the shutdown file are as follows:

```
 $ICEWM_PRIVCFG/shutdown
 $XDG_CONFIG_HOME/icewm/shutdown
 $HOME/.icewm/shutdown
 /etc/X11/icewm/shutdown
 /usr/share/X11/icewm/shutdown
```

The locations are searched in the order listed; the first file found is read and the remainder ignored.

### SEE ALSO
icewm-session(1), icewm-startup(5).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.


icewm-startup

title: icewm-startup(5)

text:
# icewm-startup(5)

### NAME

```
 icewm-startup - icewm startup configuration file
```

### SYNOPSIS

```
 $ICEWM_PRIVCFG/startup
 $XDG_CONFIG_HOME/icewm/startup
 $HOME/.icewm/startup
 /etc/X11/icewm/startup
 /usr/share/X11/icewm/startup
```

### DESCRIPTION
The startup file contains commands to be executed on icewm startup. This is an executable script. Typically the commands tweak X11 settings and launch some applications that always need to be active. It is run by icewm-session(1) when icewm starts.

### EXAMPLES

```
 #!/bin/bash
 xset r rate 250 32
 flameshot &
 volumeicon &
 redshift-gtk &
 picom -b
```

Remember to "chmod +x ~/.icewm/startup". The first line must be a hash-bang, followed by the path of your script interpreter or shell.

### FILES
Locations for the startup file are as follows:

```
 $ICEWM_PRIVCFG/startup
 $XDG_CONFIG_HOME/icewm/startup
 $HOME/.icewm/startup
 /etc/X11/icewm/startup
 /usr/share/X11/icewm/startup
```

The locations are searched in the order listed; the first file found is executed and the remainder ignored.

### SEE ALSO
icewm-session(1), icewm-shutdown(5).

### AUTHOR
Brian Bidulock <mailto:bidulock@openss7.org>.

### LICENSE
IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.