diff options
authorCem Keylan <cem@ckyln.com>2021-04-03 21:38:08 +0300
committerCem Keylan <cem@ckyln.com>2021-04-03 21:38:08 +0300
commit028659da246925c68a287eeda06c94aa1863b3c6 (patch)
parentbe08fa9f01ffaaaeebc0a35658f4cf00a56332f6 (diff)
add documentation for cpt
4 files changed, 42 insertions, 2 deletions
diff --git a/.gitmodules b/.gitmodules
index 996a6b6..511c13a 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -4,3 +4,6 @@
[submodule "style"]
path = style
url = https://git.sr.ht/~carbslinux/carbslinux-style
+[submodule "cpt"]
+ path = cpt
+ url = https://git.carbslinux.org/cpt
diff --git a/Makefile b/Makefile
index b257e29..3552b5d 100644
--- a/Makefile
+++ b/Makefile
@@ -5,9 +5,12 @@ all: docs style
docs: texidocs/carbslinux.texi texidocs/carbslinux.txt
mkdir -p docs/docs
+ makeinfo --html --css-ref=https://www.gnu.org/software/gnulib/manual.css -o docs/docs/cpt cpt/docs/cpt.texi
+ makeinfo --html --css-ref=https://www.gnu.org/software/gnulib/manual.css --no-split -o docs/docs/cpt.html cpt/docs/cpt.texi
makeinfo --html --css-ref=https://www.gnu.org/software/gnulib/manual.css -o docs/docs/carbslinux texidocs/carbslinux.texi
makeinfo --html --css-ref=https://www.gnu.org/software/gnulib/manual.css --no-split -o docs/docs/carbslinux.html texidocs/carbslinux.texi
cp texidocs/carbslinux.txt docs/docs/carbslinux.txt
+ cp cpt/docs/cpt.txt docs/docs/cpt.txt
style: style/carbslinux.css
mkdir -p docs
diff --git a/cpt b/cpt
new file mode 160000
+Subproject 81b404593fd61c7505a85523688222bd88bba55
diff --git a/src/docs.org b/src/docs.org
index 28fc62e..79b5e54 100644
--- a/src/docs.org
+++ b/src/docs.org
@@ -78,5 +78,39 @@ separately:
:CUSTOM_ID: carbs-packaging-tools
-The user manual for CPT is not complete yet, but will be released with the 6.0.0
-release. You can see the [[https://github.com/CarbsLinux/cpt][repository]] in order to check its status.
+CPT User Manual has the implementation details of the package manager utilities.
+It can be accessed or otherwise obtained with various methods:
+** HTML
+:CUSTOM_ID: cpt-html
+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
+:CUSTOM_ID: cpt-plain-text
+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
+** Info
+:CUSTOM_ID: cpt-info
+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