{ "content": [ { "type": "text", "text": "# HISHRINK (man)\n\n## NAME\n\nhishrink- translating ASCII HINT files to binary files\n\n## SYNOPSIS\n\nhishrink [options] [file]\n\n## DESCRIPTION\n\nShrinking converts an ASCII HINT file, usually with the extension .hint, into a binary HINT\nfile, with the extension .hnt.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (7 subsections)\n- **FILES**\n- **NOTES**\n- **AVAILABILITY**\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "HISHRINK", "section": "", "mode": "man", "summary": "hishrink- translating ASCII HINT files to binary files", "synopsis": "hishrink [options] [file]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-a", "long": null, "arg": null, "description": "low. If you know that the auxiliary files can be found using the localized names, for exam‐ ple after creating them with histretch using the -a option, you can use hishrink with the -a option to limit the search for the auxiliar files. If you are unsure, you should use neither the -a nor the -g option. hishrink will then search for auxiliar files first using the localized path names and then using the path names as given." }, { "flag": "-c", "long": null, "arg": null, "description": "quire decompression when viewing. Use only for large files if the file size matters." }, { "flag": "-d", "long": null, "arg": null, "description": "Sets HINT file debugging flags according to the bitmask. Use the --help option for details." }, { "flag": "-g", "long": null, "arg": null, "description": "below. You may use this option if you know that all auxiliar files are at the locations de‐ scribed by the path names stored in the HINT file. If you are unsure, you should use neither the -g nor the -a option. hishrink will then search for auxiliar files first using the localized path names and then using the path names as given. --help Print help message and exit." }, { "flag": "-l", "long": null, "arg": null, "description": "name of the input file replacing the extension .hint by the extension .log." }, { "flag": "-o", "long": null, "arg": null, "description": "Use name for the output file instead of deriving it from the name of the input file. Append the extension .hnt if the name does not already has that extension." }, { "flag": "", "long": "--version", "arg": null, "description": "Print version information and exit." } ], "examples": [], "see_also": [ { "name": "histretch", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/histretch/1/json" }, { "name": "hitex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/hitex/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 16, "subsections": [] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "-a", "lines": 8, "flag": "-a" }, { "name": "-c", "lines": 2, "flag": "-c" }, { "name": "-d _", "lines": 3, "flag": "-d" }, { "name": "-g", "lines": 9, "flag": "-g" }, { "name": "-l", "lines": 2, "flag": "-l" }, { "name": "-o _", "lines": 3, "flag": "-o" }, { "name": "--version", "lines": 2, "long": "--version" } ] }, { "name": "FILES", "lines": 25, "subsections": [] }, { "name": "NOTES", "lines": 5, "subsections": [] }, { "name": "AVAILABILITY", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "AUTHORS", "lines": 3, "subsections": [] } ], "sections": { "NAME": { "content": "hishrink- translating ASCII HINT files to binary files\n", "subsections": [] }, "SYNOPSIS": { "content": "hishrink [options] [file]\n", "subsections": [] }, "DESCRIPTION": { "content": "Shrinking converts an ASCII HINT file, usually with the extension .hint, into a binary HINT\nfile, with the extension .hnt.\n\nThe ASCII based HINT file format - also called `long' format - is optimized for readability.\nIt can be edited using a text editor. Hence it allows simple modifications that would be dif‐\nficult to achieve when using the binary format. It is also convenient when debugging.\n\nThe binary HINT file format - also called `short' format - is optimized for displaying HINT\nfiles. It can be parsed equally well in forward and backward direction to enable fast forward\nor backward navigation in the file.\n\nThe binary HINT file format is designed for on-screen reading of documents. Using a HINT\nviewer to display a HINT file, its content will dynamically adapt to the available display\narea. For complete information on the HINT file format and programs to view HINT files, see\nhttps://hint.userweb.mwn.de.\n", "subsections": [] }, "OPTIONS": { "content": "This version of hishrink understands the following command line options:\n", "subsections": [ { "name": "-a", "content": "low.\n\nIf you know that the auxiliary files can be found using the localized names, for exam‐\nple after creating them with histretch using the -a option, you can use hishrink with\nthe -a option to limit the search for the auxiliar files. If you are unsure, you\nshould use neither the -a nor the -g option. hishrink will then search for auxiliar\nfiles first using the localized path names and then using the path names as given.\n", "flag": "-a" }, { "name": "-c", "content": "quire decompression when viewing. Use only for large files if the file size matters.\n", "flag": "-c" }, { "name": "-d _", "content": "Sets HINT file debugging flags according to the bitmask. Use the --help option for\ndetails.\n", "flag": "-d" }, { "name": "-g", "content": "below.\n\nYou may use this option if you know that all auxiliar files are at the locations de‐\nscribed by the path names stored in the HINT file. If you are unsure, you should use\nneither the -g nor the -a option. hishrink will then search for auxiliar files first\nusing the localized path names and then using the path names as given.\n\n--help Print help message and exit.\n", "flag": "-g" }, { "name": "-l", "content": "name of the input file replacing the extension .hint by the extension .log.\n", "flag": "-l" }, { "name": "-o _", "content": "Use name for the output file instead of deriving it from the name of the input file.\nAppend the extension .hnt if the name does not already has that extension.\n", "flag": "-o" }, { "name": "--version", "content": "Print version information and exit.\n", "long": "--version" } ] }, "FILES": { "content": "Binary HINT files must contain all resources necessary to display the file, for example font\nand image files. These files are called auxiliary files. ASCII HINT files contain only the\npath names of these files.\n\nWhen creating a binary HINT file from an ASCII HINT file, it is necessary to find these\nfiles, read them, and include them in the binary output file. When creating an ASCII HINT\nfile from a binary HINT file, it is convenient if these files can be extracted and written to\nthe file system. To avoid clobbering arbitrary directories with files when extracting auxil‐\niary files, it is possible to map the path names as stored in the HINT file to localized path\nnames before writing or reading auxiliar files.\n\nWhen computing a localized path name from a given path name, a distinction is made between\nglobal resources, like fonts, that are referenced by an absolute path name, and local re‐\nsources, for example an image, that are referenced by a relative path name. The directory\nthat starts the localized path name of the former has the extension .abs and for the latter\nthe extension .rel is used. To keep auxiliary files in these subdirectories even if their\npath contains links to a parent directory, parent links `..' are replaced by `' links to\nsubdirectories.\n\nFor example, given an input file paper.hint, the global resources are stored in the paper.abs\ndirectory and local resources are stored in paper.rel. An absolute path like\n/usr/share/fonts/ will then map to the localized path paper.abs/usr/share/fonts/ and a rela‐\ntive path like ../image/img1.jpg will then map to the localized path paper.rel//im‐\nage/img1.jpg.\n", "subsections": [] }, "NOTES": { "content": "This manual page is not meant to be exhaustive. The complete documentation can be found in\nthe HINT: The file format. This document is available as a book or in electronic form from\nthe HINT project home page at https://hint.userweb.mwn.de. There you find additional soft‐\nware, most importantly viewers for HINT files, and further information.\n", "subsections": [] }, "AVAILABILITY": { "content": "hishrink should compile on a large variety of machine architectures and operating systems.\nIt is part of the TeX Live distribution.\n", "subsections": [] }, "SEE ALSO": { "content": "histretch(1), hitex(1),\n", "subsections": [] }, "AUTHORS": { "content": "Martin Ruckert\n\nVersion 1.3 11 November 2021 HISHRINK(1)", "subsections": [] } } } }