mirror of
https://github.com/ryanoasis/nerd-fonts.git
synced 2024-12-19 20:12:52 +02:00
doc: Update README font-patcher options
Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
This commit is contained in:
parent
8dc1ecdc04
commit
3281c6dc82
101
readme.md
101
readme.md
@ -375,18 +375,25 @@ Patching the font of your own choosing:
|
||||
Full options follow, see also [**page explaining all options**](https://github.com/ryanoasis/nerd-fonts/wiki/ScriptOptions):
|
||||
|
||||
```
|
||||
Nerd Fonts Patcher v3.0.2 (4.4.0) (ff 20230101)
|
||||
usage: font-patcher [-h] [-v] [-s] [-l] [-q] [-c] [--careful] [--removeligs] [--postprocess [POSTPROCESS]] [--configfile [CONFIGFILE]] [--custom [CUSTOM]]
|
||||
[-ext [EXTENSION]] [-out [OUTPUTDIR]] [--glyphdir [GLYPHDIR]] [--makegroups [{-1,0,1,2,3,4,5,6}]] [--variable-width-glyphs]
|
||||
[--has-no-italic] [--progressbars | --no-progressbars] [--debug [{0,1,2,3}]] [--dry] [--xavgcharwidth [XAVGWIDTH]] [--fontawesome]
|
||||
[--fontawesomeextension] [--fontlogos] [--octicons] [--codicons] [--powersymbols] [--pomicons] [--powerline] [--powerlineextra]
|
||||
[--material] [--weather]
|
||||
Nerd Fonts Patcher v3.1.0-6 (4.8.1) (ff 20230101)
|
||||
usage: font-patcher [-h] [-v] [-s] [--variable-width-glyphs]
|
||||
[--debug [{0,1,2,3}]] [-q] [--careful] [-ext EXTENSION]
|
||||
[-out OUTPUTDIR] [--makegroups [{-1,0,1,2,3,4,5,6}]] [-c]
|
||||
[--codicons] [--fontawesome] [--fontawesomeext]
|
||||
[--fontlogos] [--material] [--octicons] [--powersymbols]
|
||||
[--pomicons] [--powerline] [--powerlineextra] [--weather]
|
||||
[--boxdrawing] [--configfile CONFIGFILE] [--custom CUSTOM]
|
||||
[--dry] [--glyphdir GLYPHDIR] [--has-no-italic] [-l]
|
||||
[--metrics {HHEA,TYPO,WIN}] [--name FORCE_NAME]
|
||||
[--postprocess POSTPROCESS] [--removeligs]
|
||||
[--xavgcharwidth [XAVGWIDTH]]
|
||||
[--progressbars | --no-progressbars]
|
||||
font
|
||||
|
||||
Nerd Fonts Font Patcher: patches a given font with programming and development related glyphs
|
||||
|
||||
* Website: https://www.nerdfonts.com
|
||||
* Version: 3.0.2
|
||||
* Version: 3.1.0-6
|
||||
* Development Website: https://github.com/ryanoasis/nerd-fonts
|
||||
* Changelog: https://github.com/ryanoasis/nerd-fonts/blob/-/changelog.md
|
||||
|
||||
@ -397,54 +404,54 @@ options:
|
||||
-h, --help show this help message and exit
|
||||
-v, --version show program's version number and exit
|
||||
-s, --mono, --use-single-width-glyphs
|
||||
Whether to generate the glyphs as single-width not double-width (default is double-width)
|
||||
-l, --adjust-line-height
|
||||
Whether to adjust line heights (attempt to center powerline separators more evenly)
|
||||
-q, --quiet, --shutup
|
||||
Do not generate verbose output
|
||||
-c, --complete Add all available Glyphs
|
||||
--careful Do not overwrite existing glyphs if detected
|
||||
--removeligs, --removeligatures
|
||||
Removes ligatures specificed in JSON configuration file
|
||||
--postprocess [POSTPROCESS]
|
||||
Specify a Script for Post Processing
|
||||
--configfile [CONFIGFILE]
|
||||
Specify a file path for JSON configuration file (see sample: src/config.sample.json)
|
||||
--custom [CUSTOM] Specify a custom symbol font, all glyphs will be copied; absolute path suggested
|
||||
-ext [EXTENSION], --extension [EXTENSION]
|
||||
Change font file type to create (e.g., ttf, otf)
|
||||
-out [OUTPUTDIR], --outputdir [OUTPUTDIR]
|
||||
The directory to output the patched font file to
|
||||
--glyphdir [GLYPHDIR]
|
||||
Path to glyphs to be used for patching
|
||||
--makegroups [{-1,0,1,2,3,4,5,6}]
|
||||
Use alternative method to name patched fonts (recommended)
|
||||
Whether to generate the glyphs as single-width not double-width (default is double-width) (Nerd Font Mono)
|
||||
--variable-width-glyphs
|
||||
Do not adjust advance width (no "overhang")
|
||||
--has-no-italic Font family does not have Italic (but Oblique)
|
||||
--progressbars Show percentage completion progress bars per Glyph Set (default)
|
||||
--no-progressbars Don't show percentage completion progress bars per Glyph Set
|
||||
Do not adjust advance width (no "overhang") (Nerd Font Propo)
|
||||
--debug [{0,1,2,3}] Verbose mode (optional: 1=just to file; 2*=just to terminal; 3=display and file)
|
||||
--dry Do neither patch nor store the font, to check naming
|
||||
--xavgcharwidth [XAVGWIDTH]
|
||||
Adjust xAvgCharWidth (optional: concrete value)
|
||||
-q, --quiet Do not generate verbose output
|
||||
--careful Do not overwrite existing glyphs if detected
|
||||
-ext EXTENSION, --extension EXTENSION
|
||||
Change font file type to create (e.g., ttf, otf)
|
||||
-out OUTPUTDIR, --outputdir OUTPUTDIR
|
||||
The directory to output the patched font file to
|
||||
--makegroups [{-1,0,1,2,3,4,5,6}]
|
||||
Use alternative method to name patched fonts (default=1)
|
||||
|
||||
Symbol Fonts:
|
||||
--fontawesome Add Font Awesome Glyphs (http://fontawesome.io/)
|
||||
--fontawesomeextension
|
||||
Add Font Awesome Extension Glyphs (https://andrelzgava.github.io/font-awesome-extension/)
|
||||
--fontlogos, --fontlinux
|
||||
Add Font Logos Glyphs (https://github.com/Lukas-W/font-logos)
|
||||
--octicons Add Octicons Glyphs (https://octicons.github.com)
|
||||
-c, --complete Add all available Glyphs
|
||||
--codicons Add Codicons Glyphs (https://github.com/microsoft/vscode-codicons)
|
||||
--fontawesome Add Font Awesome Glyphs (http://fontawesome.io/)
|
||||
--fontawesomeext Add Font Awesome Extension Glyphs (https://andrelzgava.github.io/font-awesome-extension/)
|
||||
--fontlogos Add Font Logos Glyphs (https://github.com/Lukas-W/font-logos)
|
||||
--material, --mdi Add Material Design Icons (https://github.com/templarian/MaterialDesign)
|
||||
--octicons Add Octicons Glyphs (https://octicons.github.com)
|
||||
--powersymbols Add IEC Power Symbols (https://unicodepowersymbol.com/)
|
||||
--pomicons Add Pomicon Glyphs (https://github.com/gabrielelana/pomicons)
|
||||
--powerline Add Powerline Glyphs
|
||||
--powerlineextra Add Powerline Glyphs (https://github.com/ryanoasis/powerline-extra-symbols)
|
||||
--material, --materialdesignicons, --mdi
|
||||
Add Material Design Icons (https://github.com/templarian/MaterialDesign)
|
||||
--weather, --weathericons
|
||||
Add Weather Icons (https://github.com/erikflowers/weather-icons)
|
||||
--powerlineextra Add Powerline Extra Glyphs (https://github.com/ryanoasis/powerline-extra-symbols)
|
||||
--weather Add Weather Icons (https://github.com/erikflowers/weather-icons)
|
||||
|
||||
Expert Options:
|
||||
--boxdrawing Force patching in (over existing) box drawing glyphs
|
||||
--configfile CONFIGFILE
|
||||
Specify a file path for JSON configuration file (see sample: src/config.sample.json)
|
||||
--custom CUSTOM Specify a custom symbol font, all glyphs will be copied; absolute path suggested
|
||||
--dry Do neither patch nor store the font, to check naming
|
||||
--glyphdir GLYPHDIR Path to glyphs to be used for patching
|
||||
--has-no-italic Font family does not have Italic (but Oblique), to help create correct RIBBI set
|
||||
-l, --adjust-line-height
|
||||
Whether to adjust line heights (attempt to center powerline separators more evenly)
|
||||
--metrics {HHEA,TYPO,WIN}
|
||||
Select vertical metrics source (for problematic cases)
|
||||
--name FORCE_NAME Specify naming source ('full', 'postscript', 'filename', or concrete free name-string)
|
||||
--postprocess POSTPROCESS
|
||||
Specify a Script for Post Processing
|
||||
--removeligs, --removeligatures
|
||||
Removes ligatures specificed in JSON configuration file (needs --configfile)
|
||||
--xavgcharwidth [XAVGWIDTH]
|
||||
Adjust xAvgCharWidth (optional: concrete value)
|
||||
--progressbars Show percentage completion progress bars per Glyph Set (default)
|
||||
--no-progressbars Don't show percentage completion progress bars per Glyph Set
|
||||
```
|
||||
|
||||
#### Examples
|
||||
|
Loading…
Reference in New Issue
Block a user