spleen

Monospaced bitmap fonts for consoles, terminals, and code editors
Log | Files | Refs | README | LICENSE

README.md (5861B)


      1 # Spleen
      2 
      3 Spleen is a monospaced bitmap font available in 6 sizes:
      4 
      5 - 5x8
      6 - 6x12
      7 - 8x16
      8 - 12x24
      9 - 16x32
     10 - 32x64
     11 
     12 Each size is provided in the Glyph Bitmap Distribution Format (BDF), and
     13 release tarballs contain the fonts in the following formats: `PCF`, `PSF`
     14 (for the Linux console), `OTB`, `OTF`, and `.dfont` for macOS users.
     15 
     16 All font sizes contain all ISO/IEC 8859-1 characters (Basic Latin and Latin-1
     17 Supplement Unicode block), Latin Extended-A characters, as well as Box Drawing,
     18 Block Elements, and Braille Patterns Unicode blocks, except for the 5x8 and the
     19 6x12 versions.
     20 
     21 Due to character size constraints, the 5x8 version only contains printable
     22 ASCII characters, the Braille Patterns Unicode block, and light Box Drawing
     23 characters. Please also note that there is no OpenType version for this size.
     24 
     25 As of Spleen 1.8.0, there is now a 6x12 version containing the same Unicode
     26 blocks as the 5x8 version and the Latin-1 Supplement Unicode block.
     27 
     28 Spleen also has support for Powerline symbols out of the box.
     29 
     30 The font name is a reference to Baudelaire.
     31 
     32 ## Screenshots
     33 
     34 The following screenshots show Spleen 16x32 displaying code and prose.
     35 
     36 ![Spleen - Hello][1]
     37 
     38 ![Spleen - L'etranger][2]
     39 
     40 ASCII characters for all sizes:
     41 
     42 Spleen 5x8:
     43 
     44 ![Spleen - ASCII characters - 5x8][3]
     45 
     46 Spleen 6x12:
     47 
     48 ![Spleen - ASCII characters - 6x12][4]
     49 
     50 Spleen 8x16:
     51 
     52 ![Spleen - ASCII characters - 8x16][5]
     53 
     54 Spleen 12x24:
     55 
     56 ![Spleen - ASCII characters - 12x24][6]
     57 
     58 Spleen 16x32:
     59 ![Spleen - ASCII characters - 16x32][7]
     60 
     61 Spleen 32x64:
     62 ![Spleen - ASCII characters - 32x64][8]
     63 
     64 ## XLFD font names
     65 
     66 ```
     67 -misc-spleen-medium-r-normal--8-80-72-72-c-50-iso10646-1
     68 -misc-spleen-medium-r-normal--12-120-72-72-c-60-iso10646-1
     69 -misc-spleen-medium-r-normal--16-160-72-72-c-80-iso10646-1
     70 -misc-spleen-medium-r-normal--24-240-72-72-c-120-iso10646-1
     71 -misc-spleen-medium-r-normal--32-320-72-72-c-160-iso10646-1
     72 -misc-spleen-medium-r-normal--64-640-72-72-c-320-iso10646-1
     73 ```
     74 
     75 ## Packages
     76 
     77 Packages are available for the following operating systems:
     78 
     79 - [OpenBSD][9]
     80 - [NetBSD][10]
     81 - [FreeBSD][11]
     82 - [Arch Linux][12]
     83 - [Void Linux][13]
     84 - [Nix][14]
     85 - [Debian][15]
     86 - [Ubuntu][16]
     87 
     88 ## Manual installation
     89 
     90 ### *BSD and Linux
     91 
     92 Clone the repository, convert the files to the Portable Compiled Format
     93 (PCF) using **bdftopcf** and run **mkfontdir** in the directory.
     94 
     95 Alternatively, release tarballs provide PCF files for each size.
     96 
     97 ### macOS
     98 
     99 macOS users should use the `.dfont` files provided in the release tarballs.
    100 
    101 ### Windows
    102 
    103 Windows users should use the `.otf` files provided in the release tarballs.
    104 
    105 ## Usage
    106 
    107 ### *BSD and Linux
    108 
    109 Update the font path to include **Spleen**:
    110 
    111 	xset +fp /usr/local/share/fonts/spleen/
    112 
    113 Update **.Xdefaults** and add one of the following directives:
    114 
    115 	xterm*faceName: spleen:pixelsize=8:antialias=false
    116 	xterm*faceName: spleen:pixelsize=12:antialias=false
    117 	xterm*faceName: spleen:pixelsize=16:antialias=false
    118 	xterm*faceName: spleen:pixelsize=24:antialias=false
    119 	xterm*faceName: spleen:pixelsize=32:antialias=false
    120 	xterm*faceName: spleen:pixelsize=64:antialias=false
    121 
    122 Launch **xterm**.
    123 
    124 Ubuntu has bitmap fonts support disabled by default, instructions to enable
    125 it are available [here][17].
    126 
    127 ### Linux console
    128 
    129 Release tarballs provide PSF files for each size, `setfont` can be used
    130 to load and set the desired font.
    131 
    132 ### NetBSD console
    133 
    134 NetBSD has .fnt files for each size which can be loaded using wsfontload(8).
    135 
    136 For example, to load Spleen 16x32:
    137 
    138 	wsfontload -N spleen-16x32 -w 16 -h 32 /usr/share/wscons/fonts/spleen-16x32.fnt
    139 	wsconsctl -dw font=spleen-16x32
    140 
    141 ### FreeBSD console
    142 
    143 The FreeBSD package contains .fnt files which can be loaded using
    144 vidcontrol(1).
    145 
    146 For example, to load Spleen 16x32:
    147 
    148 	vidcontrol -f /usr/local/share/fonts/spleen/spleen-16x32.fnt
    149 
    150 ### OpenType versions
    151 
    152 Spleen release tarballs now contains OTF versions generated automatically
    153 from the BDF files, using [bdf2sfd][18]. Each font has a different name,
    154 allowing them to be installed alongside.
    155 
    156 They should be used in the exact size specified below, with anti-aliasing
    157 disabled.
    158 
    159 - Spleen 6x12: 9 Pt (12 pixels)
    160 - Spleen 8x16: 12 Pt (16 pixels)
    161 - Spleen 12x24: 18 Pt (24 pixels)
    162 - Spleen 16x32: 24 Pt (32 pixels)
    163 - Spleen 32x64: 48 Pt (64 pixels)
    164 
    165 ## License
    166 
    167 Spleen is released under the BSD 2-Clause license. See `LICENSE` file for
    168 details.
    169 
    170 ## Author
    171 
    172 Spleen is developed by Frederic Cambus.
    173 
    174 - Site: https://www.cambus.net
    175 
    176 ## Resources
    177 
    178 GitHub: https://github.com/fcambus/spleen
    179 
    180 
    181 ## Trivia
    182 
    183 - Spleen is the default font for OpenBSD consoles since January 2019
    184 - Spleen was imported in the NetBSD src tree in March 2019
    185 - Spleen 12x24 is used in the Haiku [kernel debugger][19] (on high resolution
    186   displays) since May 2021
    187 
    188 [1]: https://www.cambus.net/content/2018/09/spleen-hello.png
    189 [2]: https://www.cambus.net/content/2018/09/spleen-etranger.png
    190 [3]: https://www.cambus.net/files/spleen/spleen-5x8.png
    191 [4]: https://www.cambus.net/files/spleen/spleen-6x12.png
    192 [5]: https://www.cambus.net/files/spleen/spleen-8x16.png
    193 [6]: https://www.cambus.net/files/spleen/spleen-12x24.png
    194 [7]: https://www.cambus.net/files/spleen/spleen-16x32.png
    195 [8]: https://www.cambus.net/files/spleen/spleen-32x64.png
    196 [9]: https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/fonts/spleen/
    197 [10]: https://pkgsrc.se/fonts/spleen
    198 [11]: https://www.freshports.org/x11-fonts/spleen/
    199 [12]: https://aur.archlinux.org/packages/bdf-spleen/
    200 [13]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/font-spleen
    201 [14]: https://github.com/NixOS/nixpkgs/tree/master/pkgs/data/fonts/spleen
    202 [15]: https://packages.debian.org/search?keywords=spleen
    203 [16]: https://packages.ubuntu.com/search?keywords=spleen
    204 [17]: https://wiki.ubuntu.com/Fonts#Enabling_Bitmapped_Fonts
    205 [18]: https://github.com/fcambus/bdf2sfd
    206 [19]: https://git.haiku-os.org/haiku/commit/?id=29a109bd6c01ce71bb61177ee9ff0417e74c1e18