spleen

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

README.md (5667B)


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