emo/openrc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat and fix titles in documentation

Browse Source
This commit is contained in:
William Hubbs 2018-01-12 14:10:42 -06:00
parent 8878f8916b
commit fee2ffe559
16 changed files with 47 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
BUSYBOX.md
View File

@ -1,4 +1,5 @@
# Using Busybox as your Default Shell with OpenRC Using Busybox as your Default Shell with OpenRC
===============================================
If you have/bin/sh linked to busybox, you need to be aware of several If you have/bin/sh linked to busybox, you need to be aware of several
incompatibilities between busybox's applets and the standalone incompatibilities between busybox's applets and the standalone

19
FEATURE-REMOVAL-SCHEDULE.md
View File

@ -1,11 +1,12 @@
# Features Scheduled for Removal Features Scheduled for Removal
==============================
The following is a list of files and features that are going to be removed in The following is a list of files and features that are going to be removed in
the source tree. Every entry should contain what exactly is going away, why it the source tree. Every entry should contain what exactly is going away, why it
is happening, and who is going to be doing the work. When the feature is is happening, and who is going to be doing the work. When the feature is
removed, it should also be removed from this file. removed, it should also be removed from this file.
## Service pause action # Service pause action
When: 1.0 When: 1.0
@ -13,7 +14,7 @@ Why: The same affect can be obtained with the --nodeps option to stop.
Who: Who:
## start-stop-daemon options --startas, --chuid , --oknodo # start-stop-daemon options --startas, --chuid , --oknodo
When: 1.0 When: 1.0
@ -25,7 +26,7 @@ Why: Obsolete or replaced by other options.
Who: Who:
## runscript and rc symbolic links # runscript and rc symbolic links
When: 1.0 When: 1.0
@ -34,7 +35,7 @@ Why: Deprecated in favor of openrc-run and openrc due to naming
Who: Who:
## support for the opts variable in service scripts # support for the opts variable in service scripts
When: 1.0 When: 1.0
@ -43,7 +44,7 @@ Why: Deprecated in favor of extra_commands, extra_started_commands
Who: Who:
## support for local_start and local_stop # support for local_start and local_stop
When: 1.0 When: 1.0
@ -51,7 +52,7 @@ Why: Deprecated in favor of executable scripts in @SYSCONFDIR@/local.d
Who: Who:
## the mtab service script # the mtab service script
When: force /etc/mtab to link to /proc/self/mounts in 1.0, remove When: force /etc/mtab to link to /proc/self/mounts in 1.0, remove
service in 2.0 service in 2.0
@ -61,13 +62,13 @@ Why: /etc/mtab should be a symbolic link to /proc/self/mounts on modern
Who: Who:
## C API Functions in rc.h # C API Functions in rc.h
If you have a c program that links to librc and uses functions from If you have a c program that links to librc and uses functions from
there, this section will list API functions which are deprecated and there, this section will list API functions which are deprecated and
will be removed along with the reason they are being removed. will be removed along with the reason they are being removed.
### rc_getline() ## rc_getline()
When: 1.0 When: 1.0

3
HISTORY.md
View File

@ -1,4 +1,5 @@
# OpenRC History OpenRC History
==============
This history of OpenRC was written by Daniel Robbins, Roy Marples, William This history of OpenRC was written by Daniel Robbins, Roy Marples, William
Hubbs and others. Hubbs and others.

3
NEWS.md
View File

@ -1,4 +1,5 @@
# OpenRC NEWS OpenRC NEWS
===========
This file will contain a list of notable changes for each release. Note This file will contain a list of notable changes for each release. Note
the information in this file is in reverse order. the information in this file is in reverse order.

3
README.md
View File

@ -1,4 +1,5 @@
# OpenRC README OpenRC README
=============
OpenRC is a dependency-based init system that works with the OpenRC is a dependency-based init system that works with the
system-provided init program, normally `/sbin/init`. Currently, it does system-provided init program, normally `/sbin/init`. Currently, it does

3
STYLE-GUIDE.md
View File

@ -1,4 +1,5 @@
# OpenRC Style Guide OpenRC Coding Style Guide
=========================
This is the openrc style manual. It governs the coding style of all code This is the openrc style manual. It governs the coding style of all code
in this repository. Follow it. Contact openrc@gentoo.org for any questions in this repository. Follow it. Contact openrc@gentoo.org for any questions

3
agetty-guide.md
View File

@ -1,4 +1,5 @@
# Setting up the agetty service in OpenRC Setting up the agetty service in OpenRC
=================================xxxxxx
The agetty service is an OpenRC specific way to monitor and respawn a The agetty service is an OpenRC specific way to monitor and respawn a
getty, using agetty, on Linux. To use this method, make sure you aren't getty, using agetty, on Linux. To use this method, make sure you aren't

