Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.11 KB

README.md

File metadata and controls

41 lines (31 loc) · 1.11 KB

linux-help-pages

Linux Command line Cheatsheet

PREVIEW

curl -sL 'https://raw.githubusercontent.com/Lodobo/linux-help-pages/main/files/help.man' | man -l -

How to use

Download the man page

wget -P ~/.local/share https://raw.githubusercontent.com/Lodobo/linux-help-pages/main/files/help.man

Create alias in ~/.bashrc

## Using a local file:
alias h="man ~/.local/share/help.man"

## or fetch from repo:
alias h="curl -sL 'https://raw.githubusercontent.com/Lodobo/linux-help-pages/main/files/help.man' | man -l -"

How to contribute or modify.

Use the mandoc command to preview the .mdoc file or to convert it to other formats. Documentation for mandoc can be found here. mdoc files use the mdoc syntax, which is a subset of roff. mdoc is easier to work with compared to roff. Documentation for mdoc syntax can be found here.

Preview the mdoc file

# With mandoc
mandoc help.mdoc

# with man
man ./help.mdoc

Convert the mdoc file to a regular manpage

mandoc -T man help.mdoc > help.man