Table of Contents - RDoc Documentation
Pages
- Gemfile
- LICENSE
-
README.adoc
- Fontist
- Installation
- Fetch formulas
- Dependencies
- Using the command-line interface (CLI)
- The ‘fontist` command
- Install fonts: ‘fontist install`
- Uninstall fonts: ‘fontist uninstall`
- Status: ‘fontist status`
- List: ‘fontist list`
- List installed font paths: ‘fontist manifest-locations`
- Install fonts from manifest: ‘fontist manifest-install`
- Work with fontist config: ‘fontist config`
- Work with Fontconfig: ‘fontist fontconfig`
- Work with cache
- Help: ‘fontist help`
- Configuration with environment variables
- Using the Ruby library
- ‘Fontist::Font`
- Finding a font
- Install a font
- List all fonts
- ‘Fontist::Formula`
- Find a formula
- List font styles supported by a formula
- List all formulas
- ‘Fontist::Manifest`
- Global options
- ‘Fontist::Manifest::Locations`
- ‘Fontist::Manifest::Install`
- Support of YAML format
- ‘Fontist::Fontconfig`
- Platform-specific features
- macOS-specific add-on fonts
- Known problematic fonts
- Advanced usage
- Using proxy servers
- Custom Fontist repositories
- General
- Registering a Fontist repository
- Listing custom Fontist repositories
- Installing fonts from a Fontist repository
- Updating a registered Fontist repository
- Removing a registered Fontist repository
- Private access
- Authentication for private formulas or private formula repositories
- Create Fontist formulas
- General
- Auto-generate a Fontist formula from a font archive
- Overriding font metadata in Fontist formulas
- Upgrading Fontist
- To v1.10+
- To v1.16+
- Maintenance (for Fontist maintainers only!)
- Formulas versioning
- Dynamically importing formulas from Google Fonts
- Dynamically importing formulas from SIL
- Dynamically importing formulas from macOS
- Development
- Setup
- Formula storage
- Releasing
- Contributing
- Credit
- Rakefile
- setup
- macos_license
Classes and Modules
- Fontist
- Fontist::CLI
- Fontist::CLI::ClassOptions
- Fontist::CacheCLI
- Fontist::CollectionFile
- Fontist::Config
- Fontist::ConfigCLI
- Fontist::Errors
- Fontist::Errors::BinaryCallError
- Fontist::Errors::FontError
- Fontist::Errors::FontFileError
- Fontist::Errors::FontIndexCorrupted
- Fontist::Errors::FontNotFoundError
- Fontist::Errors::FontconfigFileNotFoundError
- Fontist::Errors::FontconfigNotFoundError
- Fontist::Errors::FontistVersionError
- Fontist::Errors::FormulaIndexNotFoundError
- Fontist::Errors::FormulaNotFoundError
- Fontist::Errors::GeneralError
- Fontist::Errors::InvalidConfigAttributeError
- Fontist::Errors::InvalidResourceError
- Fontist::Errors::LicensingError
- Fontist::Errors::MainRepoNotFoundError
- Fontist::Errors::ManifestCouldNotBeFoundError
- Fontist::Errors::ManifestCouldNotBeReadError
- Fontist::Errors::ManualFontError
- Fontist::Errors::MissingAttributeError
- Fontist::Errors::MissingFontError
- Fontist::Errors::RepoCouldNotBeUpdatedError
- Fontist::Errors::RepoNotFoundError
- Fontist::Errors::SizeLimitError
- Fontist::Errors::TamperedFileError
- Fontist::Errors::TimeoutError
- Fontist::Errors::UnknownArchiveError
- Fontist::Errors::UnknownFontTypeError
- Fontist::Errors::UnsupportedFontError
- Fontist::Font
- Fontist::FontFile
- Fontist::FontInstaller
- Fontist::FontPath
- Fontist::Fontconfig
- Fontist::FontconfigCLI
- Fontist::Formula
- Fontist::FormulaPicker
- Fontist::FormulaSuggestion
- Fontist::Helpers
- Fontist::Import
- Fontist::Import::ConvertFormulas
- Fontist::Import::CreateFormula
- Fontist::Import::Files
- Fontist::Import::Files::CollectionFile
- Fontist::Import::Files::FileRequirement
- Fontist::Import::Files::FontDetector
- Fontist::Import::FormulaBuilder
- Fontist::Import::FormulaSerializer
- Fontist::Import::Google
- Fontist::Import::Google::Api
- Fontist::Import::Google::CreateGoogleFormula
- Fontist::Import::GoogleImport
- Fontist::Import::Helpers
- Fontist::Import::Helpers::HashHelper
- Fontist::Import::Helpers::SystemHelper
- Fontist::Import::Macos
- Fontist::Import::ManualFormulaBuilder
- Fontist::Import::Otf
- Fontist::Import::Otf::FontFile
- Fontist::Import::OtfParser
- Fontist::Import::OtfStyle
- Fontist::Import::Otfinfo
- Fontist::Import::Otfinfo::OtfinfoRequirement
- Fontist::Import::OtfinfoGenerate
- Fontist::Import::RecursiveExtraction
- Fontist::Import::SilImport
- Fontist::Import::TemplateHelper
- Fontist::Import::TextHelper
- Fontist::ImportCLI
- Fontist::Index
- Fontist::Indexes
- Fontist::Indexes::BaseIndex
- Fontist::Indexes::DefaultFamilyFontIndex
- Fontist::Indexes::FilenameIndex
- Fontist::Indexes::FontIndex
- Fontist::Indexes::IndexFormula
- Fontist::Indexes::PreferredFamilyFontIndex
- Fontist::Info
- Fontist::Manifest
- Fontist::Manifest::Install
- Fontist::Manifest::Locations
- Fontist::Repo
- Fontist::RepoCLI
- Fontist::Resources
- Fontist::Resources::ArchiveResource
- Fontist::Resources::GoogleResource
- Fontist::StyleVersion
- Fontist::SystemFont
- Fontist::SystemIndex
- Fontist::SystemIndex::DefaultFamily
- Fontist::SystemIndex::PreferredFamily
- Fontist::ThorExt
- Fontist::ThorExt::Start
- Fontist::Update
- Fontist::Utils
- Fontist::Utils::Cache
- Fontist::Utils::Downloader
- Fontist::Utils::FileMagic
- Fontist::Utils::Locking
- Fontist::Utils::NullProgressBar
- Fontist::Utils::ProgressBar
- Fontist::Utils::System
- Fontist::Utils::UI
- TCPSocket
Methods
- ::all — Fontist::Font
- ::all — Fontist::Formula
- ::all_keys — Fontist::Formula
- ::api_key — Fontist::Import::Google::Api
- ::ask — Fontist::Utils::UI
- ::bind — Fontist::Import::TemplateHelper
- ::call — Fontist::Update
- ::cleanup — Fontist::Import::TextHelper
- ::config — Fontist
- ::config_path — Fontist
- ::db — Fontist::Import::Google::Api
- ::debug — Fontist::Utils::UI
- ::debug? — Fontist::Utils::UI
- ::default_fontist_path — Fontist
- ::default_level — Fontist::Utils::UI
- ::detect — Fontist::Import::Files::FontDetector
- ::detect — Fontist::Utils::FileMagic
- ::digest — Fontist::Import::Google
- ::download — Fontist::Utils::Downloader
- ::downloads_path — Fontist
- ::env_level — Fontist::Utils::UI
- ::error — Fontist::Utils::UI
- ::esc — Fontist::Import::TemplateHelper
- ::escape_double_quotes — Fontist::Import::TemplateHelper
- ::excluded_fonts_path — Fontist
- ::exit_on_failure? — Fontist::CLI
- ::expand_paths — Fontist::SystemFont
- ::extended — Fontist::ThorExt::Start
- ::family — Fontist::SystemIndex
- ::file_brief — Fontist::Import::Files::FontDetector
- ::find — Fontist::Font
- ::find — Fontist::Formula
- ::find — Fontist::SystemFont
- ::find_by_font_file — Fontist::Formula
- ::find_by_key — Fontist::Formula
- ::find_by_key_or_name — Fontist::Formula
- ::find_by_name — Fontist::Formula
- ::find_fonts — Fontist::Formula
- ::find_many — Fontist::Formula
- ::find_styles — Fontist::Formula
- ::find_styles — Fontist::SystemFont
- ::font_paths — Fontist::SystemFont
- ::fontconfig_installed? — Fontist::Utils::System
- ::fontist_font_paths — Fontist::SystemFont
- ::fontist_index — Fontist::SystemIndex
- ::fontist_index_path — Fontist
- ::fontist_path — Fontist
- ::fontist_preferred_family_index_path — Fontist
- ::fontist_version_path — Fontist
- ::fonts_path — Fontist
- ::formula_filename_index_path — Fontist
- ::formula_index_dir — Fontist
- ::formula_index_path — Fontist
- ::formula_path — Fontist::Import::Google
- ::formula_preferred_family_index_path — Fontist
- ::formula_size_limit_in_megabytes — Fontist
- ::formulas_path — Fontist
- ::formulas_path= — Fontist
- ::formulas_repo_path — Fontist
- ::formulas_repo_url — Fontist
- ::formulas_version — Fontist
- ::from_collection_index — Fontist::FontFile
- ::from_content — Fontist::FontFile
- ::from_file — Fontist::Manifest::Locations
- ::from_hash — Fontist::Manifest::Locations
- ::from_path — Fontist::CollectionFile
- ::from_path — Fontist::FontFile
- ::from_yaml — Fontist::Indexes::BaseIndex
- ::from_yaml — Fontist::Indexes::FontIndex
- ::google_fonts_key — Fontist
- ::included — Fontist::CLI::ClassOptions
- ::info — Fontist::Repo
- ::install — Fontist::Font
- ::interactive= — Fontist
- ::interactive? — Fontist
- ::items — Fontist::Import::Google::Api
- ::level — Fontist::Utils::UI
- ::level= — Fontist::Utils::UI
- ::lib_path — Fontist
- ::list — Fontist::Font
- ::list — Fontist::Repo
- ::load_system_font_paths — Fontist::SystemFont
- ::lock_path — Fontist::Utils::Cache
- ::log_level= — Fontist
- ::log_levels — Fontist::Utils::UI
- ::longest_common_prefix — Fontist::Import::TextHelper
- ::match? — Fontist::Utils::System
- ::max_magic — Fontist::Utils::FileMagic
- ::metadata_name — Fontist::Import::Google
- ::name_to_filename — Fontist::Import
- ::name_to_key — Fontist::Formula
- ::new — Fontist::CollectionFile
- ::new — Fontist::Config
- ::new — Fontist::Errors::FontconfigNotFoundError
- ::new — Fontist::Errors::FontconfigFileNotFoundError
- ::new — Fontist::Errors::FormulaNotFoundError
- ::new — Fontist::Errors::FontError
- ::new — Fontist::Errors::MissingFontError
- ::new — Fontist::Errors::ManualFontError
- ::new — Fontist::Errors::UnsupportedFontError
- ::new — Fontist::Font
- ::new — Fontist::FontFile
- ::new — Fontist::FontInstaller
- ::new — Fontist::FontPath
- ::new — Fontist::Fontconfig
- ::new — Fontist::Formula
- ::new — Fontist::FormulaPicker
- ::new — Fontist::FormulaSuggestion
- ::new — Fontist::Import::CreateFormula
- ::new — Fontist::Import::Files::CollectionFile
- ::new — Fontist::Import::Files::FileRequirement
- ::new — Fontist::Import::FormulaBuilder
- ::new — Fontist::Import::FormulaSerializer
- ::new — Fontist::Import::Google::CreateGoogleFormula
- ::new — Fontist::Import::GoogleImport
- ::new — Fontist::Import::Macos
- ::new — Fontist::Import::Otf::FontFile
- ::new — Fontist::Import::OtfParser
- ::new — Fontist::Import::OtfStyle
- ::new — Fontist::Import::Otfinfo::OtfinfoRequirement
- ::new — Fontist::Import::OtfinfoGenerate
- ::new — Fontist::Import::RecursiveExtraction
- ::new — Fontist::Indexes::BaseIndex
- ::new — Fontist::Indexes::IndexFormula
- ::new — Fontist::Manifest::Install
- ::new — Fontist::Manifest::Locations
- ::new — Fontist::Info
- ::new — Fontist::Resources::ArchiveResource
- ::new — Fontist::Resources::GoogleResource
- ::new — Fontist::StyleVersion
- ::new — Fontist::SystemFont
- ::new — Fontist::SystemIndex
- ::new — Fontist::Update
- ::new — Fontist::Utils::Downloader
- ::new — Fontist::Utils::ProgressBar
- ::new — Fontist::Utils::FileMagic
- ::new_from_file — Fontist::Formula
- ::open_timeout — Fontist
- ::parse_to_object — Fontist::Helpers
- ::path — Fontist::Indexes::BaseIndex
- ::path — Fontist::Indexes::DefaultFamilyFontIndex
- ::path — Fontist::Indexes::FilenameIndex
- ::path — Fontist::Indexes::PreferredFamilyFontIndex
- ::preferred_family= — Fontist
- ::preferred_family? — Fontist
- ::print — Fontist::Utils::UI
- ::private_formulas_path — Fontist
- ::read_timeout — Fontist
- ::rebuild — Fontist::Index
- ::rebuild — Fontist::Indexes::BaseIndex
- ::remove — Fontist::Fontconfig
- ::remove — Fontist::Repo
- ::reset_cache — Fontist::Index
- ::reset_cache — Fontist::Indexes::BaseIndex
- ::reset_system_font_paths_cache — Fontist::SystemFont
- ::root_path — Fontist
- ::run — Fontist::Helpers
- ::run — Fontist::Import::Helpers::SystemHelper
- ::say — Fontist::Utils::UI
- ::setup — Fontist::Repo
- ::silence_stream — Fontist::Helpers
- ::standard_extension — Fontist::Import::Files::FontDetector
- ::status — Fontist::Font
- ::stringify_keys — Fontist::Import::Helpers::HashHelper
- ::style_version — Fontist::Import::Google
- ::success — Fontist::Utils::UI
- ::system_config — Fontist::SystemFont
- ::system_file_path — Fontist
- ::system_font_paths — Fontist::SystemFont
- ::system_index — Fontist::SystemIndex
- ::system_index_path — Fontist
- ::system_preferred_family_index_path — Fontist
- ::ui — Fontist
- ::uninstall — Fontist::Font
- ::update — Fontist::Fontconfig
- ::update — Fontist::Repo
- ::update_formulas_repo — Fontist::Formula
- ::url — Fontist::Import::Google::Api
- ::use_cache= — Fontist
- ::use_cache? — Fontist
- ::user_os — Fontist::Utils::System
- ::user_os_with_version — Fontist::Utils::System
- #<=> — Fontist::StyleVersion
- #== — Fontist::Indexes::IndexFormula
- #== — Fontist::StyleVersion
- #[] — Fontist::CollectionFile
- #add_formula — Fontist::Indexes::BaseIndex
- #add_formula — Fontist::Indexes::DefaultFamilyFontIndex
- #add_formula — Fontist::Indexes::FilenameIndex
- #add_formula — Fontist::Indexes::PreferredFamilyFontIndex
- #add_index_formula — Fontist::Indexes::BaseIndex
- #all — Fontist::Font
- #already_fetched? — Fontist::Utils::Cache
- #build — Fontist::Indexes::BaseIndex
- #call — Fontist::FormulaPicker
- #call — Fontist::Import::ConvertFormulas
- #call — Fontist::Import::CreateFormula
- #call — Fontist::Import::Files::FileRequirement
- #call — Fontist::Import::FormulaSerializer
- #call — Fontist::Import::Google::CreateGoogleFormula
- #call — Fontist::Import::GoogleImport
- #call — Fontist::Import::Macos
- #call — Fontist::Import::OtfParser
- #call — Fontist::Import::OtfStyle
- #call — Fontist::Import::Otfinfo::OtfinfoRequirement
- #call — Fontist::Import::OtfinfoGenerate
- #call — Fontist::Import::SilImport
- #call — Fontist::Manifest::Locations
- #call — Fontist::Update
- #clear — Fontist::CacheCLI
- #copyright — Fontist::Formula
- #copyright — Fontist::Import::Otf::FontFile
- #count — Fontist::CollectionFile
- #create_formula — Fontist::CLI
- #custom_values — Fontist::Config
- #default_value — Fontist::Config
- #default_value — Fontist::StyleVersion
- #default_values — Fontist::Config
- #delete — Fontist::Config
- #delete — Fontist::ConfigCLI
- #delete — Fontist::Utils::Cache
- #description — Fontist::Formula
- #description — Fontist::Import::Otf::FontFile
- #detect — Fontist::Utils::FileMagic
- #digest — Fontist::Formula
- #download — Fontist::Utils::Downloader
- #downloadable? — Fontist::Formula
- #each — Fontist::CollectionFile
- #eql? — Fontist::StyleVersion
- #excluded_fonts — Fontist::SystemIndex
- #extract — Fontist::Formula
- #family — Fontist::FontFile
- #family_name — Fontist::Import::Otf::FontFile
- #family_name — Fontist::SystemIndex::DefaultFamily
- #family_name — Fontist::SystemIndex::PreferredFamily
- #fetch — Fontist::Utils::Cache
- #file_size — Fontist::Formula
- #filename — Fontist::Import::Files::CollectionFile
- #files — Fontist::Resources::ArchiveResource
- #files — Fontist::Resources::GoogleResource
- #find — Fontist::Font
- #find — Fontist::FormulaSuggestion
- #find — Fontist::SystemFont
- #find — Fontist::SystemIndex
- #find_styles — Fontist::SystemFont
- #finish — Fontist::Utils::ProgressBar
- #font — Fontist::Import::Otf::FontFile
- #font_by_name — Fontist::Formula
- #font_collection_files — Fontist::Import::RecursiveExtraction
- #font_files — Fontist::Import::RecursiveExtraction
- #fontist_font? — Fontist::FontPath
- #fonts — Fontist::Formula
- #fonts_by_name — Fontist::Formula
- #fonts_path= — Fontist::Config
- #formula — Fontist::Import::FormulaBuilder
- #formulas — Fontist::FontPath
- #full_name — Fontist::FontFile
- #full_name — Fontist::Import::Otf::FontFile
- #google — Fontist::ImportCLI
- #handle_class_options — Fontist::CLI::ClassOptions
- #hash — Fontist::StyleVersion
- #homepage — Fontist::Formula
- #homepage — Fontist::Import::Otf::FontFile
- #increment — Fontist::Utils::ProgressBar
- #info — Fontist::RepoCLI
- #install — Fontist::CLI
- #install — Fontist::Font
- #install — Fontist::FontInstaller
- #instructions — Fontist::Formula
- #key — Fontist::Formula
- #keys — Fontist::ConfigCLI
- #license — Fontist::Formula
- #license_required — Fontist::Formula
- #license_text — Fontist::Import::RecursiveExtraction
- #license_url — Fontist::Formula
- #license_url — Fontist::Import::Otf::FontFile
- #list — Fontist::CLI
- #list — Fontist::Font
- #list — Fontist::RepoCLI
- #load — Fontist::Config
- #load_formulas — Fontist::Indexes::BaseIndex
- #load_index_formulas — Fontist::Indexes::BaseIndex
- #lock — Fontist::Utils::Locking
- #log_level — Fontist::CLI::ClassOptions
- #macos — Fontist::ImportCLI
- #manifest_install — Fontist::CLI
- #manifest_locations — Fontist::CLI
- #manual? — Fontist::Formula
- #min_fontist — Fontist::Formula
- #name — Fontist::Errors::FontError
- #name — Fontist::Formula
- #name — Fontist::Indexes::IndexFormula
- #normalize_key — Fontist::Indexes::DefaultFamilyFontIndex
- #normalize_key — Fontist::Indexes::PreferredFamilyFontIndex
- #numbers — Fontist::StyleVersion
- #operations — Fontist::Import::RecursiveExtraction
- #path — Fontist::Formula
- #persist — Fontist::Config
- #platforms — Fontist::Formula
- #post_script_name — Fontist::Import::Otf::FontFile
- #preferred_family — Fontist::FontFile
- #preferred_family_name — Fontist::Import::Otf::FontFile
- #preferred_subfamily — Fontist::FontFile
- #preferred_type — Fontist::Import::Otf::FontFile
- #print_incrementally — Fontist::Utils::NullProgressBar
- #rebuild — Fontist::SystemIndex
- #rebuild_index — Fontist::CLI
- #remove — Fontist::Fontconfig
- #remove — Fontist::FontconfigCLI
- #remove — Fontist::RepoCLI
- #resources — Fontist::Formula
- #save — Fontist::Import::FormulaBuilder
- #set — Fontist::Config
- #set — Fontist::ConfigCLI
- #set — Fontist::Utils::Cache
- #setup — Fontist::RepoCLI
- #show — Fontist::ConfigCLI
- #sil — Fontist::ImportCLI
- #source — Fontist::Formula
- #source_filename — Fontist::Import::Files::CollectionFile
- #source_font — Fontist::Import::Otf::FontFile
- #start — Fontist::ThorExt::Start
- #status — Fontist::CLI
- #status — Fontist::Font
- #string_version — Fontist::StyleVersion
- #style_override — Fontist::Formula
- #subfamily — Fontist::FontFile
- #to_collection_style — Fontist::Import::Otf::FontFile
- #to_full — Fontist::Indexes::IndexFormula
- #to_h — Fontist::Indexes::BaseIndex
- #to_index_formula — Fontist::Formula
- #to_s — Fontist::FontPath
- #to_s — Fontist::Indexes::IndexFormula
- #to_s — Fontist::Info
- #to_s — Fontist::StyleVersion
- #to_style — Fontist::Import::Otf::FontFile
- #to_yaml — Fontist::Indexes::BaseIndex
- #total= — Fontist::Utils::ProgressBar
- #transform_override_keys — Fontist::SystemIndex::DefaultFamily
- #transform_override_keys — Fontist::SystemIndex::PreferredFamily
- #type — Fontist::Import::Otf::FontFile
- #type — Fontist::SystemIndex::DefaultFamily
- #type — Fontist::SystemIndex::PreferredFamily
- #uninstall — Fontist::CLI
- #uninstall — Fontist::Font
- #update — Fontist::CLI
- #update — Fontist::Fontconfig
- #update — Fontist::FontconfigCLI
- #update — Fontist::RepoCLI
- #value — Fontist::StyleVersion
- #values — Fontist::Config
- #version — Fontist::Import::Otf::FontFile