{
    "content": [
        {
            "type": "text",
            "text": "# indxbib (info)\n\n## NAME\n\nindxbib - make inverted index for bibliographic databases\n\n## SYNOPSIS\n\nindxbib [-w] [-c file] [-d dir] [-f file] [-h n] [-i string] [-k n]\n[-l n] [-n n] [-o file] [-t n] [filename ...]\nindxbib --help\nindxbib -v\nindxbib --version\n\n## DESCRIPTION\n\nindxbib makes an inverted index  for  the  bibliographic  databases  in\nfilename...   for use with refer(1), lookbib(1), and lkbib(1).  The in-\ndex will be named filename.i; the index is written to a temporary  file\nwhich  is  then renamed to this.  If no filenames are given on the com-\nmand line because the -f option has been used,  and  no  -o  option  is\ngiven, the index will be named Ind.i.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (2 subsections)\n- **FILES**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "indxbib",
        "section": "",
        "mode": "info",
        "summary": "indxbib - make inverted index for bibliographic databases",
        "synopsis": "indxbib [-w] [-c file] [-d dir] [-f file] [-h n] [-i string] [-k n]\n[-l n] [-n n] [-o file] [-t n] [filename ...]\nindxbib --help\nindxbib -v\nindxbib --version",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "Don't index the contents of fields whose names are in string. Initially string is XYZ. -hn Use the first prime greater than or equal to n for the size of the hash table. Larger values of n will usually make searching faster, but will make the index larger and indxbib use more mem- ory. Initially n is 997. -kn Use at most n keys per input record. Initially n is 100. -ln Discard keys that are shorter than n. Initially n is 3. -nn Discard the n most common words. Initially n is 100."
            },
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "The index should be named basename.i. -tn Truncate keys to n. Initially n is 6."
            }
        ],
        "examples": [],
        "see_also": [
            {
                "name": "refer",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/refer/1/json"
            },
            {
                "name": "lkbib",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/lkbib/1/json"
            },
            {
                "name": "lookbib",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/lookbib/1/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 24,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 18,
                "subsections": [
                    {
                        "name": "-istring",
                        "lines": 14
                    },
                    {
                        "name": "-obasename",
                        "lines": 4
                    }
                ]
            },
            {
                "name": "FILES",
                "lines": 11,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "indxbib - make inverted index for bibliographic databases\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "indxbib [-w] [-c file] [-d dir] [-f file] [-h n] [-i string] [-k n]\n[-l n] [-n n] [-o file] [-t n] [filename ...]\n\nindxbib --help\n\nindxbib -v\nindxbib --version\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "indxbib makes an inverted index  for  the  bibliographic  databases  in\nfilename...   for use with refer(1), lookbib(1), and lkbib(1).  The in-\ndex will be named filename.i; the index is written to a temporary  file\nwhich  is  then renamed to this.  If no filenames are given on the com-\nmand line because the -f option has been used,  and  no  -o  option  is\ngiven, the index will be named Ind.i.\n\nBibliographic  databases  are  divided  into  records  by  blank lines.\nWithin a record, each fields starts with a % character at the beginning\nof  a  line.  Fields have a one letter name which follows the % charac-\nter.\n\nThe values set by the -c, -n, -l, and -t options are stored in the  in-\ndex;  when  the index is searched, keys will be discarded and truncated\nin a manner appropriate to these options; the  original  keys  will  be\nused  for verifying that any record found using the index actually con-\ntains the keys.  This means that a user  of  an  index  need  not  know\nwhether  these options were used in the creation of the index, provided\nthat not all the keys to be searched for would have been discarded dur-\ning  indexing  and that the user supplies at least the part of each key\nthat would have remained after being truncated  during  indexing.   The\nvalue set by the -i option is also stored in the index and will be used\nin verifying records found using the index.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "Whitespace is permitted between a command-line option and its argument.\n\n-v     Print the version number.\n\n-w     Index whole files.  Each file is a separate record.\n\n-cfile Read the list of common words from file instead  of  /usr/share/\ngroff/1.22.4/eign.\n\n-ddir  Use  dir  as  the  pathname  of the current working directory to\nstore in the index, instead of the path printed by pwd(1).  Usu-\nally  dir  will  be a symbolic link that points to the directory\nprinted by pwd(1).\n\n-ffile Read the files to be indexed from file.  If  file  is  -,  files\nwill  be  read  from  the  standard input.  The -f option can be\ngiven at most once.\n",
                "subsections": [
                    {
                        "name": "-istring",
                        "content": "Don't index the contents of fields whose names  are  in  string.\nInitially string is XYZ.\n\n-hn    Use  the  first prime greater than or equal to n for the size of\nthe hash table.  Larger values of n will usually make  searching\nfaster, but will make the index larger and indxbib use more mem-\nory.  Initially n is 997.\n\n-kn    Use at most n keys per input record.  Initially n is 100.\n\n-ln    Discard keys that are shorter than n.  Initially n is 3.\n\n-nn    Discard the n most common words.  Initially n is 100.\n"
                    },
                    {
                        "name": "-obasename",
                        "content": "The index should be named basename.i.\n\n-tn    Truncate keys to n.  Initially n is 6.\n"
                    }
                ]
            },
            "FILES": {
                "content": "filename.i\nIndex.\n\nInd.i  Default index name.\n\n/usr/share/groff/1.22.4/eign\nList of common words.\n\nindxbibXXXXXX\nTemporary file.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "refer(1), lkbib(1), lookbib(1)\n\ngroff 1.22.4                     23 March 2022                      INDXBIB(1)",
                "subsections": []
            }
        }
    }
}