{
    "content": [
        {
            "type": "text",
            "text": "# ispell-autobuildhash(8) (man)\n\n**Summary:** ispell-autobuildhash - Autobuilding the ispell hash file for some dicts\n\n**Synopsis:** ispell-autobuildhash [--force]\nOptions:\n--debug      Show some extra ispell-autobuildhash information.\n--dry-run    Show what would be done, but do nothing real.\n--force      Rebuild the hash file for all dicts providing a\ncompat file skipping the test.\n--triggered  Tell the script that is run in the triggers stage.\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (9 lines)\n- **DESCRIPTION** (6 lines)\n- **OPTIONS** (11 lines)\n- **PACKAGE MAINTAINERS** (47 lines)\n- **AUTHOR** (2 lines)\n- **COPYRIGHT** (9 lines)\n\n## Full Content\n\n### NAME\n\nispell-autobuildhash - Autobuilding the ispell hash file for some dicts\n\n### SYNOPSIS\n\nispell-autobuildhash [--force]\n\nOptions:\n--debug      Show some extra ispell-autobuildhash information.\n--dry-run    Show what would be done, but do nothing real.\n--force      Rebuild the hash file for all dicts providing a\ncompat file skipping the test.\n--triggered  Tell the script that is run in the triggers stage.\n\n### DESCRIPTION\n\nispell-autobuildhash is a script that will manage ispell hash files autobuild, intended to be\ncalled from the dictionaries-common tools.  Depending on the ispell compatibility level and\non the compatibility level used for the hash file if present, will decide whether it must be\nrebuilt or not. This script will only work on ispell packages prepared to use it, it will do\nnothing for other ispell dict packages.\n\n### OPTIONS\n\n--debug      Show some extra ispell-autobuildhash information.\n--dry-run    Show what would be done, but do nothing real.\n--force      Rebuild the hash file for all dicts providing a compat\nfile regardless of the compatibility levels found.\n--triggered  Tell the script that is run in the triggers stage. When\nrun under dpkg control, do not try to set the\n'ispell-autobuildhash' trigger, but run real\nB<ispell-autobuildhash> code. When not run under dpkg\ncontrol, real code will always be run and '--triggered'\noption has no real effect.\n\n### PACKAGE MAINTAINERS\n\nTo use this system, ispell-autobuildhash expects a $dict.compat file in /var/lib/ispell\n($dict stands for the hash or affix file basename) containing ispell major or compatibility\nversion for last successful build or \"0\" or en empty file if hash is to be rebuild, as is for\ndictionary installation and upgrades.\n\nWhen upgrading ispell, script will check if version in $dict.compat is different from\nispell.compat and rebuild if so, updating $dict.compat with the new value. The particular way\nthings are done depends on whether your dict has a single source or a multiple source like\nipolish has.\n\nThe most common case is having a single source. In this case you must put the $dict.aff file\nat /usr/lib/ispell/$dict.aff as usual and the munched wordlist compressed with gzip at\n/usr/share/ispell/$dict.mwl.gz.\n\nThis script supports the way ipolish allows selection of subdictionaries to be put in the\nhash file. It will detect the presence of  the main language .desc file and call update-\nipolish-hash as appropriate.\n\nAlthough this script looks for the existence of a update-ispell-hash script with supposedly\nsimilar functionality to update-ipolish-hash, this latter does not really exists, although it\nmight be added at some time to ispell or to the dictionaries-common system, if enough demand\nis found.\n\nIf your package provides more than one ispell dictionary you will need to do the steps above\nfor each dictionary.\n\nDictionaries-common scripts will call internally this script and create a hash file at\n/var/lib/ispell/$dict.hash. You must set a symlink to that file from\n/usr/lib/ispell/$dict.hash.\n\nIspell dictionary packages using this script must make sure that $dict.compat is reset on\nevery new install/upgrade, so hash is rebuilt.  They must also make sure that $dict.compat\nand /var/lib/ispell/$dict.hash are removed on package removal\n\nAs of version 1.10, installdeb-ispell script will understand 'auto-compat' field in\n$dict.info-ispell file to help with this by adding needed debhelper snippets. Put in that\nentry the base name(s) of your compat file(s) and check resulting maintainer scripts after\nbuild.\n\nNote that you are no longer suggested to ship empty files at /var/lib/ispell/$dict.compat and\n/var/lib/ispell/$dict.hash to help with reset/removal of those files, but explicitly\ncreate/update them on install and explicitly remove them on removal.\n\nispell maintainer should also call this script from package postinst.  When comparing\nversions it will get the ispell version from file /usr/share/ispell/ispell.compat, or if it\ndoes not exists, from the upstream version as given in the first line of 'ispell -vv output.\n\n### AUTHOR\n\nAgustin Martin <agmartin@debian.org>\n\n### COPYRIGHT\n\nCopyright (C) 2003-2013 Agustin Martin <agmartin@debian.org>\n\nThis program is free software; you can redistribute it and/or modify it under the terms of\nthe GNU General Public License as published by the Free Software Foundation; either version 3\nof the License, or (at your option) any later version.\n\n\n\n1.28.14                                      2021-12-02                      ISPELL-AUTOBUILDHASH(8)\n\n"
        }
    ],
    "structuredContent": {
        "command": "ispell-autobuildhash",
        "section": "8",
        "mode": "man",
        "summary": "ispell-autobuildhash - Autobuilding the ispell hash file for some dicts",
        "synopsis": "ispell-autobuildhash [--force]\nOptions:\n--debug      Show some extra ispell-autobuildhash information.\n--dry-run    Show what would be done, but do nothing real.\n--force      Rebuild the hash file for all dicts providing a\ncompat file skipping the test.\n--triggered  Tell the script that is run in the triggers stage.",
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 11,
                "subsections": []
            },
            {
                "name": "PACKAGE MAINTAINERS",
                "lines": 47,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 9,
                "subsections": []
            }
        ]
    }
}