mirror of
https://github.com/ChrisTitusTech/linutil.git
synced 2024-11-23 21:51:56 +00:00
9f0863729f
* feat: Add automation based on config file * docs: add configuration to the manpage & README * update roadmap --------- Co-authored-by: Adam Perkowski <adas1per@protonmail.com> Co-authored-by: Chris Titus <contact@christitus.com>
78 lines
1.9 KiB
Groff
78 lines
1.9 KiB
Groff
.\" manpage for Linutil
|
|
.TH "linutil" "1" "October 2024" "" "Linutil Manual"
|
|
|
|
.SH NAME
|
|
linutil \- Chris Titus Tech's Linux Toolbox
|
|
|
|
.SH SYNOPSIS
|
|
\fBlinutil [OPTIONS]\fR
|
|
|
|
.SH DESCRIPTION
|
|
Linutil is a distro-agnostic toolbox designed to simplify everyday Linux tasks.
|
|
.br
|
|
It helps you set up applications and optimize your system for specific use cases. The utility is actively developed in Rust, providing performance and reliability.
|
|
|
|
.SH LIVE VERSION
|
|
To get started with the live version, pick which branch you would like to use, then run the command in your terminal:
|
|
.TP
|
|
\fBStable Branch\fR
|
|
curl -fsSL https://christitus.com/linux | sh
|
|
.TP
|
|
\fBDevelopement branch\fR
|
|
curl -fsSL https://christitus.com/linuxdev | sh
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-c\fR, \fB\-\-config\fR \fI<path>\fR
|
|
Path to the configuration file.
|
|
|
|
.TP
|
|
\fB\-t\fR, \fB\-\-theme\fR \fI<theme>\fR
|
|
Set the theme to use in the TUI.
|
|
.br
|
|
Possible values:
|
|
\fIdefault\fR,
|
|
\fIcompatible\fR.
|
|
.br
|
|
Defaults to \fIdefault\fR.
|
|
|
|
.TP
|
|
\fB\-y\fR, \fB\-\-skip\-confirmation\fR
|
|
Skip confirmation prompt before executing commands.
|
|
|
|
.TP
|
|
\fB\-\-override\-validation\fR
|
|
Show all available entries, disregarding compatibility checks. (\fBUNSAFE\fR)
|
|
|
|
.TP
|
|
\fB\-\-size\-bypass\fR
|
|
Bypass the terminal size limit
|
|
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
Print help.
|
|
|
|
.SH SUPPORT
|
|
If you find Linutil helpful, please consider giving it a star on GitHub to show your support!
|
|
https://github.com/ChrisTitusTech/linutil
|
|
|
|
.SH DOCUMENTATION
|
|
For comprehensive information on how to use Linutil, visit the Official Linutil Documentation.
|
|
https://christitustech.github.io/linutil
|
|
|
|
.SH AUTHOR
|
|
Written by Adam Perkowski.
|
|
<adas1per@protonmail.com>
|
|
|
|
.SH REPORTING BUGS
|
|
Since the project is still in active development, you may encounter some issues.
|
|
.br
|
|
Please consider submitting feedback if you do.
|
|
https://github.com/ChrisTitusTech/linutil/issues
|
|
|
|
.SH COPYRIGHT
|
|
Copyright (c) 2024 Chris Titus.
|
|
.br
|
|
MIT License.
|
|
https://opensource.org/license/MIT
|