From d3762e1d97a8ff50b59ed6341c74d5d2697c94d2 Mon Sep 17 00:00:00 2001 From: tastytea Date: Sun, 24 Feb 2019 15:29:11 +0100 Subject: [PATCH] Added manpage. --- .gitignore | 1 + build_manpage.sh | 12 +++++++++++ hashboot.1.adoc | 53 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 66 insertions(+) create mode 100644 .gitignore create mode 100755 build_manpage.sh create mode 100644 hashboot.1.adoc diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1ed172c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/hashboot.1 diff --git a/build_manpage.sh b/build_manpage.sh new file mode 100755 index 0000000..cc2c80c --- /dev/null +++ b/build_manpage.sh @@ -0,0 +1,12 @@ +#!/bin/sh + +if [ -f "hashboot.1.adoc" ]; then + name="hashboot" + version="$(grep VERSION hashboot | head -n1 | cut -d\" -f2)" + dir="$(dirname ${0})" + + sed -Ei "s/(Revision: +)[0-9]+\.[0-9]+\.[0-9]+/\1${version}/" ${name}.1.adoc + a2x --doctype manpage --format manpage --no-xmllint ${name}.1.adoc +else + echo "hashboot.1.adoc not found." >&2 +fi diff --git a/hashboot.1.adoc b/hashboot.1.adoc new file mode 100644 index 0000000..4ccafcc --- /dev/null +++ b/hashboot.1.adoc @@ -0,0 +1,53 @@ += hashboot(1) +tastytea ; teldra +:Date: 2019-02-24 +:Revision: 0.9.8 +:man source: hashboot +:man version: {revision} +:man manual: General Commands Manual + +== NAME + +hashboot - allows you to execute files from compiled languages as scripts. + +== SYNOPSIS + +*hashboot* _index_|_check_|_recover_ + +== DESCRIPTION + +hashboot hashes all files in `/boot` and the MBR to check them during early +boot. It is intended for when you have encrypted the root partition but not the +boot partition. The checksums and a backup of the contents of `/boot` are stored +in `/var/lib/hashboot` by default. If a checksum doesn't match, you have the +option to restore the file from backup. + +If there is a core- or libreboot bios and flashrom installed, **hashboot** can +check bios for modifications too. + +== OPTIONS + +[format="csv",frame="none",grid="none"] +|====== +*index*,generate checksums and a backup for `/boot` MBR and BIOS. +*check*,check `/boot` MBR and BIOS. +*recover*,replace corrupted files with the backup. +|====== + +== CONFIGURATION + +The configuration file is in `/etc/hashboot.conf`. + +=== Possible options + +[format="csv",frame="none",grid="none"] +|====== +SAVEDIR,The checksums and the backup are stored here. +CKMODES,001=mbr 010=files 100=bios. +MBR_DEVICE,Device with the MBR on it. +|====== + + +== REPORTING BUGS + +Bugtracker: https://github.com/tastytea/hashboot/issues