HTMLLinker(1)

📦
version 1.31.1 · 2 versions
, in arch rolling, debian trixie, fedora 43, fedora 44, opensuse-leap 16.0, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ HTMLLinker(1) — the GNUstep System Manual, but make it cute 🎀

okay bestie, so HTMLLinker is literally the tool that fixes up your href references in HTML files 💅 and it's giving main character energy because it's usually handling API reference manuals that got generated by pulling docstrings out of source code, like with autogsdoc(1) 📚🫶

📝 NAME

HTMLLinker — tool to fix up href references in HTML files 🦋

🌸 SYNOPSIS

HTMLLinker [options] input files [ -l relocation file ] [ -d destination
file ]

💖 DESCRIPTION

Okay so HTMLLinker is a tool that fixes href references in HTML files 🔥 ngl the typical case is API reference manuals made by extracting docstrings from source code with tools like autogsdoc(1). Slay. 💅

HTMLLinker takes the following options, and you're allowed to have multiple input files plus multiple -l and -d options too 🧚

🎀 OPTIONS

  • --help — Shows you a short list of the available options 🫶
  • --version — Shows the version info ✨
  • --verbose — Prints extra details while it's processing, so you can see what it's up to 👀
  • -Warn [YES|NO] — Prints extra info about links it couldn't resolve 💀
  • -LinksMarker [xxx] — Only fixes links that have the attribute rel=xxx 🌈
  • -FixupAllLinks YES — Tries to fix all links, not just the ones marked with -LinksMarker 👑
  • -PathMappingsFile file — Reads the relocation mappings from file, which should be in dictionary format 📖
  • -PathMappings '{"path"="another_path";}' — Uses the path mappings you specify right here 🍓
  • -BuildRelocationFileForDir dir — Builds a relocation file for the directory dir and saves it into dir/table.htmlink 🦋
⚠️ bestie, -BuildRelocationFileForDir is special. It prevents any other processing by the linker, so it's a solo mission 😭

🔗 SEE ALSO

autogsdoc(1), GNUstep(7) 💜

👩‍💻 AUTHORS

HTMLLinker was written by Nicola Pero <nicola@brainstorm.co.uk> 👑

This manual page was added by Yavor Doganov <yavor@gnu.org> 🫶

Copyright (C) 2009 Free Software Foundation, Inc. 🌸

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. No cap, that's the free-for-all energy 🦋

Bestie, this page is from the GNUstep System Manual, dated August 16, 2009 🎀 Stay iconic and keep those hrefs fixed, periodt! 💅✨

📦 where this page comes from