path: root/README.md
diff options
authorCem Keylan <cem@ckyln.com>2020-10-17 15:32:39 +0300
committerCem Keylan <cem@ckyln.com>2020-10-17 15:32:39 +0300
commitbfac636f78f60edcfc2d425ada43705aeb818000 (patch)
tree4c37d7d3eef7c7826dca898a7dc7ebff2f84d04c /README.md
parentbf1a9e6ee5f2e51e6e947b9125d5d27f89b0edb0 (diff)
mandoc: don't remove less -T support, make it optional1.1
Diffstat (limited to 'README.md')
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89ec05a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+Some OpenBSD userland utilities meant to be included in Carbs Linux base.
+Currently includes the following software:
+- diff
+- doas
+- m4
+- mandoc
+- md5
+- nc
+- patch
+- pax
+- signify
+You can build software individually by calling 'make <program>', and the
+program will be built to the root directory of the source. The Makefile
+is bsdmake compatible.
+In order to build 'mandoc', you need to either have zlib installed, or edit
+config.mk to use the in-source zlib.
+In order to build 'nc', you need to have a libtls implementation. Carbs Linux
+uses libtls-bearssl by default.
+If you want the manpager to have tags support (doesn't work on busybox less),
+you will need to do the following:
+ echo CFLAGS += -DHAVE_LESS_T >> config.mk
+If you are unsure whether your less implementation includes tag support, run
+the following:
+ :> testfile
+ less -F -T testfile testfile && echo CFLAGS += -DHAVE_LESS_T >> config.mk
+ rm testfile
+patch directory
+The patch directory doesn't serve any function but to keep track of the applied
+patches under revision control. The sources here are already patched.