1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
|
.TH VKBASALT-CLI 1 "2024-05-14" "vkbasalt-cli" "User Manual"
.SH NAME
vkbasalt-cli \- CLI utility and library for vkBasalt configuration
.SH SYNOPSIS
.B vkbasalt
[\fIOPTIONS\fR]
.SH DESCRIPTION
\fBvkbasalt-cli\fR is a CLI utility and library that works in conjunction with
vkBasalt. It makes generating configuration files or running vkBasalt with
games easier. This is mainly convenient in environments where integrating
vkBasalt is wishful, for example a GUI application. Integrating vkbasalt-cli
allows a front-end to easily generate and use specific configurations on the
fly, without asking the user to manually write a configuration file.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this help message and exit.
.TP
\fB\-e\fR, \fB\-\-effects\fR \fI{cas,dls,fxaa,smaa,lut}\fR [\fI{cas,dls,fxaa,smaa,lut}\fR ...]
Effects in a separated list of effect to use.
.TP
\fB\-o\fR, \fB\-\-output\fR \fIOUTPUT\fR
Output file.
.TP
\fB\-d\fR, \fB\-\-default\fR
Use default configuration.
.TP
\fB\-\-toggle\-key\fR \fITOGGLE_KEY\fR
Toggle key (default: Home).
.TP
\fB\-\-disable\-on\-launch\fR
Disable on launch.
.TP
\fB\-\-cas\-sharpness\fR \fICAS_SHARPNESS\fR
Adjust CAS sharpness.
.TP
\fB\-\-dls\-sharpness\fR \fIDLS_SHARPNESS\fR
Adjust DLS sharpness.
.TP
\fB\-\-dls\-denoise\fR \fIDLS_DENOISE\fR
Adjust DLS denoise.
.TP
\fB\-\-fxaa\-subpixel\-quality\fR \fIFXAA_SUBPIXEL_QUALITY\fR
Adjust FXAA subpixel quality.
.TP
\fB\-\-fxaa\-quality\-edge\-threshold\fR \fIFXAA_QUALITY_EDGE_THRESHOLD\fR
Adjust FXAA quality edge threshold.
.TP
\fB\-\-fxaa\-quality\-edge\-threshold\-min\fR \fIFXAA_QUALITY_EDGE_THRESHOLD_MIN\fR
Adjust FXAA quality edge threshold minimum.
.TP
\fB\-\-smaa\-edge\-detection\fR \fI{luma,color}\fR
Adjust SMAA edge detection (default: luma).
.TP
\fB\-\-smaa\-threshold\fR \fISMAA_THRESHOLD\fR
Adjust SMAA threshold.
.TP
\fB\-\-smaa\-max\-search\-steps\fR \fISMAA_MAX_SEARCH_STEPS\fR
Adjust SMAA max search steps.
.TP
\fB\-\-smaa\-max\-search\-steps\-diagonal\fR \fISMAA_MAX_SEARCH_STEPS_DIAGONAL\fR
Adjust SMAA max search steps diagonal.
.TP
\fB\-\-smaa\-corner\-rounding\fR \fISMAA_CORNER_ROUNDING\fR
Adjust SMAA corner rounding.
.TP
\fB\-\-lut\-file\-path\fR \fILUT_FILE_PATH\fR
Specify LUT file path.
.TP
\fB\-\-exec\fR \fIEXEC\fR
Execute command.
.SH EXAMPLES
Apply CAS and FXAA filters; output to the current directory:
.RS
.PP
\fBvkbasalt --effects cas fxaa --output .\fR
.RE
.PP
Apply CAS and FXAA filters; set CAS sharpness to \fB0.35\fR; output to the current directory:
.RS
.PP
\fBvkbasalt --effects cas fxaa --cas-sharpness 0.35 --output .\fR
.RE
.PP
Apply DLS and FXAA filters; set DLS sharpness to \fB1\fR; output to \fB~/.config/vkBasalt\fR:
.RS
.PP
\fBvkbasalt --effects dls fxaa --dls-sharpness 1 --output ~/.config/vkBasalt\fR
.RE
.PP
Apply SMAA, DLS and CAS filters; set CAS sharpness to \fB1\fR, DLS sharpness to \fB0.5\fR and DLS denoise to \fB0.75\fR:
.RS
.PP
\fBvkbasalt --effects smaa dls cas --cas-sharpness 1 --dls-sharpness 0.5 --dls-denoise 0.75\fR
.SH SEE ALSO
.BR vkBasalt (1)
.PP
vkBasalt project page: <https://github.com/DadSchoorse/vkBasalt>
.SH AUTHOR
vkbasalt-cli was written by Hari Rana and contributors.
.PP
This manual page was generated from the README.md file for Debian packaging.
|