mirror of
https://github.com/OpenRC/openrc.git
synced 2024-11-23 01:43:37 +08:00
Reformat and fix titles in documentation
This commit is contained in:
William Hubbs
parent
8878f8916b
commit
fee2ffe559
@ -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
|
||||
incompatibilities between busybox's applets and the standalone
|
||||
|
||||
@ -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 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
|
||||
removed, it should also be removed from this file.
|
||||
|
||||
## Service pause action
|
||||
# Service pause action
|
||||
|
||||
When: 1.0
|
||||
|
||||
@ -13,7 +14,7 @@ Why: The same affect can be obtained with the --nodeps option to stop.
|
||||
|
||||
Who:
|
||||
|
||||
## start-stop-daemon options --startas, --chuid , --oknodo
|
||||
# start-stop-daemon options --startas, --chuid , --oknodo
|
||||
|
||||
When: 1.0
|
||||
|
||||
@ -25,7 +26,7 @@ Why: Obsolete or replaced by other options.
|
||||
|
||||
Who:
|
||||
|
||||
## runscript and rc symbolic links
|
||||
# runscript and rc symbolic links
|
||||
|
||||
When: 1.0
|
||||
|
||||
@ -34,7 +35,7 @@ Why: Deprecated in favor of openrc-run and openrc due to naming
|
||||
|
||||
Who:
|
||||
|
||||
## support for the opts variable in service scripts
|
||||
# support for the opts variable in service scripts
|
||||
|
||||
When: 1.0
|
||||
|
||||
@ -43,7 +44,7 @@ Why: Deprecated in favor of extra_commands, extra_started_commands
|
||||
|
||||
Who:
|
||||
|
||||
## support for local_start and local_stop
|
||||
# support for local_start and local_stop
|
||||
|
||||
When: 1.0
|
||||
|
||||
@ -51,7 +52,7 @@ Why: Deprecated in favor of executable scripts in @SYSCONFDIR@/local.d
|
||||
|
||||
Who:
|
||||
|
||||
## the mtab service script
|
||||
# the mtab service script
|
||||
|
||||
When: force /etc/mtab to link to /proc/self/mounts in 1.0, remove
|
||||
service in 2.0
|
||||
@ -61,13 +62,13 @@ Why: /etc/mtab should be a symbolic link to /proc/self/mounts on modern
|
||||
|
||||
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
|
||||
there, this section will list API functions which are deprecated and
|
||||
will be removed along with the reason they are being removed.
|
||||
|
||||
### rc_getline()
|
||||
## rc_getline()
|
||||
|
||||
When: 1.0
|
||||
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
# OpenRC History
|
||||
OpenRC History
|
||||
==============
|
||||
|
||||
This history of OpenRC was written by Daniel Robbins, Roy Marples, William
|
||||
Hubbs and others.
|
||||
|
||||
3
NEWS.md
3
NEWS.md
@ -1,4 +1,5 @@
|
||||
# OpenRC NEWS
|
||||
OpenRC NEWS
|
||||
===========
|
||||
|
||||
This file will contain a list of notable changes for each release. Note
|
||||
the information in this file is in reverse order.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
# OpenRC README
|
||||
OpenRC README
|
||||
=============
|
||||
|
||||
OpenRC is a dependency-based init system that works with the
|
||||
system-provided init program, normally `/sbin/init`. Currently, it does
|
||||
|
||||
@ -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
|
||||
in this repository. Follow it. Contact openrc@gentoo.org for any questions
|
||||
|
||||
@ -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
|
||||
getty, using agetty, on Linux. To use this method, make sure you aren't
|
||||
|
||||
@ -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
|
||||
start-stop-daemon for monitoring and restarting daemons.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
# Using S6 with OpenRC
|
||||
Using S6 with OpenRC
|
||||
====================
|
||||
|
||||
Beginning with OpenRC-0.16, we support using the s6 supervision suite
|
||||
from Skarnet Software in place of start-stop-daemon for monitoring
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
# OpenRC Service Script Writing Guide
|
||||
OpenRC Service Script Writing Guide
|
||||
===================================
|
||||
|
||||
This document is aimed at developers or packagers who
|
||||
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
|
||||
process.
|
||||
|
||||
## Syntax of Service Scripts
|
||||
# Syntax of Service Scripts
|
||||
|
||||
Service scripts are shell scripts. OpenRC aims at using only the standardized
|
||||
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
|
||||
```
|
||||
|
||||
## The Depend Function
|
||||
# The Depend Function
|
||||
|
||||
This function declares the dependencies for a service script. This
|
||||
determines the order the service scripts start.
|
||||
@ -97,7 +98,7 @@ depend() {
|
||||
|
||||
FIXME: Anything missing in this list?
|
||||
|
||||
## The Default Functions
|
||||
# The Default Functions
|
||||
|
||||
All service scripts are assumed to have the following functions:
|
||||
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
# Using supervise-daemon
|
||||
Using supervise-daemon
|
||||
======================
|
||||
|
||||
Beginning with OpenRC-0.21 we have our own daemon supervisor,
|
||||
supervise-daemon., which can start a daemon and restart it if it
|
||||
|
||||
@ -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
|
||||
requires perl5.x and converts the tree to a .dot file which can be
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
Example OpenRC Service Scripts
|
||||
##############################
|
||||
|
||||
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
|
||||
per distro basis. They are also non essential to the operation of the system.
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
Example OpenVPN Scripts
|
||||
=======================
|
||||
|
||||
These handy scripts setup any dns information that OpenVPN may push.
|
||||
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
|
||||
|
||||
@ -1,2 +1,5 @@
|
||||
OpenRC Sysvinit Support
|
||||
========================
|
||||
|
||||
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.
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
OpenRC Users Guide
|
||||
==================
|
||||
|
||||
# Purpose and description
|
||||
|
||||
OpenRC is an init system for Unixoid operating systems. It takes care of
|
||||
|
||||
Loading…
Reference in New Issue
Block a user