---
name: "WordKeyInfo"
section: "3"
platform: "linux"
package: "libmifluz0-dev"
version: "0.24.0-9"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://carta.tech/man/WordKeyInfo"
---

# WordKeyInfo(3)

information on the key structure of the inverted index.

## NAME

WordKeyInfo - information on the key structure of the inverted index.

## SYNOPSIS

```
Helper for the WordKey class.
```

## DESCRIPTION

Describe the structure of the index key ( *WordKey* ). The description includes the layout of the packed version stored on disk.

## CONFIGURATION

For more information on the configuration attributes and a complete list of attributes, see the [mifluz(3)](/man/mifluz/3.md) manual page.

- **wordlist\_wordkey\_description \<desc\> (no default)**

  Describe the structure of the inverted index key. In the following explanation of the *\<desc\>* format, mandatory words are in bold and values that must be replaced in italic.

  **Word** *bits/name bits* \[/...\]

  The *name* is an alphanumerical symbolic name for the key field. The *bits* is the number of bits required to store this field. Note that all values are stored in unsigned integers (unsigned int). Example:

  ```
  Word 8/Document 16/Location 8
  ```

## AUTHORS

Loic Dachary loic@gnu.org

The Ht://Dig group http://dev.htdig.org/

## SEE ALSO

[htdb\_dump(1)](/man/htdb_dump/1.md), [htdb\_stat(1)](/man/htdb_stat/1.md), [htdb\_load(1)](/man/htdb_load/1.md), [mifluzdump(1)](/man/mifluzdump/1.md), [mifluzload(1)](/man/mifluzload/1.md), [mifluzsearch(1)](/man/mifluzsearch/1.md), [mifluzdict(1)](/man/mifluzdict/1.md), [WordContext(3)](/man/WordContext/3.md), [WordList(3)](/man/WordList/3.md), [WordDict(3)](/man/WordDict/3.md), [WordListOne(3)](/man/WordListOne/3.md), [WordKey(3)](/man/WordKey/3.md), [WordType(3)](/man/WordType/3.md), [WordDBInfo(3)](/man/WordDBInfo/3.md), [WordRecordInfo(3)](/man/WordRecordInfo/3.md), [WordRecord(3)](/man/WordRecord/3.md), [WordReference(3)](/man/WordReference/3.md), [WordCursor(3)](/man/WordCursor/3.md), [WordCursorOne(3)](/man/WordCursorOne/3.md), [WordMonitor(3)](/man/WordMonitor/3.md), [Configuration(3)](/man/Configuration/3.md), [mifluz(3)](/man/mifluz/3.md)