Expand description
Configuration system for par-term terminal emulator.
This crate provides configuration loading, saving, and default values for the terminal emulator. It includes:
- Terminal configuration types and settings
- Theme definitions and color schemes
- Shader configuration management
- Snippets and automation support
- Configuration file watching
- Status bar widget configuration
- Profile configuration types and manager
Re-exports§
pub use cell::Cell;pub use config::Config;pub use config::CustomAcpAgentActionConfig;pub use config::CustomAcpAgentConfig;pub use config::substitute_variables;pub use scrollback_mark::ScrollbackMark;pub use themes::Color;pub use themes::Theme;pub use automation::CoprocessDefConfig;pub use automation::RestartPolicy;pub use automation::TriggerActionConfig;pub use automation::TriggerConfig;pub use scripting::ScriptConfig;pub use snippets::BuiltInVariable;pub use snippets::CustomActionConfig;pub use snippets::SnippetConfig;pub use snippets::SnippetLibrary;pub use status_bar::StatusBarSection;pub use status_bar::StatusBarWidgetConfig;pub use status_bar::WidgetId;pub use status_bar::default_widgets;pub use profile::ConflictResolution;pub use profile::DynamicProfileSource;pub use profile_types::Profile;pub use profile_types::ProfileId;pub use profile_types::ProfileManager;pub use profile_types::ProfileSource;pub use shader_config::resolve_cursor_shader_config;pub use shader_config::resolve_shader_config;pub use shader_metadata::CursorShaderMetadataCache;pub use shader_metadata::ShaderMetadataCache;pub use shader_metadata::parse_cursor_shader_metadata;pub use shader_metadata::parse_shader_metadata;pub use shader_metadata::update_cursor_shader_metadata_file;pub use shader_metadata::update_shader_metadata_file;pub use config::prettifier::PrettifierConfigOverride;pub use config::prettifier::PrettifierYamlConfig;pub use config::prettifier::ResolvedPrettifierConfig;pub use config::prettifier::resolve_prettifier_config;
Modules§
- automation
- Configuration types for triggers and coprocesses.
- cell
- config
- Terminal configuration management.
- defaults
- Default value functions for configuration.
- profile
- Profile configuration types.
- profile_
types - Profile types and manager for terminal session configurations
- scripting
- Configuration types for external observer scripts.
- scrollback_
mark - shader_
config - Shader configuration resolution.
- shader_
metadata - Shader metadata parsing and caching.
- snippets
- Configuration types for snippets and custom actions.
- status_
bar - Status bar widget configuration types.
- themes
- watcher
- Config file watcher for automatic reload.
Structs§
- Alert
Sound Config - Configuration for an alert sound tied to a specific event
- Cursor
Shader Config - Cursor shader specific configuration.
- Cursor
Shader Metadata - Metadata embedded in cursor shader files via YAML block comments.
- Divider
Rect - A divider rectangle between panes
- Font
Range - Font mapping for a specific Unicode range
- Integration
Versions - Tracks installed and prompted versions for integrations
- KeyBinding
- A keybinding configuration entry
- Modifier
Remapping - Modifier remapping configuration.
- Pane
Background - Per-pane background image configuration (runtime state)
- Pane
Background Config - Per-pane background image configuration (for config persistence)
- Resolved
Cursor Shader Config - Fully resolved cursor shader configuration with all values filled in.
- Resolved
Shader Config - Fully resolved shader configuration with all values filled in.
- Shader
Config - Per-shader configuration settings.
- Shader
Metadata - Metadata embedded in shader files via YAML block comments.
- Smart
Selection Rule - A smart selection rule for pattern-based text selection.
Enums§
- Alert
Event - Terminal events that can trigger alert sounds
- Ambiguous
Width - Treatment of East Asian Ambiguous width characters.
- Background
Image Mode - Background image display mode
- Background
Mode - Background source selection
- Cursor
Style - Cursor style
- Divider
Style - Style of dividers between panes
- Download
Save Location - Default save location for downloaded files
- Dropped
File Quote Style - Quote style for dropped file paths
- Image
Scaling Mode - Image scaling quality for inline graphics (Sixel, iTerm2, Kitty)
- Install
Prompt State - State of an integration’s install prompt
- KeyModifier
- Keyboard modifier for keybindings.
- Link
Underline Style - Style for link highlight underlines.
- LogLevel
- Log level for debug logging to file.
- Modifier
Target - Target modifier for remapping.
- Normalization
Form - Unicode normalization form for terminal text.
- Option
KeyMode - Option/Alt key behavior mode
- Pane
Title Position - Position of pane title bars
- Power
Preference - GPU power preference for adapter selection
- Progress
BarPosition - Progress bar position on screen
- Progress
BarStyle - Progress bar visual style
- Semantic
History Editor Mode - Editor selection mode for semantic history
- Session
LogFormat - Log format for session logging
- Shader
Install Prompt - Shader install prompt mode
- Shell
Exit Action - Action to take when the shell process exits
- Shell
Type - Detected shell type
- Smart
Selection Precision - Precision level for smart selection rules.
- Startup
Directory Mode - Startup directory mode
- Status
BarPosition - Status bar position
- TabBar
Mode - Tab bar visibility mode
- TabBar
Position - Tab bar position
- TabStyle
- Tab visual style preset
- TabTitle
Mode - Controls how tab titles are automatically updated
- Thin
Strokes Mode - Thin strokes / font smoothing mode
- Unfocused
Cursor Style - Unfocused cursor style - how the cursor appears when window loses focus
- Unicode
Version - Unicode version for width calculation tables.
- Update
Check Frequency - Update check frequency
- Vsync
Mode - VSync mode (presentation mode)
- Window
Type - Window type for different display modes
Functions§
- default_
smart_ selection_ rules - Get the default smart selection rules (based on iTerm2’s defaults)
Type Aliases§
- PaneId
- Unique identifier for a pane
- Separator
Mark - Visible command separator mark: (row, col_offset, optional_color)
- TabId
- Unique identifier for a tab