agr(1)

🎀 agr(1) 🎀

Okay bestie, this is a General Commands Manual page, and it's giving serious documentation energy ✨ Let's get into it 💅

🦋 NAME 🦋

agr — Displays AmigaGuide files in a terminal 📖

🌸 SYNOPSIS 🌸

agr guidefile

✨ DESCRIPTION ✨

Okay so AmigaGuide Reader (agr for short) is a command line program for viewing AmigaGuide files 💖. These are the native documentation format that's super common on the Amiga platform and its clones 🕹️. It supports the complete v39 specification and a significant part of the v40 specification 🔥. AmigaGuide files traditionally use the .guide filename suffix 🌈.

🫶 OPTIONS 🫶

Nada. None 💀 No flags, no extras, just vibes.

💜 USAGE 💜

Ngl, agr mostly runs on the TAB, CURSOR, SPACE and RETURN keys for navigation 🎀. Here's the full list of tea ☕:

• q or ^C — Bye-bye! Quits agr 👋
• CURSOR keys or i, j, k, l — Scrolls the document up, down, left or right when it's wider or longer than your terminal 🦋
• PAGE UP/PAGE DOWN — Scrolls the document up or down by one complete page, which is exactly the height of your terminal 📜
• HOME or g — Jumps to the top of the document node ⬆️
• END or G — Jumps to the bottom of the document node ⬇️
• SPACE or RETURN — Displays the highlighted document node link ✨
• TAB — Highlights the next visible node link 💅
• a — Highlights the previous visible node link 🙈
• F1 — Displays the Help Node if the AmigaGuide file has one defined. ⚠️ Heads up: if you're using a terminal emulator under X(1), it may trap this key and make it unavailable 😭
• F2 — Displays the Index Node if the AmigaGuide file has one defined 📇
• F3 — Displays the Table of Contents Node if the AmigaGuide file has one defined 📚
• n/b — Displays the next or previous document node. Please note, this does not follow the logical layout of the document as it's displayed. It goes by the next or previous node as it's written sequentially in the AmigaGuide file 🧠
• +/- — Increases or decreases the TAB size (tabstop) by the equivalent of one space 📏
• t — Displays the current TAB size (tabstop) in the lower right-hand corner 🔍
• r — Refreshes the display 🔄
• ? — Displays any meta data stored in the AmigaGuide file 🗂️
• v — Displays the contents of any broken links 💔
• = — Displays the current line number in the lower right-hand corner 🔢
• C — Attempts to use native Amiga colouring for coloured text 🌈

ANSI colours on the Amiga are not standardised! They depend on the current colourmap and palette in use, so if someone changes their desktop colours, the ANSI colours change too 😭 This command attempts to convert the colours displayed in agr from standard ANSI colours to the ones you'd see by default on AmigaOS 2.0+. Check out the conversion table below 🎨

🎨 Colour Table 🎨

Colour Table
#: ANSI       Amiga
------------------------
0: Black   -> Light Grey
1: Red     -> Black
2: Green   -> White
3: Yellow  -> Light Blue
4: Blue    -> Yellow
5: Magenta -> Blue
6: Cyan    -> Green
7: White   -> Red

🎀 AUTHOR 🎀

• Written by Thierry Pierron ✍️
• Additional patches by Hans de Goede 🩹
• This man page was written by Ian Chapman 💌

🐛 BUGS 🐛

• Does not support the complete v40 specification. 🙃
• AREXX node links are not supported (rarely used feature). 🤷‍♀️
• System command node links are not supported (rarely used feature). 🤷‍♀️

This software is not actively updated, but patches or bug fixes are welcome! Send them to <packages@amiga-hardware.com> 💖

⚠️ CAVEATS ⚠️

Amiga filepaths are similar to UNIX file paths, but they differ slightly. In some cases this may lead to external files referenced by the AmigaGuide file not being found. However, agr tries several techniques to avoid this 🧩

Amiga filenames are case insensitive, so unless the correct case has been used in the AmigaGuide file, externally referenced files may not be found 🙈

🧚 SEE ALSO 🧚

The full documentation for agr is available as an HTML file, plus an AmigaGuide file which should have been installed alongside agr 🦋

---

Catch you in the terminal, bestie 🫶 agr(1) 💖