spleen

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

README.md (5036B)


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