spleen

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

README.md (6596B)


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