From 55b5838cb568fe2e380ba61c123f9caeb9d324be Mon Sep 17 00:00:00 2001
From: Adam Perkowski <adas1per@protonmail.com>
Date: Tue, 8 Oct 2024 23:14:16 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=94=20docs:=20add=20a=20manpage=20(#78?=
 =?UTF-8?q?3)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 📔 docs: add a manpage

* 📦️ include `linutil.1` in `linutil_tui`

* oopsie...

* `©` -> `(c)`
---
 man/linutil.1  | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++
 tui/Cargo.toml |  2 +-
 2 files changed, 66 insertions(+), 1 deletion(-)
 create mode 100644 man/linutil.1

diff --git a/man/linutil.1 b/man/linutil.1
new file mode 100644
index 00000000..d31cf879
--- /dev/null
+++ b/man/linutil.1
@@ -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.
+<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
diff --git a/tui/Cargo.toml b/tui/Cargo.toml
index ea777ffd..40d3c357 100644
--- a/tui/Cargo.toml
+++ b/tui/Cargo.toml
@@ -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]