.\" Text automatically generated by txt2man
.TH pytermgui 1 "11 April 2024" "7.7.1+dfsg" "pytermgui"
.SH NAME
\fBpytermgui \fP- Python TUI framework with multi-feature support
\fB
.SH SYNOPSIS
.nf
.fam C
 \fBptg\fP  [\fB-h\fP] [\fB--app\fP Getch, Inspect, Color, \fITim\fP] [\fB-g\fP] [\fB-t\fP] [\fB-c\fP] [\fB-i\fP \fIPATH_OR_CODE\fP] [\fB-e\fP] [\fB--methods\fP] [\fB--dunder\fP] [\fB--private\fP] [\fB-s\fP] 
    [\fB-v\fP] [\fB--palette\fP] [\fB--highlight\fP [\fISYNTAX\fP]] [\fB--exec\fP [\fIEXEC\fP]] [\fB-f\fP \fIFILE\fP] [\fB--print-only\fP] [\fB--export-svg\fP \fIFILE\fP] [\fB--export-html\fP \fIFILE\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
Python TUI framework with mouse support, modular widget system, customizable and rapid terminal markup language and more!
.SH OPTIONS

options:
.RS
.TP
.B
\fB-h\fP, \fB--help\fP
show this help message and exit
.RE
.PP
Applications:
\fB--app\fP Getch, Inspect, Color, \fITim\fP
Launch an app.
.RS
.TP
.B
\fB-g\fP, \fB--getch\fP
Launch the Getch app.
.TP
.B
\fB-t\fP, \fB--tim\fP
Launch the TIM Playground app.
.TP
.B
\fB-c\fP, \fB--color\fP
Launch the ColorPicker app.
.RE
.PP
Inspection:
\fB-i\fP \fIPATH_OR_CODE\fP, \fB--inspect\fP \fIPATH_OR_CODE\fP
Inspect an object.
.RS
.TP
.B
\fB-e\fP, \fB--eval\fP
Evaluate the expression given to `\fB--inspect\fP` instead of treating it as a path.
.TP
.B
\fB--methods\fP
Always show methods when inspecting.
.TP
.B
\fB--dunder\fP
Always show __dunder__ methods when inspecting.
.TP
.B
\fB--private\fP
Always show _private methods when inspecting.
.RE
.PP
Utilities:
.RS
.TP
.B
\fB-s\fP, \fB--size\fP
Output the current terminal size in WxH format.
.TP
.B
\fB-v\fP, \fB--version\fP
Print version & system information.
.TP
.B
\fB--palette\fP
Print the default PyTermGUI color palette.
.TP
.B
\fB--highlight\fP [\fISYNTAX\fP]
Highlight some python-like code syntax. No argument or '-' will read STDIN.
.TP
.B
\fB--exec\fP [\fIEXEC\fP]
Execute some Python code. No argument or '-' will read STDIN.
.TP
.B
\fB-f\fP \fIFILE\fP, \fB--file\fP \fIFILE\fP
Interpret a PTG-YAML file.
.TP
.B
\fB--print-only\fP
When interpreting YAML, print the environment without running it interactively.
.RE
.PP
Exporters:
.RS
.TP
.B
\fB--export-svg\fP \fIFILE\fP
Export the result of any non-interactive argument as an SVG file.
.TP
.B
\fB--export-html\fP \fIFILE\fP
Export the result of any non-interactive argument as an HTML file.