diff options
Diffstat (limited to 'content/docs.org')
-rw-r--r-- | content/docs.org | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/content/docs.org b/content/docs.org new file mode 100644 index 0000000..5737f51 --- /dev/null +++ b/content/docs.org @@ -0,0 +1,119 @@ +#+TITLE: Documentation +#+ALIASES[]: /docs.html + +Below are sources of documentation regarding Carbs Linux and tools surrounding +it. + +#+TOC: headlines 1 + +* User Manual +:PROPERTIES: +:CUSTOM_ID: user-manual +:END: + +Carbs Linux User Manual aims to be a general-purpose explanation of the +distribution, from the installation steps to the style guide of the project. It +can be accessed or otherwise obtained with various methods: + +** HTML +:PROPERTIES: +:CUSTOM_ID: html +:END: + +You can view the Manual from your browser. The Manual can be viewed as + +- [[file:/docs/carbslinux/][One HTML page per node]] +- [[/docs/carbslinux.html][Single HTML page]] + +** Plain text +:PROPERTIES: +:CUSTOM_ID: plain-text +:END: + +You can download [[/docs/carbslinux.txt][carbslinux.txt]] in order to view the Manual from your preferred +pager. + +#+begin_src sh +curl -LO https://carbslinux.org/docs/carbslinux.txt +less carbslinux.txt +#+end_src + +** Info +:PROPERTIES: +:CUSTOM_ID: info +:ORDERED: t +:END: + +You can install the =carbs-docs= package and either =texinfo= or =info= packages +to view the Manual offline. + +#+begin_src sh +cpt bi info carbs-docs +info carbslinux +#+end_src + +** Source +:PROPERTIES: +:CUSTOM_ID: source +:END: + +You can also acquire the source for generating the Manual, which requires +=emacs= for exporting the Org-mode documentation and =texinfo= for generating +html/info pages. + +#+begin_src sh +git clone https://git.carbslinux.org/docs +#+end_src + +* Installation Instructions +:PROPERTIES: +:CUSTOM_ID: installation-instructions +:END: + +Installation Manual is part of the [[*User Manual][User Manual]], but it can also be obtained +separately: + +- [[/install/][HTML]] +- [[/install.txt][Plaintext]] + +* Carbs Packaging Tools +:PROPERTIES: +:CUSTOM_ID: carbs-packaging-tools +:END: + +CPT User Manual has the implementation details of the package manager utilities. +It can be accessed or otherwise obtained with various methods: + +** HTML +:PROPERTIES: +:CUSTOM_ID: cpt-html +:END: + +You can view the Manual from your browser. The Manual can be viewed as + +- [[/docs/cpt/][One HTML page per node]] +- [[/docs/cpt.html][Single HTML page]] + +** Plain text +:PROPERTIES: +:CUSTOM_ID: cpt-plain-text +:END: + +You can download [[/docs/cpt.txt][cpt.txt]] in order to view the Manual from your preferred pager. + +#+begin_src sh +curl -LO https://carbslinux.org/docs/cpt.txt +less cpt.txt +#+end_src + +** Info +:PROPERTIES: +:CUSTOM_ID: cpt-info +:END: + +Info page for CPT is included in the tarball, which can be read offline by +installing either =texinfo= or =info= packages. + +#+begin_src sh +info cpt +#+end_src |