From fd02a00c8b2712889217b9809df3634edb92e2f0 Mon Sep 17 00:00:00 2001
From: "dylan.araps@gmail.com" <dylan.araps@gmail.com>
Date: Wed, 29 Jan 2020 10:21:20 +0000
Subject: docs: update

FossilOrigin-Name: d5943a40c060b3ff155b8733de202b4b10c58d7b10bf561ad202c811ba8b57ef
---
 README.md | 99 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 4d2ee40..269035f 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,18 @@ Tiny and straightforward package manager for KISS written in POSIX `sh`.
 -> version:      Package manager version
 ```
 
+## Index
+
+<!-- vim-markdown-toc GFM -->
+
+* [Package format](#package-format)
+* [Customization](#customization)
+* [Alternatives system](#alternatives-system)
+* [Extending the package manager](#extending-the-package-manager)
+
+<!-- vim-markdown-toc -->
+
+
 ## Package format
 
 See: <https://getkiss.org/pages/package-system/>
@@ -140,6 +152,93 @@ export MAKEFLAGS=
 export CMAKE_GENERATOR=
 ```
 
+## Alternatives system
+
+When a package with conflicts is installed with `KISS_CHOICE=1`, the conflicting files will be added as "choices" to the alternatives system.
+
+Afterwards, running `kiss a`/`kiss alternatives` will list all of the choices you are able to make. Each line of output with this command is also usable directly as input.
+
+**NOTE** If a package has fewer than 10 conflicting files, the conflicting files will automatically be added to the alternatives system.
+
+Example usage:
+
+```sh
+# List alternatives.
+-> kiss a
+-> Alternatives:
+ncurses /usr/bin/clear
+ncurses /usr/bin/reset
+
+# Swap to ncurses 'clear'.
+-> kiss a ncurses /usr/bin/clear
+-> Swapping '/usr/bin/clear' from 'busybox' to 'ncurses'
+Password:
+
+# New listing (busybox clear was swapped out).
+-> kiss a
+-> Alternatives:
+busybox /usr/bin/clear
+ncurses /usr/bin/reset
+```
+
+Example usage (complex):
+
+```sh
+-> kiss i sbase
+# More lines...
+/var/db/kiss/installed/util-linux/manifest:/usr/bin/renice
+/var/db/kiss/installed/util-linux/manifest:/usr/bin/logger
+/var/db/kiss/installed/util-linux/manifest:/usr/bin/flock
+/var/db/kiss/installed/util-linux/manifest:/usr/bin/cal
+!> Package 'sbase' conflicts with another package
+!> Run 'KISS_CHOICE=1 kiss i sbase' to add conflicts
+!> as alternatives.
+
+# There were more than 10 conflicts so the alternatives system
+# must be manually enabled for this package.
+-> KISS_CHOICE=1 kiss i sbase
+# More lines...
+-> sbase Found conflict (/usr/bin/renice), adding choice
+-> sbase Found conflict (/usr/bin/logger), adding choice
+-> sbase Found conflict (/usr/bin/flock), adding choice
+-> sbase Found conflict (/usr/bin/cal), adding choice
+-> sbase Installing package incrementally
+-> sbase Installed successfully
+
+# List alternatives.
+-> kiss a
+-> Alternatives:
+# More lines...
+sbase /usr/bin/uuencode
+sbase /usr/bin/wc
+sbase /usr/bin/which
+sbase /usr/bin/whoami
+sbase /usr/bin/xargs
+sbase /usr/bin/yes
+
+# Swapping in bulk (all of sbase).
+# The 'kiss a' command with '-' as an argument will read
+# from stdin and use each line as arguments to 'kiss a'.
+kiss a | grep ^sbase | kiss a -
+
+# New listing, sbase has replaced busybox utilities.
+-> kiss a
+-> Alternatives:
+# More lines...
+busybox /usr/bin/uuencode
+busybox /usr/bin/wc
+busybox /usr/bin/which
+busybox /usr/bin/whoami
+busybox /usr/bin/xargs
+busybox /usr/bin/yes
+
+# NOTE: Two sbase utilities currently have issues with kiss.
+#       'su' and 'tar'. You will need to swap these back to
+#       'busybox'.
+kiss a busybox /usr/bin/su
+kiss a busybox /usr/bin/tar
+```
+
 ## Extending the package manager
 
 The `contrib` directory contains a set of simple scripts to extend the package manager. These scripts can be installed through the `kiss-utils` package.
-- 
cgit v1.2.3