3
runit-guide.md
View File

@ -1,4 +1,5 @@
# Using runit with OpenRC Using runit with OpenRC
=======================
Beginning with OpenRC-0.21, we support using runit [1] in place of Beginning with OpenRC-0.21, we support using runit [1] in place of
start-stop-daemon for monitoring and restarting daemons. start-stop-daemon for monitoring and restarting daemons.

3
s6-guide.md
View File

@ -1,4 +1,5 @@
# Using S6 with OpenRC Using S6 with OpenRC
====================
Beginning with OpenRC-0.16, we support using the s6 supervision suite Beginning with OpenRC-0.16, we support using the s6 supervision suite
from Skarnet Software in place of start-stop-daemon for monitoring from Skarnet Software in place of start-stop-daemon for monitoring

9
service-script-guide.md
View File

@ -1,4 +1,5 @@
# OpenRC Service Script Writing Guide OpenRC Service Script Writing Guide
===================================
This document is aimed at developers or packagers who This document is aimed at developers or packagers who
write OpenRC service scripts, either for their own projects, or for write OpenRC service scripts, either for their own projects, or for
@ -13,7 +14,7 @@ don't consider anything exotic, and assume that you will use
start-stop-daemon to manage a fairly typical long-running UNIX start-stop-daemon to manage a fairly typical long-running UNIX
process. process.
## Syntax of Service Scripts # Syntax of Service Scripts
Service scripts are shell scripts. OpenRC aims at using only the standardized Service scripts are shell scripts. OpenRC aims at using only the standardized
POSIX sh subset for portability reasons. The default interpreter (build-time POSIX sh subset for portability reasons. The default interpreter (build-time
@ -59,7 +60,7 @@ started or stopped, it should test the `$RC_CMD` variable, for example:
[ "$RC_CMD" = restart ] && do_something [ "$RC_CMD" = restart ] && do_something
``` ```
## The Depend Function # The Depend Function
This function declares the dependencies for a service script. This This function declares the dependencies for a service script. This
determines the order the service scripts start. determines the order the service scripts start.
@ -97,7 +98,7 @@ depend() {
FIXME: Anything missing in this list? FIXME: Anything missing in this list?
## The Default Functions # The Default Functions
All service scripts are assumed to have the following functions: All service scripts are assumed to have the following functions:

3
supervise-daemon-guide.md
View File

@ -1,4 +1,5 @@
# Using supervise-daemon Using supervise-daemon
======================
Beginning with OpenRC-0.21 we have our own daemon supervisor, Beginning with OpenRC-0.21 we have our own daemon supervisor,
supervise-daemon., which can start a daemon and restart it if it supervise-daemon., which can start a daemon and restart it if it

3
support/deptree2dot/README.md
View File

@ -1,4 +1,5 @@
# deptree2dot - Graph the OpenRC Dependency Tree deptree2dot - Graph the OpenRC Dependency Tree
==============================================
This utility can be used to graph the OpenRC dependency tree. It This utility can be used to graph the OpenRC dependency tree. It
requires perl5.x and converts the tree to a .dot file which can be requires perl5.x and converts the tree to a .dot file which can be

3
support/init.d.examples/README.md
View File

@ -1,3 +1,6 @@
Example OpenRC Service Scripts
##############################
The service scripts in this directory are meant as examples only. The service scripts in this directory are meant as examples only.
They are not installed by default as the scripts will need tweaking on a They are not installed by default as the scripts will need tweaking on a
per distro basis. They are also non essential to the operation of the system. per distro basis. They are also non essential to the operation of the system.

3
support/openvpn/README.md
View File

@ -1,3 +1,6 @@
Example OpenVPN Scripts
=======================
These handy scripts setup any dns information that OpenVPN may push. These handy scripts setup any dns information that OpenVPN may push.
They also handle the interaction with OpenRC so that the OpenVPN service They also handle the interaction with OpenRC so that the OpenVPN service
can become "inactive". This means that when it starts, it goes inactive and can become "inactive". This means that when it starts, it goes inactive and

3
support/sysvinit/README.md
View File

@ -1,2 +1,5 @@
OpenRC Sysvinit Support
========================
Here's a sample inittab for use with sysvinit for Linux based systems. Here's a sample inittab for use with sysvinit for Linux based systems.
We don't install it by default as sysvinit packages normally own this file. We don't install it by default as sysvinit packages normally own this file.

3
user-guide.md
View File

@ -1,3 +1,6 @@
OpenRC Users Guide
==================
# Purpose and description # Purpose and description
OpenRC is an init system for Unixoid operating systems. It takes care of OpenRC is an init system for Unixoid operating systems. It takes care of