11# Fonts
22
3- Fonts is a PowerShell module for managing fonts.
3+ Fonts is a PowerShell module for managing fonts. It helps you install, uninstall, and list fonts on the system.
4+
5+ This module only provides the functionality to manage fonts on the system. To install popular fonts, review the
6+ [ NerdFonts] ( https://github.com/PSModule/NerdFonts ) and [ GoogleFonts] ( https://github.com/PSModule/GoogleFonts ) modules.
7+
8+ ## Supported platforms
9+
10+ This module supports managing fonts on Linux, macOS, and Windows operating systems.
411
512## Installation
613
@@ -11,6 +18,56 @@ Install-PSResource -Name Fonts
1118Import-Module -Name Fonts
1219```
1320
21+ ## Usage
22+
23+ Use the module to list, install, and uninstall fonts on your system.
24+
25+ ### Example: List installed fonts
26+
27+ List all fonts installed in the current user context:
28+
29+ ``` powershell
30+ Get-Font
31+ ```
32+
33+ List all fonts installed in the system context. On Windows this lists the fonts in the ` C:\Windows\Fonts ` folder:
34+
35+ ``` powershell
36+ Get-Font -Scope AllUsers
37+ ```
38+
39+ ### Example: Install a font
40+
41+ Install a font in the current user context. This installs the font in the user font folder and updates the
42+ registry so it is available to the current user:
43+
44+ ``` powershell
45+ Install-Font -Path 'C:\path\to\font.ttf'
46+ ```
47+
48+ Install a font for all users. This must run as an administrator, installs the font in the ` C:\Windows\Fonts `
49+ folder, and updates the registry so it is available to every user on the system:
50+
51+ ``` powershell
52+ Install-Font -Path 'C:\path\to\font.ttf' -Scope AllUsers
53+ ```
54+
55+ ### Example: Uninstall a font
56+
57+ Uninstall a font from the current user context. This removes the font from the user font folder and updates the
58+ registry to remove it from the current user:
59+
60+ ``` powershell
61+ Uninstall-Font -Name 'FontName'
62+ ```
63+
64+ Uninstall a font for all users. This must run as an administrator, removes the font from the ` C:\Windows\Fonts `
65+ folder, and updates the registry to remove it from every user on the system:
66+
67+ ``` powershell
68+ Uninstall-Font -Name 'FontName' -Scope AllUsers
69+ ```
70+
1471## Documentation
1572
1673Documentation is published at [ psmodule.io/Fonts] ( https://psmodule.io/Fonts/ ) .
@@ -19,9 +76,5 @@ Use PowerShell help and command discovery for module details:
1976
2077``` powershell
2178Get-Command -Module Fonts
22- Get-Help <CommandName> -Examples
79+ Get-Help -Name Install-Font -Examples
2380```
24-
25- ## Contributing
26-
27- Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
0 commit comments