diff --git a/core/baseinit/README b/core/baseinit/README new file mode 100644 index 00000000..1b31c197 --- /dev/null +++ b/core/baseinit/README @@ -0,0 +1,64 @@ +baseinit +________________________________________________________________________________ + +KISS Linux's portable init framework. Handles the power-on and shutdown process +in a generic way and is usable by all init systems. + +Upstream: $/kisslinux/init + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b baseinit | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +If using the default init system and service manager, no setup is required. +Refer to the service management documentation. [0] + +To use this init framework with another init system, simply have it execute +/usr/lib/init/rc.boot on power-on and /usr/lib/init/rc.shutdown on poweroff +and reboot. + +Usage is as follows: + +# /usr/lib/init/rc.boot +# /usr/lib/init/rc.shutdown reboot +# /usr/lib/init/rc.shutdown poweroff + +Also, configure your init system to spawn some gettys and a service manager. + + +[003] Usage +________________________________________________________________________________ + +Refer to the service management documentation. [0] + + +[004] Troubleshooting +________________________________________________________________________________ + +Open issues at $/kisslinux/init or send email #/contact + + +[005] References +________________________________________________________________________________ + +[0] #/wiki/service-management diff --git a/core/baselayout/README b/core/baselayout/README new file mode 100644 index 00000000..4d864df5 --- /dev/null +++ b/core/baselayout/README @@ -0,0 +1,50 @@ +baselayout +________________________________________________________________________________ + +KISS Linux's system directory structure. It contains the skeleton of the system +and also various files in /etc/. + +Upstream: $/kisslinux/repo + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b baselayout | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| /etc/crypttab Configuration for encrypted block devices. | +| /etc/fstab Static information about the filesystems. | +| /etc/group User group file. | +| /etc/host.conf Resolver configuration file. | +| /etc/hosts Static table lookup for hostnames. | +| /etc/issue Prelogin message and identification file. | +| /etc/mime.types Maps filename suffices to media types. | +| /etc/mtab Symbolic link to /proc/self/mounts. | +| /etc/os-release Operating system identification. | +| /etc/passwd Password file. | +| /etc/profile System-wide shell configuration. | +| /etc/securetty List of terminals on which root is allowed to login. | +| /etc/shadow Shadowed password file. | +| /etc/shells List of login shells. | +| | ++------------------------------------------------------------------------------+ + +Documentation for the various files is not yet provided by the distribution. +Refer to online documentation for the time being. diff --git a/core/binutils/README b/core/binutils/README new file mode 100644 index 00000000..b821d2e7 --- /dev/null +++ b/core/binutils/README @@ -0,0 +1,81 @@ +binutils +________________________________________________________________________________ + +The GNU Binary Utilities, or binutils, are a set of programming tools for +creating and managing binary programs, object files, libraries, profile data, +and assembly source code. [0] + +Upstream: https://www.gnu.org/software/binutils/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* Troubleshooting ........................................................ [003] + * Manual Pages Empty ................................................... [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b binutils | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +This package is a collection of binary tools. + ++-----------+------------------------------------------------------------------+ +| Tool | Purpose | ++-----------+------------------------------------------------------------------+ +| | | +| addr2line | Converts addresses into file names and line numbers. | +| ar | Creates, modifies and extracts archives. | +| as | The GNU assembler. | +| c++filt | Demangle encoded C++ symbols. | +| dwp | The DWARF packaging utility. | +| elfedit | Update the ELF header of ELF files. | +| gold | A new, faster, ELF only linker, still in beta test. | +| ld | The GNU BFD linker. | +| nm | Lists symbols from object files. | +| objcopy | Copies and translates object files. | +| objdump | Displays information from object files. | +| ranlib | Generates an index to the contents of an archive. | +| readelf | Displays information from any ELF format object file. | +| size | Lists the section sizes of an object or archive file. | +| strings | Lists printable strings from files. | +| strip | Discards symbols. | +| | | ++-----------+------------------------------------------------------------------+ + +For usage information refer to the command's --help output, each command also +has its own manual page. + + +[003] Troubleshooting +________________________________________________________________________________ + + +--[004] Manual Pages Empty ----------------------------------------------------- + + The latest binutils has a bug in its build system where manual pages are + truncated and end up empty. A patch must be applied and they must be + regenerated. To do so, install perl and run 'kiss b binutils'. + + This workaround should not be needed as of next release. This is a temporary + measure to ensure documentation remains available to those wanting it + + +[005] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/GNU_Binutils + diff --git a/core/bison/README b/core/bison/README new file mode 100644 index 00000000..a1531ad8 --- /dev/null +++ b/core/bison/README @@ -0,0 +1,41 @@ +bison +________________________________________________________________________________ + +GNU Bison, commonly known as Bison, is a parser generator that is part of the +GNU Project. Bison reads a specification of a context-free language, warns about +any parsing ambiguities, and generates a parser (either in C, C++, or Java) that +reads sequences of tokens and decides whether the sequence conforms to the +syntax specified by the grammar. [0] + +Upstream: https://www.gnu.org/software/bison/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b bison | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the accompanying manual pages or command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/GNU_Bison + diff --git a/core/busybox/README b/core/busybox/README new file mode 100644 index 00000000..66b948cc --- /dev/null +++ b/core/busybox/README @@ -0,0 +1,72 @@ +busybox +________________________________________________________________________________ + +BusyBox is a software suite that provides several Unix utilities in a single +executable file. It runs in a variety of POSIX environments such as Linux, +Android, and FreeBSD, although many of the tools it provides are designed to +work with interfaces provided by the Linux kernel. It was specifically created +for embedded operating systems with very limited resources. The authors dubbed +it "The Swiss Army knife of Embedded Linux", as the single executable replaces +basic functions of more than 300 common commands. [0] + +Upstream: https://busybox.net/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] + * Services ............................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b busybox | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +KISS' default busybox configuration comes with upwards of 300 utilities (all +contained in less than a single megabyte). There are many more utilities and +options which are also currently disabled. + +Busybox does not provide manual pages for each of its commands. Instead it only +provides help output (--help). The POSIX manual pages can be installed to fill +in some of these documentation holes. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b man-pages | +| | ++------------------------------------------------------------------------------+ + +--[003] Services --------------------------------------------------------------- + + The busybox package provides various daemons and also accompanying service + files for the default service manager. The following daemons have services + provided by the distribution. + + * acpid - Simple ACPI events listener + * crond - Daemon to execute scheduled commands. + * mdev - A device manager. + * ntpd - Network Time Protocol Daemon. + * syslogd - System logging daemon. + + Refer to the distribution's service management documentation. [1] If busybox + provides a daemon but no service file is provided, open an issue at + $/kisslinux/repo and a service will be added. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/BusyBox +[1] #/wiki/service-management diff --git a/core/bzip2/README b/core/bzip2/README new file mode 100644 index 00000000..16246ba9 --- /dev/null +++ b/core/bzip2/README @@ -0,0 +1,48 @@ +bzip2 +________________________________________________________________________________ + +bzip2 is a free and open-source file compression program that uses the +Burrows–Wheeler algorithm. It only compresses single files and is not a file +archiver. It is developed by Julian Seward and maintained by Federico Mena. [0] + +Upstream: https://www.sourceware.org/bzip2/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b bzip2 | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use bzip2 as the package manager's compression method for build tarballs, set +the environment variable KISS_COMPRESS to 'bz2'. If bzip2 will not be used as +the package manager's compression method, no such setup is required. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Bzip2 + diff --git a/core/curl/README b/core/curl/README new file mode 100644 index 00000000..7b53eb88 --- /dev/null +++ b/core/curl/README @@ -0,0 +1,49 @@ +curl +________________________________________________________________________________ + +cURL (pronounced 'curl') is a computer software project providing a library +(libcurl) and command-line tool (curl) for transferring data using various +network protocols. The name stands for "Client URL", which was first released +in 1997. [0] + +Upstream: https://curl.se/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b curl | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +The package manager supports many download tools and will also use curl if it is +available. To explicitly tell the package manager to use it, set the KISS_GET +environment variable to 'curl'. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[005] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/CURL + diff --git a/core/flex/README b/core/flex/README new file mode 100644 index 00000000..4b6182ba --- /dev/null +++ b/core/flex/README @@ -0,0 +1,44 @@ +flex +________________________________________________________________________________ + +Flex (fast lexical analyzer generator) is a free and open-source software +alternative to lex. It is a computer program that generates lexical analyzers +(also known as "scanners" or "lexers"). It is frequently used as the lex +implementation together with Berkeley Yacc parser generator on BSD-derived +operating systems (as both lex and yacc are part of POSIX), or together with GNU +bison (a version of yacc) in *BSD ports and in Linux distributions. Unlike +Bison, flex is not part of the GNU Project and is not released under the GNU +General Public License, although a manual for Flex was produced and published by +the Free Software Foundation. [0] + + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b flex | +| | ++------------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[005] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Flex_(lexical_analyser_generator) + diff --git a/core/gcc/README b/core/gcc/README new file mode 100644 index 00000000..e33b1a63 --- /dev/null +++ b/core/gcc/README @@ -0,0 +1,73 @@ +gcc +________________________________________________________________________________ + +The GNU Compiler Collection (GCC) is an optimizing compiler produced by the GNU +Project supporting various programming languages, hardware architectures and +operating systems. The Free Software Foundation (FSF) distributes GCC as free +software under the GNU General Public License (GNU GPL). GCC is a key component +of the GNU toolchain and the standard compiler for most projects related to GNU +and the Linux kernel. With roughly 15 million lines of code in 2019, GCC is one +of the biggest open source programs in existence. It has played an important +role in the growth of free software, as both a tool and an example. [0] + +Upstream: https://gcc.gnu.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] + * C/CXX Compiler Cannot Create Executables ............................. [005] +* References ............................................................. [006] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b gcc | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +GCC is the default compiler and is installed by default. No further setup should +be necessary short of compilation flags. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] Troubleshooting +________________________________________________________________________________ + + +--[005] C/CXX Compiler Cannot Create Executables ------------------------------- + + This is almost always an error in your CFLAGS/CXXFLAGS. Ensure that you have + used -ONUM (CAPITAL O) and not (lowercase o) or (zero 0). If this does not fix + the issue, try building the package with a cleaner environment. + + +----------------------------------------------------------------------------+ + | | + | $ CFLAGS= CXXFLAGS= LDFLAGS= kiss b pkg | + | | + +----------------------------------------------------------------------------+ + + If the issue still persists, open a bug at $/kisslinux/repo + + +[006] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/GNU_Compiler_Collection + diff --git a/core/git/README b/core/git/README new file mode 100644 index 00000000..bc5f3f2f --- /dev/null +++ b/core/git/README @@ -0,0 +1,42 @@ +git +________________________________________________________________________________ + +Git is software for tracking changes in any set of files, usually used for +coordinating work among programmers collaboratively developing source code +during software development. Its goals include speed, data integrity, and +support for distributed, non-linear workflows (thousands of parallel branches +running on different systems). [0] + +Upstream: https://git-scm.com/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b git | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. To use git-request-pull, +perl is required. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Git + diff --git a/core/grub/README b/core/grub/README new file mode 100644 index 00000000..d5747301 --- /dev/null +++ b/core/grub/README @@ -0,0 +1,83 @@ +grub +________________________________________________________________________________ + +GNU GRUB (short for GNU GRand Unified Bootloader, commonly referred to as GRUB) +is a boot loader package from the GNU Project. GRUB is the reference +implementation of the Free Software Foundation's Multiboot Specification, which +provides a user the choice to boot one of multiple operating systems installed +on a computer or select a specific kernel configuration available on a +particular operating system's partitions. [0] + +Upstream: https://www.gnu.org/software/grub/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b grub | +| | ++------------------------------------------------------------------------------+ + +If using UEFI, efibootmgr is also required. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b efibootmgr | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +Ensure that all required partitions are mounted. + + +--[003] BIOS ------------------------------------------------------------------- + + Replace '/dev/sdX' with the disk (not partition) where Grub will be installed. + + +----------------------------------------------------------------------------+ + | | + | $ grub-install --target=i386-pc /dev/sdX | + | $ grub-mkconfig -o /boot/grub/grub.cfg | + | | + +----------------------------------------------------------------------------+ + + +--[004] EUFI ------------------------------------------------------------------- + + Replace 'esp' with the EFI mount point (typically /boot). + + +----------------------------------------------------------------------------+ + | | + | $ grub-install --target=x86_64-efi \ | + | --efi-directory=esp \ | + | --bootloader-id=GRUB | + | $ grub-mkconfig -o /boot/grub/grub.cfg | + | | + +----------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/GNU_GRUB + diff --git a/core/kiss/README b/core/kiss/README new file mode 100644 index 00000000..d70fe3a3 --- /dev/null +++ b/core/kiss/README @@ -0,0 +1,40 @@ +kiss +________________________________________________________________________________ + +The KISS package manager is a small, self-contained POSIX shell script with an +emphasis on portability. + +Upstream: $/kisslinux/kiss + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b kiss | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the distribution documentation [0] [1] and command help output. + + +[003] References +________________________________________________________________________________ + +[0] #/wiki/package-manager +[1] #/wiki/package-system + + diff --git a/core/linux-headers/README b/core/linux-headers/README new file mode 100644 index 00000000..c9604290 --- /dev/null +++ b/core/linux-headers/README @@ -0,0 +1,58 @@ +linux-headers +________________________________________________________________________________ + +The linux kernel's exported header files describe the API for user space +programs attempting to use kernel services. These kernel header files are used +by the system's C library (such as glibc or uClibc) to define available system +calls, as well as constants and structures to be used with these system calls. +The C library's header files include the kernel header files from the "linux" +subdirectory. The system's libc headers are usually installed at the default +location /usr/include and the kernel headers in subdirectories under that +(most notably /usr/include/linux and /usr/include/asm). [0] + +Upstream: https://kernel.org + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Troubleshooting ........................................................ [002] + * The Headers Do Not Match My Kernel Version ........................... [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b linux-headers | +| | ++------------------------------------------------------------------------------+ + + + +[002] Troubleshooting +________________________________________________________________________________ + + +--[003] The Headers Do Not Match My Kernel Version ----------------------------- + + The kernel headers in KISS are pinned to an LTS kernel version and are only + updated when there are changes of interest in the kernel or headers themselves + (usually by users requesting new features available in the newer headers). + + The headers are backwards compatible and are fully usable with a matching or + _newer_ kernel version. There are two cases where you'd be required to update + the headers yourself. + + 1. To run a kernel _older_ than the default headers. + 2. To make use of features in your _newer_ kernel version. + + +[004] References +________________________________________________________________________________ + +[0] https://www.kernel.org/doc/Documentation/kbuild/headers_install.txt + diff --git a/core/m4/README b/core/m4/README new file mode 100644 index 00000000..7329b88d --- /dev/null +++ b/core/m4/README @@ -0,0 +1,40 @@ +m4 +________________________________________________________________________________ + +GNU m4 is an implementation of m4 for the GNU Project. It is designed to avoid +many kinds of arbitrary limits found in traditional m4 implementations, such as +maximum line lengths, maximum size of a macro and number of macros. Removing +such arbitrary limits is one of the stated goals of the GNU Project. [0] + +Upstream: https://www.gnu.org/software/m4/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b m4 | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/M4_(computer_language) + diff --git a/core/make/README b/core/make/README new file mode 100644 index 00000000..42500100 --- /dev/null +++ b/core/make/README @@ -0,0 +1,45 @@ +make +________________________________________________________________________________ + +GNU Make (short gmake) is the standard implementation of Make for Linux and +macOS. It provides several extensions over the original Make, such as +conditionals. It also provides many built-in functions which can be used to +eliminate the need for shell-scripting in the makefile rules as well as to +manipulate the variables set and used in the makefile. For example, the foreach +function can be used to iterate over a list of values, such as the names of +files in a given directory. GNU Make is required for building many software +systems, including GCC (since version 3.4), the Linux kernel, LibreOffice and +Mozilla Firefox. [0] + +Upstream: https://www.gnu.org/software/make/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b make | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Make_(software) + diff --git a/core/musl/README b/core/musl/README new file mode 100644 index 00000000..6f877f61 --- /dev/null +++ b/core/musl/README @@ -0,0 +1,54 @@ +musl +________________________________________________________________________________ + +musl is a C standard library intended for operating systems based on the Linux +kernel, released under the MIT License. It was developed by Rich Felker with the +goal to write a clean, efficient and standards-conformant libc implementation. + +musl was designed from scratch to allow efficient static linking and to have +realtime-quality robustness by avoiding race conditions, internal failures on +resource exhaustion and various other bad worst-case behaviors present in +existing implementations. The dynamic runtime is a single file with stable ABI +allowing race-free updates and static linking support allows an application to +be deployed as a single portable binary without significant size overhead. [0] + + +Upstream: https://www.musl-libc.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b pkg | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +musl does not come with any documentation. For C library documentation, install +the man-pages package. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b man-pages | +| | ++------------------------------------------------------------------------------+ + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Musl + diff --git a/core/openssl/README b/core/openssl/README new file mode 100644 index 00000000..aa9c3af7 --- /dev/null +++ b/core/openssl/README @@ -0,0 +1,47 @@ +openssl +________________________________________________________________________________ + +OpenSSL is a software library for applications that secure communications over +computer networks against eavesdropping or need to identify the party at the +other end. It is widely used by Internet servers, including the majority of +HTTPS websites. + +OpenSSL contains an open-source implementation of the SSL and TLS protocols. +The core library, written in the C programming language, implements basic +cryptographic functions and provides various utility functions. Wrappers +allowing the use of the OpenSSL library in a variety of computer languages are +available. [0] + +Upstream: https://www.openssl.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b openssl | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. To update the system's SSL +certificates, run /etc/ssl/update-certdata.sh. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/OpenSSL + diff --git a/core/pigz/README b/core/pigz/README new file mode 100644 index 00000000..ce4478f3 --- /dev/null +++ b/core/pigz/README @@ -0,0 +1,49 @@ +pigz +________________________________________________________________________________ + +pigz, which stands for parallel implementation of gzip, is a fully functional +replacement for gzip that exploits multiple processors and multiple cores to the +hilt when compressing data. pigz was written by Mark Adler, and uses the zlib +and pthread libraries. [0] + +Upstream: https://zlib.net/pigz/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b pigz | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use pigz as the package manager's compression method for build tarballs, set +the environment variable KISS_COMPRESS to 'gz'. If pigz will not be used as +the package manager's compression method, no such setup is required. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://zlib.net/pigz/ + diff --git a/core/xz/README b/core/xz/README new file mode 100644 index 00000000..b1056614 --- /dev/null +++ b/core/xz/README @@ -0,0 +1,53 @@ +xz +________________________________________________________________________________ + +XZ Utils (previously LZMA Utils) is a set of free software command-line lossless +data compressors, including lzma and xz, for Unix-like operating systems and, +from version 5.0 onwards, Microsoft Windows. + +In most cases, xz achieves higher compression rates than alternatives like gzip +and bzip2. Decompression speed is faster than bzip2, but slower than gzip. +Compression can be much slower than gzip, and is slower than bzip2 for high +levels of compression, and is most useful when a compressed file will be used +many times. [0] + +Upstream: https://tukaani.org/xz/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b xz | +| | ++------------------------------------------------------------------------------+ + +[002] Setup +________________________________________________________________________________ + +To use xz as the package manager's compression method for build tarballs, set +the environment variable KISS_COMPRESS to 'xz'. If xz will not be used as the +package manager's compression method, no such setup is required. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/XZ_Utils + diff --git a/core/zlib/README b/core/zlib/README new file mode 100644 index 00000000..aee9efa9 --- /dev/null +++ b/core/zlib/README @@ -0,0 +1,42 @@ +zlib +________________________________________________________________________________ + +zlib is a software library used for data compression. zlib was written by +Jean-loup Gailly and Mark Adler and is an abstraction of the DEFLATE compression +algorithm used in their gzip file compression program. zlib is also a crucial +component of many software platforms, including Linux, macOS, and iOS. It has +also been used in gaming consoles such as the PlayStation 4, PlayStation 3, +Wii U, Wii, Xbox One and Xbox 360. [0] + +Upstream: https://en.wikipedia.org/wiki/Zlib + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b zlib | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Zlib + diff --git a/extra/adwaita-icon-theme/README b/extra/adwaita-icon-theme/README new file mode 100644 index 00000000..35703de7 --- /dev/null +++ b/extra/adwaita-icon-theme/README @@ -0,0 +1,48 @@ +adwaita-icon-theme +________________________________________________________________________________ + +Mostly private use system icons. [0] + +Upstream: https://gitlab.gnome.org/GNOME/adwaita-icon-theme + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b adwaita-icon-theme | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +If this is the only icon theme installed it should be automatically used and +no setup is needed. To explicitly set this as the icon theme, edit +~/.config/gtk-3.0/settings.ini and add the following two lines. + ++------------------------------------------------------------------------------+ +| | +| ~/.config/gtk-3.0/settings.ini | +| | +| 1 [Settings] | +| 2 gtk-icon-theme-name=Adwaita | +| | ++------------------------------------------------------------------------------+ + + +[003] References +________________________________________________________________________________ + +[0] https://gitlab.gnome.org/GNOME/adwaita-icon-theme + diff --git a/extra/alsa-lib/README b/extra/alsa-lib/README new file mode 100644 index 00000000..d93d78dd --- /dev/null +++ b/extra/alsa-lib/README @@ -0,0 +1,39 @@ +alsa-lib +________________________________________________________________________________ + +The ALSA library API is the interface to the ALSA drivers. Developers need to +use the functions in this API to achieve native ALSA support for their +applications. [0] + +Upstream: https://www.alsa-project.org/wiki/Main_Page + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b alsa-lib | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the online documentation as the package does not yet provide any. [0] + + +[003] References +________________________________________________________________________________ + +[0] https://www.alsa-project.org/wiki/ALSA_Library_API + diff --git a/extra/alsa-utils/README b/extra/alsa-utils/README new file mode 100644 index 00000000..4203177e --- /dev/null +++ b/extra/alsa-utils/README @@ -0,0 +1,61 @@ +alsa-utils +________________________________________________________________________________ + +This package contains the command line utilities for the ALSA project. The +package can be compiled only with the installed ALSA driver and the ALSA C +library (alsa-lib). [0] + +Upstream: https://alsa-project.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b alsa-utils | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + ++--------------+---------------------------------------------------------------+ +| Tool | Purpose | ++--------------+---------------------------------------------------------------+ +| | | +| alsa-info | Gather information about ALSA subsystem. | +| alsabat | Sound tester for ALSA sound card driver. | +| alsaconf | The ALSA driver configurator script. | +| alsactl | Soundcard settings management. | +| alsaloop | Software loopback for PCM devices. | +| alsamixer | ncurses mixer. | +| alsatplg | ALSA topology compiler. | +| alsaucm | Use Case Manager utility. | +| amidi | Send/receive sysex dumps or other MIDI data. | +| amixer | Command-line mixer. | +| aplay | Playback .wav,.voc,.au files. | +| arecord | Record .wav,.voc,.au files. | +| axfer | Transfer audio data frame (enhancement of aplay). | +| iecset | Show/set the IEC958 status bits. | +| speaker-test | Speaker test utility. | +| | | ++--------------+---------------------------------------------------------------+ + +Refer to the manual pages and help output for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/alsa-project/alsa-utils + diff --git a/extra/atk/README b/extra/atk/README new file mode 100644 index 00000000..5ea8de29 --- /dev/null +++ b/extra/atk/README @@ -0,0 +1,44 @@ +atk +________________________________________________________________________________ + +Accessibility Toolkit (ATK) is an open source software library, part of the +GNOME project, which provides application programming interfaces (APIs) for +implementing accessibility support in software. [0] + +This package is a dependency of GTK+3 and Firefox. Its use in the future will +be determined solely on whether or not its use can be patched out of +aforementioned software. + +Upstream: https://wiki.gnome.org/Accessibility + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b atk | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Accessibility_Toolkit + diff --git a/extra/cairo/README b/extra/cairo/README new file mode 100644 index 00000000..ff2b119d --- /dev/null +++ b/extra/cairo/README @@ -0,0 +1,41 @@ +cairo +________________________________________________________________________________ + +Cairo (stylized as cairo) is an open source graphics library that provides a +vector graphics-based, device-independent API for software developers. It +provides primitives for two-dimensional drawing across a number of different +backends. Cairo uses hardware acceleration when available. [0] + +Upstream: https://www.cairographics.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b cairo | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Cairo_(graphics) + diff --git a/extra/cbindgen/README b/extra/cbindgen/README new file mode 100644 index 00000000..2a051da7 --- /dev/null +++ b/extra/cbindgen/README @@ -0,0 +1,44 @@ +cbindgen +________________________________________________________________________________ + +cbindgen creates C/C++11 headers for Rust libraries which expose a public C API. + +While you could do this by hand, it's not a particularly good use of your time. +It's also much more likely to be error-prone than machine-generated headers that +are based on your actual Rust code. The cbindgen developers have also worked +closely with the developers of Rust to ensure that the headers we generate +reflect actual guarantees about Rust's type layout and ABI. [0] + +Upstream: https://github.com/eqrion/cbindgen + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b cbindge | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. $/eqrion/cbindgen/blob/master/docs.md + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/eqrion/cbindgen + diff --git a/extra/ccache/README b/extra/ccache/README new file mode 100644 index 00000000..2bb64740 --- /dev/null +++ b/extra/ccache/README @@ -0,0 +1,72 @@ +ccache +________________________________________________________________________________ + +Ccache is a software development tool that caches the output of C/C++ +compilation so that the next time, the same compilation can be avoided and the +results can be taken from the cache. This can greatly speed up recompiling time. +The detection is done by hashing different kinds of information that should be +unique for the compilation and then using the hash sum to identify the cached +output. Ccache is licensed under the GNU General Public License. [0] + +Upstream: https://ccache.dev/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ccache | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use ccache system-wide add the following to your .profile or shell runtime +configuration file. This will use ccache's wrappers in place of the actual +executables. + ++------------------------------------------------------------------------------+ +| | +| .profile | +| | +| 1 export PATH=/usr/lib/ccache/bin:$PATH | +| | ++------------------------------------------------------------------------------+ + +If using clang as the system compiler the setup is a little different. Do the +above step and in addition, create the following symbolic links. + ++------------------------------------------------------------------------------+ +| | +| $ ln -s /usr/bin/ccache /usr/lib/ccache/bin/clang | +| $ ln -s /usr/bin/ccache /usr/lib/ccache/bin/clang++ | +| | ++------------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +Refer to the command help output. The package does not yet provide any such +documentation. There is also documentation available online. To verify that +ccache is working the 'ccache -s' command can be used. + + +[005] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Ccache + diff --git a/extra/clang/README b/extra/clang/README new file mode 100644 index 00000000..ddef9fb9 --- /dev/null +++ b/extra/clang/README @@ -0,0 +1,68 @@ +clang +________________________________________________________________________________ + +Clang is a compiler front end for the C, C++, Objective-C and Objective-C++ +programming languages, as well as the OpenMP, OpenCL, RenderScript, CUDA and +HIP frameworks. It uses the LLVM compiler infrastructure as its back end and has +been part of the LLVM release cycle since LLVM 2.6. + +It is designed to act as a drop-in replacement for the GNU Compiler Collection +(GCC), supporting most of its compilation flags and unofficial language +extensions. Its contributors include Apple, Microsoft, Google, ARM, Sony, +Intel and Advanced Micro Devices (AMD). [0] + +Upstream: https://clang.llvm.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b clang | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use clang as the system compiler, set the following environment variables in +your .profile or shell runtime configuration file. + ++------------------------------------------------------------------------------+ +| | +| $ export CC=clang | +| $ export CXX=clang++ | +| | ++------------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +Refer to the command help output. This package does not yet provide manual +pages. Documentation can also be found online. + + +[004] Troubleshooting +________________________________________________________________________________ + +If a package fails to build with clang, open an issue at $/kisslinux/repo + + +[005] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Clang + diff --git a/extra/cmake/README b/extra/cmake/README new file mode 100644 index 00000000..000c2175 --- /dev/null +++ b/extra/cmake/README @@ -0,0 +1,63 @@ +cmake +________________________________________________________________________________ + +CMake is cross-platform free and open-source software for build automation, +testing, packaging and installation of software by using a compiler-independent +method. CMake is not a build system but rather it generates another system's +build files. It supports directory hierarchies and applications that depend on +multiple libraries. It is used in conjunction with native build environments +such as Make, Qt Creator, Ninja, Android Studio, Apple's Xcode, and Microsoft +Visual Studio. [0] + +Upstream: https://cmake.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b cmake | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +Cmake supports to output methods on Linux; 'GNU Makefiles' and 'Ninja' with the +former being the default value. These values are set via the CMAKE_GENERATOR +environment variable. + +The distribution recommends this value be set to 'Ninja' as it offers a +performance improvement over make and works better with ccache. Set the +following environment variable in your .profile or shell runtime file. + ++------------------------------------------------------------------------------+ +| | +| $ export CMAKE_GENERATOR=Ninja | +| | ++------------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +Refer to the command help output and online documentation. This package does +not yet provide manual pages. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/CMake + diff --git a/extra/dhcpcd/README b/extra/dhcpcd/README new file mode 100644 index 00000000..ac5bd75e --- /dev/null +++ b/extra/dhcpcd/README @@ -0,0 +1,56 @@ +dhcpcd +________________________________________________________________________________ + +dhcpcd is an implementation of the DHCP client specified in RFC 2131. dhcpcd +gets the host information (IP address, routes, etc) from a DHCP server and +configures the network interface of the machine on which it is running. + +dhcpcd then runs the configuration script which writes DNS information to +resolvconf(8), if available, otherwise directly to /etc/resolv.conf. If the +hostname is currently blank, (null) or localhost, or force_hostname is YES or +TRUE or 1 then dhcpcd sets the hostname to the one supplied by the DHCP server. +dhcpcd then daemonises and waits for the lease renewal time to lapse. It will +then attempt to renew its lease and reconfigure if the new lease changes. [0] + +Upstream: https://roy.marples.name/projects/dhcpcd/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b dhcpcd | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +This package provides a service file compatible with the distribution's default +service manager. Refer to the distribution's service management documentation +for instructions on how to enable the service. [1] + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] dhcpcd.8 +[1] #/wiki/service-management + diff --git a/extra/dosfstools/README b/extra/dosfstools/README new file mode 100644 index 00000000..8c85723b --- /dev/null +++ b/extra/dosfstools/README @@ -0,0 +1,49 @@ +dosfstools +________________________________________________________________________________ + +dosfstools consists of the programs mkfs.fat, fsck.fat and fatlabel to create, +check and label file systems of the FAT family. The dosfstools are licensed +under the GNU GPL version 3 or later. See the file COPYING for details. [0] + +Upstream: https://github.com/dosfstools/dosfstools + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b dosfstools | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + ++--------------+---------------------------------------------------------------+ +| Tool | Purpose | ++--------------+---------------------------------------------------------------+ +| | | +| mkfs.fat | Create an MS-DOS FAT filesystem. | +| fsck.fat | Check and repair MS-DOS FAT. | +| fatlabel | Set or get MS-DOS filesystem label or volume ID. | +| | | ++--------------+---------------------------------------------------------------+ + +Refer to the manual pages and command help output for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/dosfstools/dosfstools + diff --git a/extra/e2fsprogs/README b/extra/e2fsprogs/README new file mode 100644 index 00000000..d524a967 --- /dev/null +++ b/extra/e2fsprogs/README @@ -0,0 +1,62 @@ +e2fsprogs +________________________________________________________________________________ + +e2fsprogs (sometimes called the e2fs programs) is a set of utilities for +maintaining the ext2, ext3 and ext4 file systems. Since those file systems are +often the default for Linux distributions, it is commonly considered to be +essential software. [0] + +Upstream: http://e2fsprogs.sourceforge.net/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b e2fsprogs | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + ++--------------+---------------------------------------------------------------+ +| Tool | Purpose | ++--------------+---------------------------------------------------------------+ +| | | +| e4defrag | Online defragmenter for ext4 filesystems. | +| e4crypt | ext4 filesystem encryption utility. | +| e2undo | Replay an undo log for an ext[234] filesystem. | +| e2scrub_all | Check all mounted ext[234] filesystems for errors. | +| e2scrub | Check the contents of a mounted ext[234] filesystem. | +| e2mmpstatus | Check MMP status of an ext4 filesystem. | +| e2label | Change the label on an ext[234] filesystem. | +| e2image | Save critical ext[234] filesystem metadata to a file. | +| e2fsck | Check a Linux ext[234] filesystem. | +| e2freefrag | Report free space fragementation information. | +| dumpe2fs | Dump ext[234] filesystem information. | +| debugfs | ext[234] filesystem debugger. | +| compile_et | Error table compiler. | +| chattr | Change file attributes on a Linux filesystem. | +| badblocks | Search a device for bad blocks. | +| | | ++--------------+---------------------------------------------------------------+ + +Refer to the manual pages and command help output for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/E2fsprogs + diff --git a/extra/efibootmgr/README b/extra/efibootmgr/README new file mode 100644 index 00000000..293ba2ea --- /dev/null +++ b/extra/efibootmgr/README @@ -0,0 +1,84 @@ +efibootmgr +________________________________________________________________________________ + +This is efibootmgr, a Linux user-space application to modify the Intel +Extensible Firmware Interface (EFI) Boot Manager. This application can create +and destroy boot entries, change the boot order, change the next running boot +option, and more. + +Upstream: https://github.com/rhboot/efibootmgr + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] + * Mounting The efivar Filesystem ....................................... [003] + * Booting The System With An EFISTUB ................................... [004] +* Usage .................................................................. [005] +* References ............................................................. [006] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b efibootmgr | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + + +--[003] Mounting The efivar Filesystem ----------------------------------------- + + To use efibootmgr and other software to manipulate the UEFI boot entries, the + efivars filesystem must be mounted. This isn't handled automatically by KISS + due to the security implications in doing so. [1] + + +----------------------------------------------------------------------------+ + | | + | $ mount -t efivarfs none /sys/firmware/efi/efivars/ | + | | + +----------------------------------------------------------------------------+ + + +--[004] Booting The System With An EFISTUB ------------------------------------- + + Using an EFISTUB to boot the system removes the need for a bootloader and + shortens boot times. Ensure that the following options are enabled in your + kernel: CONFIG_EFI, CONFIG_EFI_STUB + + Run the following command to create a boot entry (replacing example arguments + with their respective values). X and Y should point to where the ESP is + located. + + +----------------------------------------------------------------------------+ + | | + | $ efibootmgr \ | + | --disk /dev/sdX \ | + | --part Y \ | + | --create \ | + | --label "KISS" \ | + | --loader /vmlinuz \ | + | --unicode 'root=PARTUUID=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX rw' \ | + | --verbose | + | | + +----------------------------------------------------------------------------+ + + +[005] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output for more information. + + +[006] References +________________________________________________________________________________ + +[0] https://github.com/rhboot/efibootmgr +[1] https://github.com/systemd/systemd/issues/2402 diff --git a/extra/efivar/README b/extra/efivar/README new file mode 100644 index 00000000..07fd1d66 --- /dev/null +++ b/extra/efivar/README @@ -0,0 +1,37 @@ +efivar +________________________________________________________________________________ + +Tools and libraries to work with EFI variables [0] + +Upstream: https://github.com/rhboot/efivar + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b efivar | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/rhboot/efivar + diff --git a/extra/eiwd/README b/extra/eiwd/README new file mode 100644 index 00000000..a06e3249 --- /dev/null +++ b/extra/eiwd/README @@ -0,0 +1,150 @@ +eiwd +________________________________________________________________________________ + +eiwd is iNet Wireless Daemon (iwd) without dbus. This package only provides +the iwd daemon and does not include any clients. Usage is config file based. + +Upstream: https://github.com/illiliti/eiwd + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] + * Create The Configuration File ........................................ [003] + * Add The Following Lines .............................................. [004] + * Connecting To Networks ............................................... [005] +* Usage .................................................................. [006] + * Starting The Service ................................................. [007] +* Troubleshooting ........................................................ [008] + * iwd Fails To Start ................................................... [009] +* References ............................................................. [010] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b eiwd | +| $ kiss b openresolv | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + + +--[003] Create The Configuration File ------------------------------------------ + + +----------------------------------------------------------------------------+ + | | + | $ mkdir -p /etc/iwd | + | $ touch /etc/iwd/main.conf | + | | + +----------------------------------------------------------------------------+ + + +--[004] Add The Following Lines ------------------------------------------------ + + +----------------------------------------------------------------------------+ + | | + | main.conf | + | | + | [General] | + | EnableNetworkConfiguration=true | + | | + | [Network] | + | RoutePriorityOffset=200 | + | NameResolvingService=resolvconf | + | | + +----------------------------------------------------------------------------+ + + To prevent iwd from scanning continuously while not connected, add the + following lines. + + +----------------------------------------------------------------------------+ + | | + | [Scan] | + | DisablePeriodicScan=true | + | | + +----------------------------------------------------------------------------+ + + To prevent iwd from destroying / recreating wireless interfaces at startup, + add the following line to [General]. + + +----------------------------------------------------------------------------+ + | | + | UseDefaultInterface=true | + | | + +----------------------------------------------------------------------------+ + + +--[005] Connecting To Networks ------------------------------------------------- + + +----------------------------------------------------------------------------+ + | | + | $ printf 'password\n' | iwd_passphrase ssid | + | | + +----------------------------------------------------------------------------+ + | | + | The iwd_passhprase tool prints its help messages to stderr. Run the tool | + | once to get information and a second time with '> /var/lib/iwd/FILE' to | + | save it directly. | + | | + +----------------------------------------------------------------------------+ + + The iwd daemon watches the /var/lib/iwd directory for changes to network + configs. When it detects creation of a config, it will at once become aware + of it. Other filesystem operations changes behavior as well. + + +[006] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +--[007] Starting The Service --------------------------------------------------- + + This package provides a service file compatible with the distribution's + default service manager. Refer to the distribution's service management + documentation for instructions on how to enable the service. [1] + + +[008] Troubleshooting +________________________________________________________________________________ + + +--[009] iwd Fails To Start ----------------------------------------------------- + + Ensure that the following options are enabled in your kernel. + + +----------------------------------------------------------------------------+ + | | + | CONFIG_CRYPTO_USER_API_HASH | + | CONFIG_CRYPTO_USER_API_SKCIPHER | + | CONFIG_KEY_DH_OPERATIONS | + | CONFIG_CRYPTO_ECB | + | CONFIG_CRYPTO_MD5 | + | CONFIG_CRYPTO_CBC | + | CONFIG_CRYPTO_SHA256 | + | CONFIG_CRYPTO_AES | + | CONFIG_CRYPTO_DES | + | CONFIG_CRYPTO_CMAC | + | CONFIG_CRYPTO_HMAC | + | CONFIG_CRYPTO_SHA512 | + | CONFIG_CRYPTO_ARC4 | + | CONFIG_CRYPTO_SHA1 | + | | + +----------------------------------------------------------------------------+ + + +[010] References +________________________________________________________________________________ + +[0] https://github.com/illiliti/eiwd +[1] #/wiki/service-management + diff --git a/extra/expat/README b/extra/expat/README new file mode 100644 index 00000000..16b47142 --- /dev/null +++ b/extra/expat/README @@ -0,0 +1,41 @@ +expat +________________________________________________________________________________ + +Expat is a stream-oriented XML 1.0 parser library, written in C. As one of the +first available open-source XML parsers, Expat has found a place in many +open-source projects. Such projects include the Apache HTTP Server, Mozilla, +Perl, Python and PHP. It is also bound in many other languages. [0] + +Upstream: https://libexpat.github.io/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b expat | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Expat_(library) + diff --git a/extra/ffmpeg/README b/extra/ffmpeg/README new file mode 100644 index 00000000..c536346d --- /dev/null +++ b/extra/ffmpeg/README @@ -0,0 +1,42 @@ +ffmpeg +________________________________________________________________________________ + +FFmpeg is a free and open-source software project consisting of a large suite of +libraries and programs for handling video, audio, and other multimedia files and +streams. At its core is the FFmpeg program itself, designed for +command-line-based processing of video and audio files. It is widely used for +format transcoding, basic editing (trimming and concatenation), video scaling, +video post-production effects and standards compliance (SMPTE, ITU). [0] + +Upstream: https://www.ffmpeg.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ffmpeg | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/FFmpeg + diff --git a/extra/firefox-privacy/README b/extra/firefox-privacy/README new file mode 100644 index 00000000..9e514bbd --- /dev/null +++ b/extra/firefox-privacy/README @@ -0,0 +1,51 @@ +firefox-privacy +________________________________________________________________________________ + +This package provides a vendor.js and enterprise policy which when used cause +firefox to make zero unsolicited web requests (at the cost of some website +breakage, YMMV). + +Upstream: $/kisslinux/repo + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* Troubleshooting ........................................................ [003] + * Firefox phones home .................................................. [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b firefox-privacy | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Restart Firefox and the changes will take effect. Uninstalling the package does +the reverse. + + +[003] Troubleshooting +________________________________________________________________________________ + + +--[004] Firefox phones home ---------------------------------------------------- + + If you encounter Firefox phoning home, open an issue at $/kisslinux/repo + + +[005] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org + diff --git a/extra/firefox/README b/extra/firefox/README new file mode 100644 index 00000000..a971327c --- /dev/null +++ b/extra/firefox/README @@ -0,0 +1,126 @@ +firefox +________________________________________________________________________________ + +Mozilla Firefox or simply Firefox, is a free and open-source web browser +developed by the Mozilla Foundation and its subsidiary, the Mozilla Corporation. +Firefox uses the Gecko rendering engine to display web pages. [0] + +Upstream: https://www.mozilla.org/firefox + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] + * Runtime Dependencies ................................................. [002] + * Privacy Package ...................................................... [003] +* Setup .................................................................. [004] + * Enable VAAPI Acceleration ............................................ [005] +* Usage .................................................................. [006] +* References ............................................................. [007] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b firefox | +| | ++------------------------------------------------------------------------------+ + + +--[002] Runtime Dependencies --------------------------------------------------- + + Firefox needs a few additional things to be fully functional. One is an icon + theme and the other is a font. If you have already installed the fonts and + icon theme of your choosing, this step can be skipped. + + +----------------------------------------------------------------------------+ + | | + | $ kiss b [hicolor-icon-theme|adwaita-icon-theme] | + | $ kiss b ttf-croscore | + | | + +----------------------------------------------------------------------------+ + + +--[003] Privacy Package -------------------------------------------------------- + + Provided is also an optional privacy package which makes Firefox perform zero + unsolicited network requests. More information can be found in the + documentation (@/firefox-privacy) Expect some website breakage when using this + privacy package YMMV. + + +----------------------------------------------------------------------------+ + | | + | $ kiss b firefox-privacy | + | | + +----------------------------------------------------------------------------+ + + +[004] Setup +________________________________________________________________________________ + +As of Firefox 91. There is no need to set special environment variables to +enable Wayland support (in a Wayland only environment like ours). The browser +should start with no further configuration. + + +--[005] Enable VAAPI Acceleration ---------------------------------------------- + +Make sure that the following are set in your about:config page. + ++------------------------------------------------------------------------------+ +| | +| about:config | +| | +| gfx.webrender.all=true | +| media.av1.enabled=false | +| media.ffmpeg.dmabuf-textures.disabled=false | +| media.ffmpeg.vaapi.enabled=true | +| media.ffvpx.enabled=false | +| | ++------------------------------------------------------------------------------+ + +If using AMDGPU, the following kernel option must be enabled. [1] + ++------------------------------------------------------------------------------+ +| | +| .config | +| | +| CONFIG_CHECKPOINT_RESTORE=y | +| | ++------------------------------------------------------------------------------+ + +You may also need to set the following environment variable. + ++------------------------------------------------------------------------------+ +| | +| .profile | +| | +| export MOZ_WAYLAND_DRM_DEVICE=/dev/dri/renderD128 | +| | ++------------------------------------------------------------------------------+ + +To verify that VAAPI is working, launch Firefox with the following argument and +attempt to watch a video. Pay attention for errors in the output. + ++------------------------------------------------------------------------------+ +| | +| $ firefox --MOZ_LOG=PlatformDecoderModule:4 | +| | ++------------------------------------------------------------------------------+ + + +[006] Usage +________________________________________________________________________________ + +Refer to the browser's help output and online documentation for further +information. + + +[007] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Firefox + diff --git a/extra/fontconfig/README b/extra/fontconfig/README new file mode 100644 index 00000000..e69bd956 --- /dev/null +++ b/extra/fontconfig/README @@ -0,0 +1,41 @@ +Package Name +________________________________________________________________________________ + +Fontconfig (or fontconfig) is a free software program library designed to +provide configuration, enumeration and substitution of fonts to other programs. +Fontconfig was originally written and maintained by Keith Packard, and is +currently maintained by Behdad Esfahbod. [0] + +Upstream: https://www.freedesktop.org/wiki/Software/fontconfig/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b fontconfig | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Fontconfig + diff --git a/extra/freetype-harfbuzz/README b/extra/freetype-harfbuzz/README new file mode 100644 index 00000000..d579a3e5 --- /dev/null +++ b/extra/freetype-harfbuzz/README @@ -0,0 +1,57 @@ +freetype-harfbuzz +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| This package is actually two packages: freetype and harfbuzz. To circumvent | +| the circular dependency between them, they have been merged together. | +| | ++------------------------------------------------------------------------------+ + +FreeType is a popular software development library used to render text onto +bitmaps, and provides support for other font-related operations. The FreeType +font rasterization engine is free and open-source software with the source code +dual-licensed under a BSD-like license and the GPL. FreeType supports a number +of font formats, including TrueType, Type 1, and OpenType and "is designed to +be small, efficient, highly customizable, and portable while capable of +producing high-quality output (glyph images)." [0] + +HarfBuzz is a software development library for text shaping, which is the +process of converting Unicode text to glyph indices and positions. The newer +version, New HarfBuzz (2012–), targets various font technologies while the first +version, Old HarfBuzz (2006–2012), targeted only OpenType fonts. [1] + +Upstream: https://www.freetype.org/ https://github.com/harfbuzz/harfbuzz + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b freetype-harfbuzz | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/FreeType +[1] https://en.wikipedia.org/wiki/HarfBuzz + diff --git a/extra/gdk-pixbuf/README b/extra/gdk-pixbuf/README new file mode 100644 index 00000000..df2b9857 --- /dev/null +++ b/extra/gdk-pixbuf/README @@ -0,0 +1,40 @@ +gdk-pixbuf +________________________________________________________________________________ + +GdkPixbuf is a library that loads image data in various formats and stores it as +linear buffers in memory. The buffers can then be scaled, composited, modified, +saved, or rendered. [0] + +Upstream: https://gitlab.gnome.org/GNOME/gdk-pixbuf + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b gdk-pixbuf | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation and command output for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://gitlab.gnome.org/GNOME/gdk-pixbuf + diff --git a/extra/glib/README b/extra/glib/README new file mode 100644 index 00000000..896b3cbd --- /dev/null +++ b/extra/glib/README @@ -0,0 +1,40 @@ +glib +________________________________________________________________________________ + +GLib is a bundle of three (formerly five) low-level system libraries written in +C and developed mainly by GNOME. GLib's code was separated from GTK, so it can +be used by other software and has been developed in parallel ever since. [0] + +Upstream: https://wiki.gnome.org/Projects/GLib + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b glib | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation and command output for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/GLib + diff --git a/extra/gnugrep/README b/extra/gnugrep/README new file mode 100644 index 00000000..2af3a00d --- /dev/null +++ b/extra/gnugrep/README @@ -0,0 +1,62 @@ +gnugrep +________________________________________________________________________________ + +grep is a command-line utility for searching plain-text data sets for lines that +match a regular expression. Its name comes from the ed command g/re/p (globally +search for a regular expression and print matching lines), which has the same +effect. grep was originally developed for the Unix operating system, but later +available for all Unix-like systems and some others such as OS-9. [0] + +Upstream: https://www.gnu.org/software/grep/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b gnugrep | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use GNU grep as the system grep, the alternatives system must be used. The +GNU grep implementation is very fast [1] and is recommended over the default +provided by busybox. + ++------------------------------------------------------------------------------+ +| | +| $ kiss a gnugrep /usr/bin/grep | +| $ kiss a gnugrep /usr/bin/egrep | +| $ kiss a gnugrep /usr/bin/fgrep | +| | ++------------------------------------------------------------------------------+ + +To undo these changes run 'kiss a', find the relevant output and run the +corresponding commands. Each line of output from 'kiss a' is a valid command +to give back to 'kiss a'. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Grep +[1] https://lists.freebsd.org/pipermail/freebsd-current/2010-August/019310.html diff --git a/extra/gnupg1/README b/extra/gnupg1/README new file mode 100644 index 00000000..41b6df96 --- /dev/null +++ b/extra/gnupg1/README @@ -0,0 +1,40 @@ +gnupg1 +________________________________________________________________________________ + +GnuPG is GNU's tool for secure communication and data storage. It can be used to +encrypt data and to create digital signatures. It includes an advanced key +management facility and is compliant with the proposed OpenPGP Internet standard +as described in RFC 4880. [0] + +Upstream: https://gnupg.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b gnupg1 | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://packages.debian.org/sid/gnupg1 + diff --git a/extra/gtk+3/README b/extra/gtk+3/README new file mode 100644 index 00000000..47758957 --- /dev/null +++ b/extra/gtk+3/README @@ -0,0 +1,42 @@ +gtk+3 +________________________________________________________________________________ + +GTK (formerly GTK+, GIMP ToolKit) is a free and open-source cross-platform +widget toolkit for creating graphical user interfaces (GUIs). It is licensed +under the terms of the GNU Lesser General Public License, allowing both free and +proprietary software to use it. It is one of the most popular toolkits for the +Wayland and X11 windowing systems. [0] + +Upstream: https://docs.gtk.org/gtk3/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b gtk+3 | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org + diff --git a/extra/hicolor-icon-theme/README b/extra/hicolor-icon-theme/README new file mode 100644 index 00000000..9e47ca9f --- /dev/null +++ b/extra/hicolor-icon-theme/README @@ -0,0 +1,38 @@ +hicolor-icon-theme +________________________________________________________________________________ + +The hicolor-icon-theme package contains a default fallback theme for +implementations of the icon theme specification. [0] + +Upstream: https://www.freedesktop.org/wiki/Software/icon-theme/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b hicolor-icon-theme | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://www.linuxfromscratch.org/blfs/view/svn/x/hicolor-icon-theme.html + diff --git a/extra/intel-vaapi-driver/README b/extra/intel-vaapi-driver/README new file mode 100644 index 00000000..3cc71f5d --- /dev/null +++ b/extra/intel-vaapi-driver/README @@ -0,0 +1,46 @@ +intel-vaapi-driver +________________________________________________________________________________ + +VA-API (Video Acceleration API) user mode driver for Intel GEN Graphics family. + +VA-API is an open-source library and API specification, which provides access to +graphics hardware acceleration capabilities for video processing. It consists of +a main library and driver-specific acceleration backends for each supported +hardware vendor. The current video driver backend provides a bridge to the GEN +GPUs through the packaging of buffers and commands to be sent to the i915 driver +for exercising both hardware and shader functionality for video decode, encode, +and processing. [0] + +Upstream: https://01.org/linuxmedia/vaapi + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b intel-vaapi-driver | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/intel/intel-vaapi-driver + diff --git a/extra/json-c/README b/extra/json-c/README new file mode 100644 index 00000000..15900fdf --- /dev/null +++ b/extra/json-c/README @@ -0,0 +1,41 @@ +json-c +________________________________________________________________________________ + +JSON-C implements a reference counting object model that allows you to easily +construct JSON objects in C, output them as JSON formatted strings and parse +JSON formatted strings back into the C representation of JSON objects. It aims +to conform to RFC 7159. [0] + +Upstream: https://github.com/json-c/json-c + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b json-c | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/json-c/json-c + diff --git a/extra/kirc/README b/extra/kirc/README new file mode 100644 index 00000000..e7c84239 --- /dev/null +++ b/extra/kirc/README @@ -0,0 +1,40 @@ +kirc +________________________________________________________________________________ + +kirc is an extremely fast and simple IRC client designed with portability in +mind. This client reads from stdin and prints to stdout, so all traffic can +multiplexed and text parsed or modified using external commands. All highlighted +text and color can be controlled with ANSI escape sequences. [0] + +Upstream: http://kirc.io/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b kirc | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] Manual page. + diff --git a/extra/lame/README b/extra/lame/README new file mode 100644 index 00000000..27a88ca4 --- /dev/null +++ b/extra/lame/README @@ -0,0 +1,42 @@ +lame +________________________________________________________________________________ + +LAME is a software encoder that converts a digitized WAV audio file into the MP3 +audio coding file format. LAME is a free software project that was first +released in 1998, and has incorporated many improvements since then, including +an improved psychoacoustic model. The LAME encoder outperforms early encoders +like L3enc. [0] + +Upstream: https://lame.sourceforge.io/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b lame | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. No library documentation is +yet provided. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/LAME + diff --git a/extra/libass/README b/extra/libass/README new file mode 100644 index 00000000..829b6db3 --- /dev/null +++ b/extra/libass/README @@ -0,0 +1,40 @@ +libass +________________________________________________________________________________ + +libass is a portable subtitle renderer for the ASS/SSA +(Advanced Substation Alpha/Substation Alpha) subtitle format. It is mostly +compatible with VSFilter. [0] + +Upstream: https://github.com/libass/libass + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libass | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/libass/libass + diff --git a/extra/libelf/README b/extra/libelf/README new file mode 100644 index 00000000..cc61ab3a --- /dev/null +++ b/extra/libelf/README @@ -0,0 +1,42 @@ +libelf +________________________________________________________________________________ + +NOTE: The libelf implementation is one component of elfutils of which the + following information is about. + +elfutils is a collection of utilities and libraries to read, create and modify +ELF binary files, find and handle DWARF debug data, symbols, thread state and +stacktraces for processes and core files on GNU/Linux. [0] + +Upstream: https://sourceware.org/elfutils/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libelf | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://sourceware.org/elfutils/ + diff --git a/extra/libffi/README b/extra/libffi/README new file mode 100644 index 00000000..515765c9 --- /dev/null +++ b/extra/libffi/README @@ -0,0 +1,42 @@ +libffi +________________________________________________________________________________ + +libffi is a foreign function interface library. It provides a C programming +language interface for calling natively compiled functions given information +about the target function at run time instead of compile time. It also +implements the opposite functionality: libffi can produce a pointer to a +function that can accept and decode any combination of arguments defined at +run time. [0] + +Upstream: https://sourceware.org/libffi/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libffi | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Libffi + diff --git a/extra/libjpeg-turbo/README b/extra/libjpeg-turbo/README new file mode 100644 index 00000000..be46bea2 --- /dev/null +++ b/extra/libjpeg-turbo/README @@ -0,0 +1,55 @@ +libjpeg-turbo +________________________________________________________________________________ + +libjpeg-turbo is a fork of libjpeg that uses SIMD instructions to accelerate +baseline JPEG encoding and decoding. Many projects are now using libjpeg-turbo +instead of libjpeg, including popular Linux distributions (Fedora, Debian, +Mageia, openSUSE, ...), Mozilla, and Chrome. Apart from performance, some +projects have chosen to use libjpeg-turbo because it allows them to retain +backward ABI compatibility with the older libjpeg v6b release. libjpeg v7, v8 +and v9 broke ABI compatibility with prior releases. [0] + +Upstream: https://libjpeg-turbo.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libjpeg-turbo | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + ++--------------+---------------------------------------------------------------+ +| Tool | Purpose | ++--------------+---------------------------------------------------------------+ +| | | +| wrjpgcom | Insert text comments into a JPEG file. | +| rdjpgcom | Display text comments from a JPEG file. | +| jpegtran | Lossless transformation of JPEG files. | +| djpeg | Decompress a JPEG file to an image file. | +| cjpeg | Compress a JPEG file to an image file. | +| | | ++--------------+---------------------------------------------------------------+ + +Refer to the manual pages and command help output for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Libjpeg#libjpeg-turbo + diff --git a/extra/libogg/README b/extra/libogg/README new file mode 100644 index 00000000..73d0f09a --- /dev/null +++ b/extra/libogg/README @@ -0,0 +1,42 @@ +libogg +________________________________________________________________________________ + +Ogg is a free, open container format maintained by the Xiph.Org Foundation. The +creators of the Ogg format state that it is unrestricted by software patents and +is designed to provide for efficient streaming and manipulation of high-quality +digital multimedia. Its name is derived from "ogging", jargon from the computer +game Netrek. [0] + +Upstream: https://www.xiph.org/ogg/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libogg | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Ogg + diff --git a/extra/libpng/README b/extra/libpng/README new file mode 100644 index 00000000..27deac0e --- /dev/null +++ b/extra/libpng/README @@ -0,0 +1,41 @@ +libpng +________________________________________________________________________________ + +libpng is the official Portable Network Graphics (PNG) reference library +(originally called pnglib). It is a platform-independent library that contains C +functions for handling PNG images. It supports almost all of PNG's features, is +extensible, and has been widely used and tested for over 23 years. libpng is +dependent on zlib for data compression and decompression routines. [0] + +Upstream: http://www.libpng.org/pub/png/libpng.html + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libpng | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Libpng + diff --git a/extra/libtheora/README b/extra/libtheora/README new file mode 100644 index 00000000..c02d35a6 --- /dev/null +++ b/extra/libtheora/README @@ -0,0 +1,42 @@ +libtheora +________________________________________________________________________________ + +Theora is a free lossy video compression format.[6] It is developed by the +Xiph.Org Foundation and distributed without licensing fees alongside their other +free and open media projects, including the Vorbis audio format and the Ogg +container. The libtheora video codec is the reference implementation of the +Theora video compression format being developed by the Xiph.Org Foundation. [0] + +Upstream: https://www.theora.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libtheora | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Theora + diff --git a/extra/libudev-zero/README b/extra/libudev-zero/README new file mode 100644 index 00000000..a885adb9 --- /dev/null +++ b/extra/libudev-zero/README @@ -0,0 +1,49 @@ +libudev-zero +________________________________________________________________________________ + +Drop-in replacement for libudev intended to work with any device manager. [0] + +This satisfies the libudev library dependency while allowing the user to use +the device manager of their choosing. + +Upstream: https://github.com/illiliti/libudev-zero + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libudev-zero | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +If using mdev or mdevd (with the default configuration files), libudev-zero will +automatically be used once installed. + + +[003] Usage +________________________________________________________________________________ + +Refer to the FreeDesktop libudev documentation for library information. Refer +to the project's upstream for more information. + + +[004] References +________________________________________________________________________________ + +[0] https://github.com/illiliti/libudev-zero + diff --git a/extra/libva-utils/README b/extra/libva-utils/README new file mode 100644 index 00000000..7baa66f6 --- /dev/null +++ b/extra/libva-utils/README @@ -0,0 +1,41 @@ +libva-utils +________________________________________________________________________________ + +libva-utils is a collection of utilities and examples to exercise VA-API in +accordance with the libva project. VA-API is an open-source library and API +specification, which provides access to graphics hardware acceleration +capabilities for video processing. It consists of a main library and +driver-specific acceleration backends for each supported hardware vendor. [0] + +Upstream: https://github.com/intel/libva-utils + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libva-utils | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the command help output. This package has no documentation. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/intel/libva-utils + diff --git a/extra/libva/README b/extra/libva/README new file mode 100644 index 00000000..a2c879b9 --- /dev/null +++ b/extra/libva/README @@ -0,0 +1,42 @@ +libva +________________________________________________________________________________ + +Video Acceleration API (VA-API) is an open source API that allows applications +such as VLC media player or GStreamer to use hardware video acceleration +capabilities, usually provided by the graphics processing unit (GPU). It is +implemented by the free and open-source library libva, combined with a +hardware-specific driver, usually provided together with the GPU driver. + +Upstream: https://github.com/intel/libva + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libva | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org + diff --git a/extra/libvorbis/README b/extra/libvorbis/README new file mode 100644 index 00000000..41ea925b --- /dev/null +++ b/extra/libvorbis/README @@ -0,0 +1,42 @@ +libvorbis +________________________________________________________________________________ + +Vorbis is a free and open-source software project headed by the Xiph.Org +Foundation. The project produces an audio coding format and software reference +encoder/decoder (codec) for lossy audio compression. Vorbis is most commonly +used in conjunction with the Ogg container format[9] and it is therefore often +referred to as Ogg Vorbis. [0] + +Upstream: https://xiph.org/vorbis/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libvorbis | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Vorbis + diff --git a/extra/libvpx/README b/extra/libvpx/README new file mode 100644 index 00000000..894ccb16 --- /dev/null +++ b/extra/libvpx/README @@ -0,0 +1,41 @@ +libvpx +________________________________________________________________________________ + +libvpx is a free software video codec library from Google and the Alliance for O +pen Media (AOMedia). It serves as the reference software implementation for the +VP8 and VP9 video coding formats, and for AV1 a special fork named libaom that +was stripped of backwards compatibility. [0] + +Upstream: https://github.com/webmproject/libvpx + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libvpx | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Libvpx + diff --git a/extra/libwebp/README b/extra/libwebp/README new file mode 100644 index 00000000..fcf0d39f --- /dev/null +++ b/extra/libwebp/README @@ -0,0 +1,39 @@ +libwebp +________________________________________________________________________________ + +Library to encode and decode images in WebP format. This package contains the +library that can be used in other programs to add WebP support, as well as the +command line tools 'cwebp' and 'dwebp'. [0] + +Upstream: https://github.com/webmproject/libwebp + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libwebp | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/webmproject/libwebp + diff --git a/extra/llvm/README b/extra/llvm/README new file mode 100644 index 00000000..ce18103e --- /dev/null +++ b/extra/llvm/README @@ -0,0 +1,43 @@ +llvm +________________________________________________________________________________ + +LLVM is a set of compiler and toolchain technologies, which can be used to +develop a front end for any programming language and a back end for any +instruction set architecture. LLVM is designed around a language-independent +intermediate representation (IR) that serves as a portable, high-level assembly +language that can be optimized with a variety of transformations over multiple +passes. [0] + +Upstream: https://llvm.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b llvm | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the command help output. No manuals are (yet) provided with alongside +this package. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/LLVM + diff --git a/extra/man-pages/README b/extra/man-pages/README new file mode 100644 index 00000000..9d1fc0f5 --- /dev/null +++ b/extra/man-pages/README @@ -0,0 +1,45 @@ +man-pages +________________________________________________________________________________ + +The Linux man-pages project documents the Linux kernel and C library interfaces +that are employed by user-space programs. With respect to the C library, the +primary focus is the GNU C library (glibc), although, where known, documentation +of variations in other C libraries available for Linux is also included. [0] + +Also included are the POSIX manual pages (in place of the glibc ones). These +manuals also include the core utilities (which busybox does not provide manuals +for). + +Upstream: https://www.kernel.org/doc/man-pages/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b mandoc | +| $ kiss b man-pages | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://www.kernel.org/doc/man-pages/ + diff --git a/extra/mandoc/README b/extra/mandoc/README new file mode 100644 index 00000000..267c43fe --- /dev/null +++ b/extra/mandoc/README @@ -0,0 +1,41 @@ +mandoc +________________________________________________________________________________ + +mandoc (historically called mdocml) is an ISC licensed utility for formatting +man pages, specifically those written in the mdoc and man macro languages. +Unlike the groff and older troff and nroff tools predominantly used for this +purpose, mandoc focuses specifically on manuals and is not suitable for +general-purpose type-setting. [0] + +Upstream: https://mandoc.bsd.lv/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b mandoc | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Mandoc + diff --git a/extra/mdevd/README b/extra/mdevd/README new file mode 100644 index 00000000..7e3a39ee --- /dev/null +++ b/extra/mdevd/README @@ -0,0 +1,57 @@ +mdevd +________________________________________________________________________________ + +mdevd is a small daemon managing kernel hotplug events, similarly to udevd. It +uses the same configuration file as mdev, which is a hotplug manager integrated +in the Busybox suite of tools. However, mdev needs to be registered in +/proc/sys/kernel/hotplug, and the kernel forks an instance of mdev for every +event; by contrast, mdevd is a daemon and does not fork. + +The point of mdevd is to provide a drop-in replacement to mdev that does not +fork, so it can handle large influxes of events at boot time without a +performance drop. mdevd is designed to be entirely compatible with advanced +mdev usage such as $/mdev-like-a-boss. [0] + +Upstream: https://skarnet.org/software/mdevd/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b mdevd | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +This package provides a service file compatible with the distribution's default +service manager. Refer to the distribution's service management documentation +for instructions on how to enable the service. [1] + + +[003] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[004] References +________________________________________________________________________________ + +[0] https://skarnet.org/software/mdevd/ +[1] #/wiki/service-management + diff --git a/extra/mesa/README b/extra/mesa/README new file mode 100644 index 00000000..5efc8ecf --- /dev/null +++ b/extra/mesa/README @@ -0,0 +1,53 @@ +mesa +________________________________________________________________________________ + +Mesa, also called Mesa3D and The Mesa 3D Graphics Library, is an open-source +software implementation of OpenGL, Vulkan, and other graphics API +specifications. Mesa translates these specifications to vendor-specific graphics +hardware drivers. [0] + +The mesa package is configured to build drivers for all vendors. You can fork +the package to only build the needed drivers to reduce compilation times and +package size. + +Upstream: https://www.mesa3d.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b mesa | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +If the system is using amdgpu, the kernel option CONFIG_CHECKPOINT_RESTORE must +be enabled. [1] + + +[003] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Mesa_(computer_graphics) +[1] https://lwn.net/Articles/845448/ diff --git a/extra/meson/README b/extra/meson/README new file mode 100644 index 00000000..9ded1a3f --- /dev/null +++ b/extra/meson/README @@ -0,0 +1,39 @@ +meson +________________________________________________________________________________ + +Meson is a software tool for automating the building (compiling) of software. +The overall goal for Meson is to promote programmer productivity. Meson is free +and open-source software written in Python, under the Apache License 2.0. [0] + +Upstream: https://mesonbuild.com/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b meson | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Meson_(software) + diff --git a/extra/mold/README b/extra/mold/README index 9e93bec6..5b2dd57b 100644 --- a/extra/mold/README +++ b/extra/mold/README @@ -1,4 +1,4 @@ -Mold +mold ________________________________________________________________________________ mold is a multi-threaded, high-performance linker that is several times faster @@ -12,12 +12,12 @@ Upstream: $/rui314/mold [000] Index ________________________________________________________________________________ -* Installation-------------------------------------------------------------[001] -* Setup--------------------------------------------------------------------[002] -* Usage--------------------------------------------------------------------[003] -* Troubleshooting----------------------------------------------------------[004] - * Package-Fails-To-Link-With-Mold----------------------------------------[005] -* References---------------------------------------------------------------[006] +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] + * Package Fails To Link With Mold ...................................... [005] +* References ............................................................. [006] [001] Installation @@ -88,7 +88,7 @@ If 'mold' appears in the output, everything is setup correctly. ________________________________________________________________________________ ---[005]-Package-Fails-To-Link-With-Mold----------------------------------------- +--[005] Package Fails To Link With Mold ---------------------------------------- If a package in the official repositories fails to link with mold, open an issue. If a package in a third-party repository fails to link with mold, open diff --git a/extra/mpv/README b/extra/mpv/README new file mode 100644 index 00000000..4dcd5685 --- /dev/null +++ b/extra/mpv/README @@ -0,0 +1,41 @@ +mpv +________________________________________________________________________________ + +mpv is free and open-source media player software based on MPlayer, mplayer2 and +FFmpeg. It runs on several operating systems, including the Unix-like operating +systems (Linux, BSD-based, macOS) and the non-Unix Microsoft Windows, along with +having an Android port called mpv-android. It is cross-platform, running on ARM, +PowerPC, x86/IA-32, x86-64, and MIPS architecture. [0] + +Upstream: https://mpv.io + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b mpv | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Mpv_(media_player) + diff --git a/extra/mutt/README b/extra/mutt/README new file mode 100644 index 00000000..5ed54e62 --- /dev/null +++ b/extra/mutt/README @@ -0,0 +1,41 @@ +mutt +________________________________________________________________________________ + +Mutt is a text-based email client for Unix-like systems. It was originally +written by Michael Elkins in 1995 and released under the GNU General Public +License version 2 or any later version. + +The Mutt slogan is "All mail clients suck. This one just sucks less." [0] + +Upstream: http://www.mutt.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b mutt | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Mutt_(email_client) + diff --git a/extra/nasm/README b/extra/nasm/README new file mode 100644 index 00000000..e2026ad6 --- /dev/null +++ b/extra/nasm/README @@ -0,0 +1,39 @@ +nasm +________________________________________________________________________________ + +The Netwide Assembler (NASM) is an assembler and disassembler for the Intel x86 +architecture. It can be used to write 16-bit, 32-bit (IA-32) and 64-bit (x86-64) +programs. [0] + +Upstream: https://www.nasm.us/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b nasm | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Netwide_Assembler + diff --git a/extra/ncurses/README b/extra/ncurses/README new file mode 100644 index 00000000..d1fc7933 --- /dev/null +++ b/extra/ncurses/README @@ -0,0 +1,42 @@ +ncurses +________________________________________________________________________________ + +ncurses (new curses) is a programming library providing an application +programming interface (API) that allows the programmer to write text-based user +interfaces in a terminal-independent manner. It is a toolkit for developing +"GUI-like" application software that runs under a terminal emulator. It also +optimizes screen changes, in order to reduce the latency experienced when using +remote shells. [0] + +Upstream: https://invisible-island.net/ncurses/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ncurses | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Ncurses + diff --git a/extra/nodejs/README b/extra/nodejs/README new file mode 100644 index 00000000..78c60d60 --- /dev/null +++ b/extra/nodejs/README @@ -0,0 +1,51 @@ +nodejs +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| Nodejs lives here solely for use by Firefox's build system. If Firefox ever | +| drops its nodejs dependency, this package will be removed. | +| | ++------------------------------------------------------------------------------+ + +Node.js is an open-source, cross-platform, back-end JavaScript runtime +environment that runs on the V8 engine and executes JavaScript code outside a +web browser. Node.js lets developers use JavaScript to write command line tools +and for server-side scripting—running scripts server-side to produce dynamic web +page content before the page is sent to the user's web browser. Consequently, +Node.js represents a "JavaScript everywhere" paradigm, unifying web-application +development around a single programming language, rather than different +languages for server-side and client-side scripts. [0] + +Upstream: https://nodejs.org/en/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b nodejs | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org + diff --git a/extra/opendoas/README b/extra/opendoas/README new file mode 100644 index 00000000..1998c077 --- /dev/null +++ b/extra/opendoas/README @@ -0,0 +1,47 @@ +opendoas +________________________________________________________________________________ + +doas is a minimal replacement for the venerable sudo. It was initially written +by Ted Unangst of the OpenBSD project to provide 95% of the features of sudo +with a fraction of the codebase. [0] + +Upstream: https://github.com/Duncaen/OpenDoas + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b opendoas | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use doas with the package manager, set the environment variable +KISS_SU to 'doas'. For configuration, see 'doas.conf.5' and '/etc/doas.conf'. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://github.com/Duncaen/OpenDoas + diff --git a/extra/openresolv/README b/extra/openresolv/README new file mode 100644 index 00000000..d965eb49 --- /dev/null +++ b/extra/openresolv/README @@ -0,0 +1,41 @@ +openresolv +________________________________________________________________________________ + +Enter resolvconf, the middleman between the network configuration services and +/etc/resolv.conf. resolvconf itself is just a script that stores, removes and +lists a full resolv.conf generated for the interface. It then calls all the +helper scripts it knows about so it can configure the real /etc/resolv.conf and +optionally any local nameservers other than libc. [0] + +Upstream: https://roy.marples.name/projects/openresolv/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b openresolv | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://roy.marples.name/projects/openresolv/ + diff --git a/extra/openssh/README b/extra/openssh/README new file mode 100644 index 00000000..94e3b700 --- /dev/null +++ b/extra/openssh/README @@ -0,0 +1,55 @@ +openssh +________________________________________________________________________________ + +OpenSSH (also known as OpenBSD Secure Shell[a]) is a suite of secure networking +utilities based on the Secure Shell (SSH) protocol, which provides a secure +channel over an unsecured network in a client–server architecture. [0] + +Upstream: https://www.openssh.com/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b openssh | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + ++--------------+---------------------------------------------------------------+ +| Tool | Purpose | ++--------------+---------------------------------------------------------------+ +| | | +| sshd | OpenSSH daemon. | +| ssh-keyscan | Gather SSH public keys from servers. | +| ssh-keygen | OpenSSH authentication key utility. | +| ssh-copy-id | Use locally available keys to authorise logins on a remote. | +| ssh-agent | OpenSSH authentication agent. | +| ssh-add | Adds private key identities to the OpenSSH auth agent. | +| ssh | OpenSSH remote login client. | +| sftp | OpenSSH secure file transfer. | +| scp | Openssh secure file copy. | +| | | ++--------------+---------------------------------------------------------------+ + +Refer to the manual pages and command help output for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/OpenSSH + diff --git a/extra/opus/README b/extra/opus/README new file mode 100644 index 00000000..5e383455 --- /dev/null +++ b/extra/opus/README @@ -0,0 +1,44 @@ +opus +________________________________________________________________________________ + +Opus is a lossy audio coding format developed by the Xiph.Org Foundation and +standardized by the Internet Engineering Task Force, designed to efficiently +code speech and general audio in a single format, while remaining low-latency +enough for real-time interactive communication and low-complexity enough for +low-end embedded processors. Opus replaces both Vorbis and Speex for new +applications, and several blind listening tests have ranked it higher-quality +than any other standard audio format at any given bitrate until transparency is +reached, including MP3, AAC, and HE-AAC. [0] + +Upstream: https://opus-codec.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b opus | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Opus_(audio_format) + diff --git a/extra/pango/README b/extra/pango/README new file mode 100644 index 00000000..ed075f8f --- /dev/null +++ b/extra/pango/README @@ -0,0 +1,43 @@ +pango +________________________________________________________________________________ + +Pango is a text (i.e. glyph) layout engine library which works with the HarfBuzz +shaping engine for displaying multi-language text. Full-function rendering of +text and cross-platform support is achieved when Pango is used with platform +APIs or third-party libraries, such as Uniscribe and FreeType, as text rendering +backends. Pango-processed text will appear similar under different operating +systems. [0] + +Upstream: https://pango.gnome.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b pango | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Pango + diff --git a/extra/pcre/README b/extra/pcre/README new file mode 100644 index 00000000..712abdc2 --- /dev/null +++ b/extra/pcre/README @@ -0,0 +1,42 @@ +pcre +________________________________________________________________________________ + +Perl Compatible Regular Expressions (PCRE) is a library written in C, which +implements a regular expression engine, inspired by the capabilities of the +Perl programming language. Philip Hazel started writing PCRE in summer 1997. +PCRE's syntax is much more powerful and flexible than either of the POSIX +regular expression flavors (BRE, ERE) and than that of many other +regular-expression libraries. [0] + +Upstream: https://www.pcre.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b pcre | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions + diff --git a/extra/perl/README b/extra/perl/README new file mode 100644 index 00000000..a9e8fcbe --- /dev/null +++ b/extra/perl/README @@ -0,0 +1,40 @@ +perl +________________________________________________________________________________ + +Perl is a family of two high-level, general-purpose, interpreted, dynamic +programming languages. "Perl" refers to Perl 5, but from 2000 to 2019 it also +referred to its redesigned "sister language", Perl 6, before the latter's name +was officially changed to Raku in October 2019. [0] + +Upstream: https://www.perl.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b perl | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Perl + diff --git a/extra/pkgconf/README b/extra/pkgconf/README new file mode 100644 index 00000000..bb35a6d7 --- /dev/null +++ b/extra/pkgconf/README @@ -0,0 +1,38 @@ +pkgconf +________________________________________________________________________________ + +pkgconf is a program which helps to configure compiler and linker flags for +development libraries. It is similar to pkg-config from freedesktop.org. [0] + +Upstream: http://pkgconf.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b pkgconf | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/pkgconf/pkgconf + diff --git a/extra/python/README b/extra/python/README new file mode 100644 index 00000000..d76f500d --- /dev/null +++ b/extra/python/README @@ -0,0 +1,46 @@ +python +________________________________________________________________________________ + +Python is an interpreted high-level general-purpose programming language. Its +design philosophy emphasizes code readability with its use of significant +indentation. Its language constructs as well as its object-oriented approach aim +to help programmers write clear, logical code for small and large-scale +projects. + +Python is dynamically-typed and garbage-collected. It supports multiple +programming paradigms, including structured (particularly, procedural), +object-oriented and functional programming. It is often described as a +"batteries included" language due to its comprehensive standard library. [0] + +Upstream: https://www.python.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b python | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Python_(programming_language) + diff --git a/extra/rust/README b/extra/rust/README new file mode 100644 index 00000000..4c3d616f --- /dev/null +++ b/extra/rust/README @@ -0,0 +1,46 @@ +rust +________________________________________________________________________________ + +Rust is a multi-paradigm, high-level, general-purpose programming language +designed for performance and safety, especially safe concurrency. Rust is +syntactically similar to C++, but can guarantee memory safety by using a borrow +checker to validate references. Rust achieves memory safety without garbage +collection, and reference counting is optional. + +Rust was originally designed by Graydon Hoare at Mozilla Research, with +contributions from Dave Herman, Brendan Eich, and others. The designers refined +the language while writing the Servo experimental browser engine, and the Rust +compiler. [0] + +Upstream: https://www.rust-lang.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b rust | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Rust_(programming_language) + diff --git a/extra/samurai/README b/extra/samurai/README new file mode 100644 index 00000000..1e0e4b34 --- /dev/null +++ b/extra/samurai/README @@ -0,0 +1,38 @@ +samurai +________________________________________________________________________________ + +samurai is a ninja-compatible build tool written in C99 with a focus on +simplicity, speed, and portability. [0] + +Upstream: https://github.com/michaelforney/samurai + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b samurai | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/michaelforney/samurai + diff --git a/extra/scdoc/README b/extra/scdoc/README new file mode 100644 index 00000000..86501169 --- /dev/null +++ b/extra/scdoc/README @@ -0,0 +1,37 @@ +scdoc +________________________________________________________________________________ + +scdoc is a simple man page generator for POSIX systems written in C99. [0] + +Upstream: https://git.sr.ht/~sircmpwn/scdoc + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b scdoc | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://git.sr.ht/~sircmpwn/scdoc + diff --git a/extra/sqlite/README b/extra/sqlite/README new file mode 100644 index 00000000..19d3b0b1 --- /dev/null +++ b/extra/sqlite/README @@ -0,0 +1,46 @@ +sqlite +________________________________________________________________________________ + +SQLite is a relational database management system (RDBMS) contained in a C +library. In contrast to many other database management systems, SQLite is not a +client–server database engine. Rather, it is embedded into the end program. + +SQLite generally follows PostgreSQL syntax. SQLite uses a dynamically and weakly +typed SQL syntax that does not guarantee the domain integrity. This means that +one can, for example, insert a string into a column defined as an integer. +SQLite will attempt to convert data between formats where appropriate, the +string "123" into an int in this case, but does not guarantee such conversions +and will store the data as-is if such a conversion is not possible. [0] + +Upstream: https://www.sqlite.org/index.html + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b sqlite | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/SQLite + diff --git a/extra/ssu/README b/extra/ssu/README new file mode 100644 index 00000000..7480106a --- /dev/null +++ b/extra/ssu/README @@ -0,0 +1,45 @@ +ssu +________________________________________________________________________________ + +Extremely simple su utility [0] + +Upstream: https://github.com/illiliti/ssu + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ssu | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use ssu with the package manager, set the environment variable +KISS_SU to 'ssu'. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://github.com/illiliti/ssu + diff --git a/extra/strace/README b/extra/strace/README new file mode 100644 index 00000000..68282ef2 --- /dev/null +++ b/extra/strace/README @@ -0,0 +1,41 @@ +strace +________________________________________________________________________________ + +strace is a diagnostic, debugging and instructional userspace utility for Linux. +It is used to monitor and tamper with interactions between processes and the +Linux kernel, which include system calls, signal deliveries, and changes of +process state. The operation of strace is made possible by the kernel feature +known as ptrace. [0] + +Upstream: https://strace.io/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b strace | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Strace + diff --git a/extra/tiff/README b/extra/tiff/README new file mode 100644 index 00000000..b37aa6e0 --- /dev/null +++ b/extra/tiff/README @@ -0,0 +1,66 @@ +tiff +________________________________________________________________________________ + +Libtiff is a library for reading and writing Tagged Image File Format +(abbreviated TIFF) files. The set also contains command line tools for +processing TIFFs. It is distributed in source code and can be found as binary +builds for all kinds of platforms. The libtiff software was originally written +by Sam Leffler while working for Silicon Graphics. [0] + +Upstream: http://www.libtiff.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b tiff | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + ++--------------+---------------------------------------------------------------+ +| Tool | Purpose | ++--------------+---------------------------------------------------------------+ +| | | +| fax2ps | Convert a TIFF facsimile to compressed PostScript(tm). | +| fax2tiff | Create a TIFF Class F fax file from raw fax data. | +| pal2rgb | Convert a palette color TIFF image to a full color image. | +| ppm2tiff | Create a TIFF file from PPM, PGM and PBM image files. | +| raw2tiff | Create a TIFF file from raw data. | +| tiff2bw | Convert a color TIFF image to greyscale. | +| tiff2pdf | Convert a TIFF image to a PDF document. | +| tiff2ps | Convert a TIFF image to PostScript. | +| tiff2rgba | Convert a TIFF image to RGBA color space. | +| tiffcmp | Compare two TIFF files. | +| tiffcp | Copy (and possibly convert) a TIFF file. | +| tiffcrop | Select, copy, crop, convert, extract and process TIFF files. | +| tiffdither | Convert a greyscale image to bilevel using dithering. | +| tiffdump | Print verbatim information about TIFF files. | +| tiffinfo | Print information about TIFF files. | +| tiffmedian | Apply the mdian cut algorithm to data in a TIFF file. | +| tiffset | Set or unset a field in a TIFF header. | +| tiffsplit | Split a multi-image TIFF into single-image TIFF files. | +| | | ++--------------+---------------------------------------------------------------+ + +Refer to the manual pages and command help output for more information. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Libtiff + diff --git a/extra/ttf-croscore/README b/extra/ttf-croscore/README new file mode 100644 index 00000000..b69bca1b --- /dev/null +++ b/extra/ttf-croscore/README @@ -0,0 +1,34 @@ +ttf-croscore +________________________________________________________________________________ + +The Chrome OS core fonts, also known as the Croscore fonts, are a collection of +three TrueType font families: Arimo (sans-serif), Tinos (serif) and Cousine +(monospace). These fonts are metrically compatible with Monotype Corporation’s +Arial, Times New Roman, and Courier New, the most commonly used fonts on +Microsoft Windows, for which they are intended as open-source substitutes. [0] + +Upstream: https://www.google.com/chromebook/chrome-os/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* References ............................................................. [002] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ttf-croscore | +| | ++------------------------------------------------------------------------------+ + + +[002] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Croscore_fonts + diff --git a/extra/tzdata/README b/extra/tzdata/README new file mode 100644 index 00000000..a849cfa8 --- /dev/null +++ b/extra/tzdata/README @@ -0,0 +1,56 @@ +tzdata +________________________________________________________________________________ + +The tz database is a collaborative compilation of information about the world's +time zones, primarily intended for use with computer programs and operating +systems. Paul Eggert is its current editor and maintainer, with the +organizational backing of ICANN. The tz database is also known as tzdata, the +zoneinfo database or IANA time zone database, and occasionally as the Olson +database, referring to the founding contributor, Arthur David Olson. [0] + +Upstream: http://web.cs.ucla.edu/~eggert/tz/tz-link.htm + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b tzdata | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To set the timezone, run the following command substituting Zone and SubZone +for their respective values (look in /usr/share/zoneinfo to find them). + ++------------------------------------------------------------------------------+ +| | +| $ ln -sf /usr/share/zoneinfo/Zone/SubZone /etc/localtime | +| | ++------------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Tz_database + diff --git a/extra/util-linux/README b/extra/util-linux/README new file mode 100644 index 00000000..857cff35 --- /dev/null +++ b/extra/util-linux/README @@ -0,0 +1,56 @@ +util-linux +________________________________________________________________________________ + +util-linux is a standard package distributed by the Linux Kernel Organization +for use as part of the Linux operating system. A fork, util-linux-ng (with ng +meaning "next generation"), was created when development stalled, but as of +January 2011 has been renamed back to util-linux, and is the official version of +the package. [0] + +Upstream: https://github.com/karelzak/util-linux + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b util-linux | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +util-linux and busybox have some command overlap. Use the alternatives system +to swap to the desired choices. Run 'kiss a' to list alternatives and then +swap to util-linux accordingly. + ++------------------------------------------------------------------------------+ +| | +| $ kiss a util-linux /path/to/bin | +| | ++------------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org + diff --git a/extra/vim/README b/extra/vim/README new file mode 100644 index 00000000..7b108fa6 --- /dev/null +++ b/extra/vim/README @@ -0,0 +1,41 @@ +vim +________________________________________________________________________________ + +Vim is a free and open-source, screen-based text editor program for Unix. It is +an improved clone of Bill Joy's vi. Vim's author, Bram Moolenaar, derived Vim +from a port of the Stevie editor for Amiga and released a version to the public +in 1991. Vim is designed for use both from a command-line interface and as a +standalone application in a graphical user interface. + +Upstream: https://www.vim.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b vim | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Vim_(text_editor) + diff --git a/extra/wpa_supplicant/README b/extra/wpa_supplicant/README new file mode 100644 index 00000000..199ce60b --- /dev/null +++ b/extra/wpa_supplicant/README @@ -0,0 +1,67 @@ +wpa_supplicant +________________________________________________________________________________ + +wpa_supplicant is a free software implementation of an IEEE 802.11i supplicant +for Linux, FreeBSD, NetBSD, QNX, AROS, Microsoft Windows, Solaris, OS/2 +(including ArcaOS and eComStation) and Haiku. In addition to being a WPA3 and +WPA2 supplicant, it also implements WPA and older wireless LAN security +protocols. [0] + +Upstream: https://w1.fi/wpa_supplicant/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] + * Conntecting-To-Networks------------------------------------------------]003] +* Usage .................................................................. [004] + * Starting The Service ................................................. [005] +* References ............................................................. [006] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b wpa_supplicant | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +--[003] Connecting To Networks ------------------------------------------------- + + Save the output of this command to /etc/wpa_supplicant.conf. + + +----------------------------------------------------------------------------+ + | | + | $ wpa_passphrase SSID passphrase | + | | + +----------------------------------------------------------------------------+ + + +[004] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. For DHCP, refer to dhcpcd +and its documentation. + + +--[005] Starting The Service --------------------------------------------------- + + This package provides a service file compatible with the distribution's + default service manager. Refer to the distribution's service management + documentation for instructions on how to enable the service. [1] + + +[006] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Wpa_supplicant +[1] #/wiki/service-management + diff --git a/extra/x264/README b/extra/x264/README new file mode 100644 index 00000000..87eb5cee --- /dev/null +++ b/extra/x264/README @@ -0,0 +1,40 @@ +x264 +________________________________________________________________________________ + +x264 is a free and open-source software library and a command-line utility +developed by VideoLAN for encoding video streams into the H.264/MPEG-4 AVC video +coding format. [0] + +Upstream: http://x264.nl/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b x264 | +| | ++------------------------------------------------------------------------------+ + + +[003] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[005] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/X264 + diff --git a/extra/x265/README b/extra/x265/README new file mode 100644 index 00000000..32dc6135 --- /dev/null +++ b/extra/x265/README @@ -0,0 +1,40 @@ +x265 +________________________________________________________________________________ + +x265 is a library for encoding video into the High Efficiency Video Coding +(HEVC/H.265) video compression format that was developed and standardized by the +ISO/IEC MPEG and ITU-T VCEG. [0] + +Upstream: https://www.videolan.org/developers/x265.html + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b x265 | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/X265 + diff --git a/extra/xvidcore/README b/extra/xvidcore/README new file mode 100644 index 00000000..a8c38d31 --- /dev/null +++ b/extra/xvidcore/README @@ -0,0 +1,42 @@ +xvidcore +________________________________________________________________________________ + +Xvid (formerly "XviD") is a video codec library following the MPEG-4 video +coding standard, specifically MPEG-4 Part 2 Advanced Simple Profile (ASP). It +uses ASP features such as b-frames, global and quarter pixel motion +compensation, lumi masking, trellis quantization, and H.263, MPEG and custom +quantization matrices. [0] + +Upstream: https://labs.xvid.com/source/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b xvidcore | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Xvid + diff --git a/extra/zstd/README b/extra/zstd/README new file mode 100644 index 00000000..a1dc9399 --- /dev/null +++ b/extra/zstd/README @@ -0,0 +1,48 @@ +zstd +________________________________________________________________________________ + +Zstandard (or zstd) is a lossless data compression algorithm developed by +Yann Collet at Facebook. Zstd is the reference implementation in C. Version 1 of +this implementation was released as open-source software on 31 August 2016. [0] + +Upstream: https://github.com/facebook/zstd + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b zstd | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +To use zstd as the package manager's compression method for build tarballs, set +the environment variable KISS_COMPRESS to 'zst'. If zstd will not be used as +the package manager's compression method, no such setup is required. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Zstandard + diff --git a/testing/firefox/README b/testing/firefox/README new file mode 100644 index 00000000..a971327c --- /dev/null +++ b/testing/firefox/README @@ -0,0 +1,126 @@ +firefox +________________________________________________________________________________ + +Mozilla Firefox or simply Firefox, is a free and open-source web browser +developed by the Mozilla Foundation and its subsidiary, the Mozilla Corporation. +Firefox uses the Gecko rendering engine to display web pages. [0] + +Upstream: https://www.mozilla.org/firefox + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] + * Runtime Dependencies ................................................. [002] + * Privacy Package ...................................................... [003] +* Setup .................................................................. [004] + * Enable VAAPI Acceleration ............................................ [005] +* Usage .................................................................. [006] +* References ............................................................. [007] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b firefox | +| | ++------------------------------------------------------------------------------+ + + +--[002] Runtime Dependencies --------------------------------------------------- + + Firefox needs a few additional things to be fully functional. One is an icon + theme and the other is a font. If you have already installed the fonts and + icon theme of your choosing, this step can be skipped. + + +----------------------------------------------------------------------------+ + | | + | $ kiss b [hicolor-icon-theme|adwaita-icon-theme] | + | $ kiss b ttf-croscore | + | | + +----------------------------------------------------------------------------+ + + +--[003] Privacy Package -------------------------------------------------------- + + Provided is also an optional privacy package which makes Firefox perform zero + unsolicited network requests. More information can be found in the + documentation (@/firefox-privacy) Expect some website breakage when using this + privacy package YMMV. + + +----------------------------------------------------------------------------+ + | | + | $ kiss b firefox-privacy | + | | + +----------------------------------------------------------------------------+ + + +[004] Setup +________________________________________________________________________________ + +As of Firefox 91. There is no need to set special environment variables to +enable Wayland support (in a Wayland only environment like ours). The browser +should start with no further configuration. + + +--[005] Enable VAAPI Acceleration ---------------------------------------------- + +Make sure that the following are set in your about:config page. + ++------------------------------------------------------------------------------+ +| | +| about:config | +| | +| gfx.webrender.all=true | +| media.av1.enabled=false | +| media.ffmpeg.dmabuf-textures.disabled=false | +| media.ffmpeg.vaapi.enabled=true | +| media.ffvpx.enabled=false | +| | ++------------------------------------------------------------------------------+ + +If using AMDGPU, the following kernel option must be enabled. [1] + ++------------------------------------------------------------------------------+ +| | +| .config | +| | +| CONFIG_CHECKPOINT_RESTORE=y | +| | ++------------------------------------------------------------------------------+ + +You may also need to set the following environment variable. + ++------------------------------------------------------------------------------+ +| | +| .profile | +| | +| export MOZ_WAYLAND_DRM_DEVICE=/dev/dri/renderD128 | +| | ++------------------------------------------------------------------------------+ + +To verify that VAAPI is working, launch Firefox with the following argument and +attempt to watch a video. Pay attention for errors in the output. + ++------------------------------------------------------------------------------+ +| | +| $ firefox --MOZ_LOG=PlatformDecoderModule:4 | +| | ++------------------------------------------------------------------------------+ + + +[006] Usage +________________________________________________________________________________ + +Refer to the browser's help output and online documentation for further +information. + + +[007] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Firefox + diff --git a/wayland/foot-pgo/README b/wayland/foot-pgo/README new file mode 100644 index 00000000..ed822db2 --- /dev/null +++ b/wayland/foot-pgo/README @@ -0,0 +1,52 @@ +foot +________________________________________________________________________________ + +The fast, lightweight and minimalistic Wayland terminal emulator. [0] + +Upstream: https://codeberg.org/dnkl/foot + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + +There are two flavours of foot to choose from: 'foot' and 'foot-pgo'. The latter +performs profile guided optimizations which result in a faster terminal. [1] [2] + ++------------------------------------------------------------------------------+ +| | +| $ kiss b [foot|foot-pgo] | +| | ++------------------------------------------------------------------------------+ + +If the system has no fonts, installation of a font is also required. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ttf-croscore | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[005] References +________________________________________________________________________________ + +[0] https://codeberg.org/dnkl/foot +[1] https://codeberg.org/dnkl/foot/wiki/Performance +[2] https://codeberg.org/dnkl/foot/src/branch/master/doc/benchmark.md + diff --git a/wayland/foot/README b/wayland/foot/README new file mode 100644 index 00000000..ed822db2 --- /dev/null +++ b/wayland/foot/README @@ -0,0 +1,52 @@ +foot +________________________________________________________________________________ + +The fast, lightweight and minimalistic Wayland terminal emulator. [0] + +Upstream: https://codeberg.org/dnkl/foot + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + +There are two flavours of foot to choose from: 'foot' and 'foot-pgo'. The latter +performs profile guided optimizations which result in a faster terminal. [1] [2] + ++------------------------------------------------------------------------------+ +| | +| $ kiss b [foot|foot-pgo] | +| | ++------------------------------------------------------------------------------+ + +If the system has no fonts, installation of a font is also required. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ttf-croscore | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[005] References +________________________________________________________________________________ + +[0] https://codeberg.org/dnkl/foot +[1] https://codeberg.org/dnkl/foot/wiki/Performance +[2] https://codeberg.org/dnkl/foot/src/branch/master/doc/benchmark.md + diff --git a/wayland/grim/README b/wayland/grim/README new file mode 100644 index 00000000..31268710 --- /dev/null +++ b/wayland/grim/README @@ -0,0 +1,38 @@ +grim +________________________________________________________________________________ + +Grab images from a Wayland compositor. [0] + +Upstream: https://github.com/emersion/grim + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b grim | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the command help output. This package does not yet provide +documentation. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/emersion/grim + diff --git a/wayland/libdrm/README b/wayland/libdrm/README new file mode 100644 index 00000000..1ee147ee --- /dev/null +++ b/wayland/libdrm/README @@ -0,0 +1,39 @@ +libdrm +________________________________________________________________________________ + +A userspace library for accessing the DRM, direct rendering manager, on +GNU/Linux, BSD and other operating systems that support the ioctl interface. [0] + +Upstream: https://01.org/linuxgraphics/community/libdrm + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libdrm | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://www.wikidata.org/wiki/Q28975051 + diff --git a/wayland/libinput/README b/wayland/libinput/README new file mode 100644 index 00000000..703fbeb4 --- /dev/null +++ b/wayland/libinput/README @@ -0,0 +1,42 @@ +libinput +________________________________________________________________________________ + +Libinput handles input devices for multiple Wayland compositors and also +provides a generic X.Org Server input driver. It aims to provide one +implementation for multiple Wayland compositors with a common way to handle +input events while minimizing the amount of custom input code compositors need +to include. libinput provides device detection (via udev), device handling, +input device event processing and abstraction. [0] + +Upstream: https://www.freedesktop.org/wiki/Software/libinput/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libinput | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#libinput + diff --git a/wayland/libpciaccess/README b/wayland/libpciaccess/README new file mode 100644 index 00000000..11fbc9fd --- /dev/null +++ b/wayland/libpciaccess/README @@ -0,0 +1,40 @@ +libpciaccess +________________________________________________________________________________ + +Free software library for generic PCI access, is used by the Xorg server (and +was adopted by Wayland) to interface with the appropriate routines for finding +and using PCI bus devices on various operating systems. [0] + +Upstream: https://gitlab.freedesktop.org/xorg/lib/libpciaccess + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libpciaccess | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://www.wikidata.org/wiki/Q33129784 + diff --git a/wayland/libseat/README b/wayland/libseat/README new file mode 100644 index 00000000..d1a2fb7c --- /dev/null +++ b/wayland/libseat/README @@ -0,0 +1,49 @@ +libseat +________________________________________________________________________________ + +A minimal seat management daemon, and a universal seat management library. [0] + +Upstream: https://sr.ht/~kennylevinsen/seatd/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* References ............................................................. [004] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libseat | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + +This package provides a service file compatible with the distribution's default +service manager. Refer to the distribution's service management documentation +for instructions on how to enable the service. [1] + +Also, ensure your user is in the video group. + + +[003] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[004] References +________________________________________________________________________________ + +[0] https://sr.ht/~kennylevinsen/seatd/ +[1] #/wiki/service-management + diff --git a/wayland/libxkbcommon/README b/wayland/libxkbcommon/README new file mode 100644 index 00000000..b6876e87 --- /dev/null +++ b/wayland/libxkbcommon/README @@ -0,0 +1,39 @@ +libxkbcommon +________________________________________________________________________________ + +xkbcommon is a library for handling of keyboard descriptions, including loading +them from disk, parsing them and handling their state. It's mainly meant for +client toolkits, window systems, and other system applications. [0] + +Upstream: https://xkbcommon.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b libxkbcommon | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://xkbcommon.org/ + diff --git a/wayland/pixman/README b/wayland/pixman/README new file mode 100644 index 00000000..b7367f07 --- /dev/null +++ b/wayland/pixman/README @@ -0,0 +1,40 @@ +pixman +________________________________________________________________________________ + +Pixman is a low-level software library for pixel manipulation, providing +features such as image compositing and trapezoid rasterization. Important users +of pixman are the cairo graphics library and the X server. [0] + +Upstream: http://www.pixman.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b pixman | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] http://www.pixman.org/ + diff --git a/wayland/slurp/README b/wayland/slurp/README new file mode 100644 index 00000000..d8bc14b1 --- /dev/null +++ b/wayland/slurp/README @@ -0,0 +1,37 @@ +slurp +________________________________________________________________________________ + +Select a region in a Wayland compositor and print it to the standard output. [0] + +Upstream: https://github.com/emersion/slurp + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b slurp | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/emersion/slurp + diff --git a/wayland/sway-no-seat/README b/wayland/sway-no-seat/README new file mode 100644 index 00000000..6a561f4c --- /dev/null +++ b/wayland/sway-no-seat/README @@ -0,0 +1,103 @@ +sway +________________________________________________________________________________ + +Sway is a tiling window manager and Wayland compositor, inspired by i3, and +written in C. Sway is designed as a drop-in replacement for i3 using the more +modern Wayland display server protocol and wlroots compositor library. Sway +works with existing i3 configuration files and supports most of i3's features +while providing several new features of its own. [0] + +Upstream: https://swaywm.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] + * Add User To Input Video And TTY Groups ............................... [003] + * Setup Seat Management ................................................ [004] + * Set XDG_RUNTIME_DIR .................................................. [005] +* Usage .................................................................. [006] +* Troubleshooting ........................................................ [007] +* References ............................................................. [008] + + +[001] Installation +________________________________________________________________________________ + +There are three flavors of Sway in the repositories. + +1. 'sway': Sway as upstream intended. Comes with all the bells and whistles + and requires use of the seatd daemon. + +2. 'sway-no-seat': Sway without the seatd daemon requirement. Instead, the + libseat library embeds the daemon. + +3. 'sway-tiny': All changes from 'sway-no-seat' plus no dependency on pcre, + json-c, pango and cairo. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b [sway|sway-no-seat|sway-tiny] | +| | ++------------------------------------------------------------------------------+ + +If the system has no fonts, installation of a font is also required. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ttf-croscore | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + + +--[003] Add User To Input Video And TTY Groups --------------------------------- + + +----------------------------------------------------------------------------+ + | | + | $ addgroup USER input | + | $ addgroup USER video | + | $ addgroup USER tty | + | | + +----------------------------------------------------------------------------+ + + +--[004] Setup Seat Management -------------------------------------------------- + + If using the 'sway package, the seatd daemon must be setup. Refer to the + documentation found here @/libseat + + If using the 'sway-no-seat' or 'sway-tiny' packages, there is no seatd daemon + requirement. Instead you must be the first to call DRMSetMaster. [1] + + +--[005] Set XDG_RUNTIME_DIR ---------------------------------------------------- + + This environment variable must be set to a directory that is writable by your + user. This can be anywhere in theory though /run/user/$(id -u) is recommended. + + +[006] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[007] Troubleshooting +________________________________________________________________________________ + +If you are using the 'sway-tiny' package and encounter any issues, send bug +reports to $/kisslinux/repo rather than upstream. + + +[008] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org +[1] $/torvalds/linux/commit/45bc3d26c95a8fc63a7d8668ca9e57ef0883351c diff --git a/wayland/sway-tiny/README b/wayland/sway-tiny/README new file mode 100644 index 00000000..6a561f4c --- /dev/null +++ b/wayland/sway-tiny/README @@ -0,0 +1,103 @@ +sway +________________________________________________________________________________ + +Sway is a tiling window manager and Wayland compositor, inspired by i3, and +written in C. Sway is designed as a drop-in replacement for i3 using the more +modern Wayland display server protocol and wlroots compositor library. Sway +works with existing i3 configuration files and supports most of i3's features +while providing several new features of its own. [0] + +Upstream: https://swaywm.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] + * Add User To Input Video And TTY Groups ............................... [003] + * Setup Seat Management ................................................ [004] + * Set XDG_RUNTIME_DIR .................................................. [005] +* Usage .................................................................. [006] +* Troubleshooting ........................................................ [007] +* References ............................................................. [008] + + +[001] Installation +________________________________________________________________________________ + +There are three flavors of Sway in the repositories. + +1. 'sway': Sway as upstream intended. Comes with all the bells and whistles + and requires use of the seatd daemon. + +2. 'sway-no-seat': Sway without the seatd daemon requirement. Instead, the + libseat library embeds the daemon. + +3. 'sway-tiny': All changes from 'sway-no-seat' plus no dependency on pcre, + json-c, pango and cairo. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b [sway|sway-no-seat|sway-tiny] | +| | ++------------------------------------------------------------------------------+ + +If the system has no fonts, installation of a font is also required. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ttf-croscore | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + + +--[003] Add User To Input Video And TTY Groups --------------------------------- + + +----------------------------------------------------------------------------+ + | | + | $ addgroup USER input | + | $ addgroup USER video | + | $ addgroup USER tty | + | | + +----------------------------------------------------------------------------+ + + +--[004] Setup Seat Management -------------------------------------------------- + + If using the 'sway package, the seatd daemon must be setup. Refer to the + documentation found here @/libseat + + If using the 'sway-no-seat' or 'sway-tiny' packages, there is no seatd daemon + requirement. Instead you must be the first to call DRMSetMaster. [1] + + +--[005] Set XDG_RUNTIME_DIR ---------------------------------------------------- + + This environment variable must be set to a directory that is writable by your + user. This can be anywhere in theory though /run/user/$(id -u) is recommended. + + +[006] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[007] Troubleshooting +________________________________________________________________________________ + +If you are using the 'sway-tiny' package and encounter any issues, send bug +reports to $/kisslinux/repo rather than upstream. + + +[008] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org +[1] $/torvalds/linux/commit/45bc3d26c95a8fc63a7d8668ca9e57ef0883351c diff --git a/wayland/sway/README b/wayland/sway/README new file mode 100644 index 00000000..6a561f4c --- /dev/null +++ b/wayland/sway/README @@ -0,0 +1,103 @@ +sway +________________________________________________________________________________ + +Sway is a tiling window manager and Wayland compositor, inspired by i3, and +written in C. Sway is designed as a drop-in replacement for i3 using the more +modern Wayland display server protocol and wlroots compositor library. Sway +works with existing i3 configuration files and supports most of i3's features +while providing several new features of its own. [0] + +Upstream: https://swaywm.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] + * Add User To Input Video And TTY Groups ............................... [003] + * Setup Seat Management ................................................ [004] + * Set XDG_RUNTIME_DIR .................................................. [005] +* Usage .................................................................. [006] +* Troubleshooting ........................................................ [007] +* References ............................................................. [008] + + +[001] Installation +________________________________________________________________________________ + +There are three flavors of Sway in the repositories. + +1. 'sway': Sway as upstream intended. Comes with all the bells and whistles + and requires use of the seatd daemon. + +2. 'sway-no-seat': Sway without the seatd daemon requirement. Instead, the + libseat library embeds the daemon. + +3. 'sway-tiny': All changes from 'sway-no-seat' plus no dependency on pcre, + json-c, pango and cairo. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b [sway|sway-no-seat|sway-tiny] | +| | ++------------------------------------------------------------------------------+ + +If the system has no fonts, installation of a font is also required. + ++------------------------------------------------------------------------------+ +| | +| $ kiss b ttf-croscore | +| | ++------------------------------------------------------------------------------+ + + +[002] Setup +________________________________________________________________________________ + + +--[003] Add User To Input Video And TTY Groups --------------------------------- + + +----------------------------------------------------------------------------+ + | | + | $ addgroup USER input | + | $ addgroup USER video | + | $ addgroup USER tty | + | | + +----------------------------------------------------------------------------+ + + +--[004] Setup Seat Management -------------------------------------------------- + + If using the 'sway package, the seatd daemon must be setup. Refer to the + documentation found here @/libseat + + If using the 'sway-no-seat' or 'sway-tiny' packages, there is no seatd daemon + requirement. Instead you must be the first to call DRMSetMaster. [1] + + +--[005] Set XDG_RUNTIME_DIR ---------------------------------------------------- + + This environment variable must be set to a directory that is writable by your + user. This can be anywhere in theory though /run/user/$(id -u) is recommended. + + +[006] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[007] Troubleshooting +________________________________________________________________________________ + +If you are using the 'sway-tiny' package and encounter any issues, send bug +reports to $/kisslinux/repo rather than upstream. + + +[008] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org +[1] $/torvalds/linux/commit/45bc3d26c95a8fc63a7d8668ca9e57ef0883351c diff --git a/wayland/wayland-protocols/README b/wayland/wayland-protocols/README new file mode 100644 index 00000000..f7f9866d --- /dev/null +++ b/wayland/wayland-protocols/README @@ -0,0 +1,46 @@ +wayland-protocols +________________________________________________________________________________ + +wayland-protocols contains Wayland protocols that add functionality not +available in the Wayland core protocol. Such protocols either add completely new +functionality, or extend the functionality of some other protocol either in +Wayland core, or some other protocol in wayland-protocols. + +A protocol in wayland-protocols consists of a directory containing a set of XML +files containing the protocol specification, and a README file containing +detailed state and a list of maintainers. [0] + + +Upstream: https://wayland.freedesktop.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b wayland-protocols | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://cgit.freedesktop.org/wayland/wayland-protocols/tree/README.md + diff --git a/wayland/wayland/README b/wayland/wayland/README new file mode 100644 index 00000000..ecc458bd --- /dev/null +++ b/wayland/wayland/README @@ -0,0 +1,42 @@ +wayland +________________________________________________________________________________ + +Wayland is a communication protocol that specifies the communication between a +display server and its clients, as well as a C library implementation of that +protocol. A display server using the Wayland protocol is called a Wayland +compositor, because it additionally performs the task of a compositing window +manager. [0] + +Upstream: https://wayland.freedesktop.org/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [003] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b wayland | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://en.wikipedia.org/wiki/Wayland_(display_server_protocol) + diff --git a/wayland/wbg/README b/wayland/wbg/README new file mode 100644 index 00000000..9f5ff7ff --- /dev/null +++ b/wayland/wbg/README @@ -0,0 +1,39 @@ +wbg +________________________________________________________________________________ + +Super simple wallpaper application for Wayland compositors implementing the +layer-shell protocol. Wbg takes a single command line argument: a path to an +image file. This image is displayed scaled-to-fit on all monitors. [0] + +Upstream: https://codeberg.org/dnkl/wbg + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b wbg | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://codeberg.org/dnkl/wbg + diff --git a/wayland/wl-clipboard/README b/wayland/wl-clipboard/README new file mode 100644 index 00000000..870ecae8 --- /dev/null +++ b/wayland/wl-clipboard/README @@ -0,0 +1,39 @@ +wl-clipboard +________________________________________________________________________________ + +This project implements two command-line Wayland clipboard utilities, wl-copy +and wl-paste, that let you easily copy data between the clipboard and Unix +pipes, sockets, files and so on. [0] + +Upstream: https://github.com/bugaevc/wl-clipboard + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b wl-clipboard | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/bugaevc/wl-clipboard + diff --git a/wayland/wlroots/README b/wayland/wlroots/README new file mode 100644 index 00000000..4aa78473 --- /dev/null +++ b/wayland/wlroots/README @@ -0,0 +1,40 @@ +wlroots +________________________________________________________________________________ + +Pluggable, composable, unopinionated modules for building a Wayland compositor; +or about 50,000 lines of code you were going to write anyway. [0] + +Upstream: https://github.com/swaywm/wlroots + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Setup .................................................................. [002] +* Usage .................................................................. [003] +* Troubleshooting ........................................................ [004] +* References ............................................................. [005] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b wlroots | +| | ++------------------------------------------------------------------------------+ + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer to online +documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://github.com/swaywm/wlroots + diff --git a/wayland/wlsunset/README b/wayland/wlsunset/README new file mode 100644 index 00000000..7912ecc5 --- /dev/null +++ b/wayland/wlsunset/README @@ -0,0 +1,39 @@ +wlsunset +________________________________________________________________________________ + +Day/night gamma adjustments for Wayland compositors supporting +wlr-gamma-control-unstable-v1. [0] + +Upstream: https://sr.ht/~kennylevinsen/wlsunset/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b wlsunset | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +No documentation is currently provided with the package, refer command help and +online documentation for the time being. + + +[003] References +________________________________________________________________________________ + +[0] https://sr.ht/~kennylevinsen/wlsunset/ + diff --git a/wayland/xkeyboard-config/README b/wayland/xkeyboard-config/README new file mode 100644 index 00000000..609ae694 --- /dev/null +++ b/wayland/xkeyboard-config/README @@ -0,0 +1,40 @@ +xkeyboard-config +________________________________________________________________________________ + +The non-arch keyboard configuration database for X Window. The goal is to +provide the consistent, well-structured, frequently released open source of X +keyboard configuration data for X Window System implementations (free, open +source and commercial). The project is targeted to XKB-based systems. [0] + +Upstream: https://www.freedesktop.org/wiki/Software/XKeyboardConfig/ + + +[000] Index +________________________________________________________________________________ + +* Installation ........................................................... [001] +* Usage .................................................................. [002] +* References ............................................................. [003] + + +[001] Installation +________________________________________________________________________________ + ++------------------------------------------------------------------------------+ +| | +| $ kiss b xkeyboard-config | +| | ++------------------------------------------------------------------------------+ + + +[002] Usage +________________________________________________________________________________ + +Refer to the manual pages and command help output. + + +[003] References +________________________________________________________________________________ + +[0] https://www.freedesktop.org/wiki/Software/XKeyboardConfig/ +