aboutsummaryrefslogtreecommitdiff
path: root/fauxtari.7
diff options
context:
space:
mode:
Diffstat (limited to 'fauxtari.7')
-rw-r--r--fauxtari.7345
1 files changed, 345 insertions, 0 deletions
diff --git a/fauxtari.7 b/fauxtari.7
new file mode 100644
index 0000000..a26813f
--- /dev/null
+++ b/fauxtari.7
@@ -0,0 +1,345 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "FAUXTARI" 7 "2024-07-25" "0.2.1" "Urchlay's Atari 8-bit Tools"
+.SH NAME
+fauxtari \- Atari 8-bit-based font for Linux console and X11/Wayland/Mac/Windows
+.SH DESCRIPTION
+.sp
+\fBfauxtari\fP is a set of monospaced bitmap fonts for use with the
+Linux console or graphical environments such as X11. Most of the
+glyphs are taken from the Atari XL/XE ROM font; see \fBGLYPHS\fP, below.
+.sp
+Three font formats are provided: \fBpsf\fP, for use with the console;
+\fBbdf\fP, for use with "old\-school" X11 apps such as \fBxterm\fP(1);
+and \fBttf\fP for use with modern X11/Wayland/Mac/Windows apps.
+.SH APPEARANCE
+.sp
+The console (\fBpsf\fP files) and X11 (\fBbdf\fP files) fonts each come
+in 3 sizes: 8x8 (original size), 16x16 (scaled 2x), and 24x24 (scaled
+3x). The scaling has no interpolation or antialiasing, so the larger
+fonts have a blocky "retro" look.
+.sp
+The appearance of the font is also vertically squashed, since it was
+designed for non\-square pixels (NTSC and PAL "pixels" are slightly
+taller than they are wide). This allows you to fit a \fIlot\fP of text
+on the screen, in the console or with a fullscreen X terminal:
+.TS
+center;
+|l|l|l|.
+_
+T{
+Font Size
+T} T{
+Display Size
+T} T{
+Characters
+T}
+_
+T{
+8x8
+T} T{
+1280x1024
+T} T{
+160x128
+T}
+_
+T{
+8x8
+T} T{
+1920x1080
+T} T{
+240x135
+T}
+_
+T{
+8x8
+T} T{
+3840x2160
+T} T{
+480x270
+T}
+_
+T{
+16x16
+T} T{
+1280x1024
+T} T{
+80x64
+T}
+_
+T{
+16x16
+T} T{
+1920x1080
+T} T{
+120x67
+T}
+_
+T{
+16x16
+T} T{
+3840x2160
+T} T{
+240x135
+T}
+_
+T{
+24x24
+T} T{
+1280x1024
+T} T{
+53x42
+T}
+_
+T{
+24x24
+T} T{
+1920x1080
+T} T{
+80x45
+T}
+_
+T{
+24x24
+T} T{
+3840x2160
+T} T{
+160x90
+T}
+_
+.TE
+.sp
+Of course, the smaller font sizes might be too small to read, especially
+on smaller displays.
+.sp
+The TrueType font is scalable, but always retains the pixelated look.
+.SH CONSOLE
+.sp
+If the \fBpsf\fP fonts have been installed to the standard console font
+directory (usually \fB/usr/share/kbd/consolefonts/\fP; this is done by
+\fBmake install\fP when \fBbw\-atari8\-tools\fP is built), you can use e.g.:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+setfont fauxtari\-16
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Replace the 16 with 8 or 24, for the other sizes. For Slackware Linux,
+you can make this the default in \fB/etc/rc.d/rc.font\fP, or just put it
+in \fB/etc/rc.d/rc.local\fP\&. Other Linux distributions will have their
+own ways to set this up (especially systemd\-based ones).
+.SH X11/ETC
+.SS TTF (scalable)
+.sp
+The scalable font is called \fBFauxtari Scalable Mono\fP, and should be
+selectable from graphical applications that allow choosing the font.
+You may also see \fBFauxtari Fixed Mono\fP in the list; this is the \fBbdf\fP
+font.
+.sp
+It can also be used in \fBurxvt\fP and \fBxterm\fP (provided \fBxterm\fP
+was built with support for TTF fonts):
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+urxvt \-fn \(aqxft:Fauxtari Scalable Mono:pixelsize=16\(aq
+
+xterm \-fa \(aqFauxtari Scalable Mono\(aq \-fs 16
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The font can be scaled to any size, though it will look best if you
+stick with multiples of 8 pixels.
+.sp
+The scalable font should also work on Wayland, Macintosh, or Windows
+systems, though this hasn\(aqt been tested.
+.SS BDF (non\-scalable)
+.sp
+If the \fBbdf\fP fonts have been installed (via \fBmake install\fP when
+\fBbw\-atari8\-tools\fP is built), you should be able to launch a terminal
+via:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+xterm \-fn fauxtari\-16
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Replace the 16 with 8 or 24, for the other sizes. These names are
+aliases (added to \fBfonts.alias\fP in the font directory); the full
+names are:
+.INDENT 0.0
+.IP \(bu 2
+\-bw\-fauxtari fixed mono\-medium\-r\-normal\-\-8\-80\-75\-75\-c\-80\-iso10646\-1
+.IP \(bu 2
+\-bw\-fauxtari fixed mono\-medium\-r\-normal\-\-16\-160\-75\-75\-c\-160\-iso10646\-1
+.IP \(bu 2
+\-bw\-fauxtari fixed mono\-medium\-r\-normal\-\-24\-240\-75\-75\-c\-240\-iso10646\-1
+.UNINDENT
+.sp
+For \fBurxvt\fP(1), you might have to turn off the \fBboldFont\fP resource (set
+it to an empty string), or run it as:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+urxvt \-fn fauxtari\-16 \-fb ""
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This keeps \fBurxvt\fP from using some other font (from its built\-in
+list, or from your \fBURxvt.font\fP resource) for bold characters.
+.sp
+For \fBst\fP from suckless.org, run:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+st \-f fauxtari\-16
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+It\(aqs possible to use the fonts with \fBrxvt\fP, but since \fBrxvt\fP
+doesn\(aqt support Unicode, it won\(aqt be all that useful except for plain
+ASCII text. Why are you still using \fBrxvt\fP, anyway?
+.SH GLYPHS
+.sp
+All 3 sizes contain the same set of glyphs. These include:
+.INDENT 0.0
+.IP \(bu 2
+Printable ASCII. Complete. Mostly taken from the Atari 800XL ROM
+($E000 area), except the \fB~\fP \fB{\fP \fB}\fP \fB\(ga\fP characters which are
+missing from the Atari\(aqs character set (these were hand\-drawn by the
+author).
+.IP \(bu 2
+Unicode mappings for ATASCII graphics characters. Complete set. These
+work well with \fBlistbas\fP(1), \fBa8cat\fP(1), and \fBa8xd\fP(1). The glyphs
+are taken from the 800XL ROM.
+.IP \(bu 2
+The XL International Character set (umlauted/accented letters, plus
+the \fB¡\fP character and the British pound sign), taken from the 800XL ROM
+($CC00 area).
+.IP \(bu 2
+Arabic, taken from Atari\(aqs Arabic model of the 65XE. Only the
+isolated and terminal letter forms are included, but these are
+also mapped to the Unicode codepoints for the initial and medial forms.
+Hopefully this results in readable Arabic text. The creator of
+\fBfauxtari\fP can\(aqt read Arabic at all and doesn\(aqt know anyone who
+can, so some of the character mappings may be wrong.
+.IP \(bu 2
+Hebrew glyphs, the complete aleph\-bet, taken from the Hebrew ROM
+modification that was available for sale in Israel in the early 1980s.
+I\(aqm almost 100% certain this was a 3rd\-party product, not made by Atari.
+.IP \(bu 2
+Polish accented letters, taken from a Polish XL ROM found on the Web
+at some point. No idea who created this or whether it was homebrew or
+commercial.
+.IP \(bu 2
+A few extra Latin\-1 characters, hand\-drawn by the author. These include
+Spanish punctuation (quotation marks, inverted question mark), the
+copyright symbol, and the Euro currency sign.
+.IP \(bu 2
+TODO: Commodore 64 graphics characters.
+.UNINDENT
+.SH LIMITATIONS
+.INDENT 0.0
+.IP \(bu 2
+There should be more glyphs; at least Unicode Latin\-1 should have complete
+coverage. Some of them (e.g. fractions) will be hard to do in 8x8 character
+cells...
+.IP \(bu 2
+There are no true descenders, since the Atari ROM character set doesn\(aqt use them.
+Someday I may add hand\-hacked true descender versions of the fonts.
+.UNINDENT
+.SH COPYRIGHT
+.sp
+WTFPL. See \fI\%http://www.wtfpl.net/txt/copying/\fP for details.
+.SH AUTHOR
+.INDENT 0.0
+.IP B. 3
+Watson <\fI\%urchlay@slackware.uk\fP>; Urchlay on irc.libera.chat \fI##atari\fP\&.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fBa8cat\fP(1),
+\fBa8eol\fP(1),
+\fBa8xd\fP(1),
+\fBatr2xfd\fP(1),
+\fBatrsize\fP(1),
+\fBaxe\fP(1),
+\fBbas2aplus\fP(1),
+\fBblob2c\fP(1),
+\fBblob2xex\fP(1),
+\fBcart2xex\fP(1),
+\fBcxrefbas\fP(1),
+\fBdasm2atasm\fP(1),
+\fBdiffbas\fP(1),
+\fBdumpbas\fP(1),
+\fBf2toxex\fP(1),
+\fBfenders\fP(1),
+\fBlistbas\fP(1),
+\fBprotbas\fP(1),
+\fBrenumbas\fP(1),
+\fBrom2cart\fP(1),
+\fBunmac65\fP(1),
+\fBunprotbas\fP(1),
+\fBvxrefbas\fP(1),
+\fBwhichbas\fP(1),
+\fBxex1to2\fP(1),
+\fBxexamine\fP(1),
+\fBxexcat\fP(1),
+\fBxexsplit\fP(1),
+\fBxfd2atr\fP(1),
+\fBxex\fP(5),
+\fBatascii\fP(7),
+\fBfauxtari\fP(7).
+.sp
+Any good Atari 8\-bit book: \fIDe Re Atari\fP, \fIThe Atari BASIC Reference
+Manual\fP, the \fIOS Users\(aq Guide\fP, \fIMapping the Atari\fP, etc.
+.\" Generated by docutils manpage writer.
+.