blob: 79b5e54ce9b6aba91311ed7137e56f514505a45f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
#+TITLE: Documentation
Below are sources of documentation regarding Carbs Linux and tools surrounding
it.
* 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]]
- [[file:docs/carbslinux.html][Single HTML page]]
** Plain text
:PROPERTIES:
:CUSTOM_ID: plain-text
:END:
You can download [[file: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 git://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:
- [[file:install.org][HTML]]
- [[file: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
- [[file:docs/cpt][One HTML page per node]]
- [[file:docs/cpt.html][Single HTML page]]
** Plain text
:PROPERTIES:
:CUSTOM_ID: cpt-plain-text
:END:
You can download [[file: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
|
