Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📔 docs: add a manpage #783

Merged
merged 4 commits into from
Oct 8, 2024
Merged

📔 docs: add a manpage #783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f5f625
📔 docs: add a manpage
adamperkowski Oct 8, 2024
ebf251c
📦️ include `linutil.1` in `linutil_tui`
adamperkowski Oct 8, 2024
d28569c
oopsie...
adamperkowski Oct 8, 2024
74fe1e0
`©` -> `(c)`
adamperkowski Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions man/linutil.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
.\" 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\-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\-\-override\-validation\fR
Show all available entries, disregarding compatibility checks. (\fBUNSAFE\fR)

.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.
<[email protected]>

.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
2 changes: 1 addition & 1 deletion tui/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ edition = "2021"
license.workspace = true
repository = "https://github.com/ChrisTitusTech/linutil/tree/main/tui"
version.workspace = true
include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt"]
include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt", "../man/linutil.1"]
build = "build.rs"

[features]
Expand Down