Difference between revisions of "Rcorder"

From GhostBSD Wiki
Jump to: navigation, search
(Created page with "{{welcome}} {{Navbar OpenRC}} ==Introduction== Category:Sysutils")
 
(→‎rc Script Ordering)
 
(8 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
==Introduction==
 
==Introduction==
  
 +
The [https://www.freebsd.org/cgi/man.cgi?query=rcorder&apropos=0&sektion=0&manpath=FreeBSD+12.1-RELEASE+and+Ports&arch=default&format=html ''rcorder''] utility is designed to print out a dependency ordering of a  set of interdependent files.  Typically it is used to find an execution    sequence for a set of shell scripts in which certain files must be executed before others.
  
 +
Each file passed to ''rcorder'' must be annotated with special lines (which  look like comments to the shell) which indicate the dependencies the    files have upon certain points in the sequence, known as "conditions",
 +
and which indicate, for each file, which "conditions" may be expected to    be filled by that file.
 +
 +
==rc Script Ordering==
 +
 +
Each rc script identifies what resources it needs before it can start.  The [https://www.freebsd.org/cgi/man.cgi?query=rcorder&apropos=0&sektion=0&manpath=FreeBSD+12.1-RELEASE+and+Ports&arch=default&format=html rcorder(8)] sorts all the scripts in '''/etc/[[Rc.d|rc.d]]''' and '''/usr/[[Local/etc/rc.d|local/etc/rc.d]]''' in to the order used at system boot. If your rc scripts have any ordering errors, those errors appear at the beginning of your [https://www.freebsd.org/cgi/man.cgi?query=rcorder&apropos=0&sektion=0&manpath=FreeBSD+12.1-RELEASE+and+Ports&arch=default&format=html rcorder(8)] output.
 +
 +
==A Example rc Script==
 +
 +
 +
{|class="wikitable" style="width:96.5%;background:#FFFFFF; border:2px solid #008000;text-align:left;padding: 10px"
 +
|-
 +
! scope="col" style="width: 100px;"|'''Lines'''
 +
! scope="col" style="width: 350px;"|'''Description'''
 +
|-
 +
|#!/bin/sh||Indicates the interpreter /bin/sh
 +
|-
 +
|#||
 +
|-
 +
|# $FreeBSD$||
 +
|-
 +
|#||
 +
|-
 +
!colspan="2"|
 +
|-
 +
|# PROVIDE: timed||PROVIDE tells the [https://www.freebsd.org/cgi/man.cgi?query=rcorder&apropos=0&sektion=0&manpath=FreeBSD+12.1-RELEASE+and+Ports&arch=default&format=html rcorder(8)] the name of the script: ''timed''.
 +
|-
 +
|# REQUIRE: DAEMON||REQUIRE says which other scripts must run any time before the script ''timed''.
 +
|-
 +
|# BEFORE:  LOGIN||BEFORE says: ''timed'' must run before the LOGIN script.
 +
|-
 +
|# KEYWORD: nojail shutdown||The KEYWORD command lets select only special sturtup scripts. The [https://www.freebsd.org/cgi/man.cgi?query=timed&apropos=0&sektion=0&manpath=FreeBSD+12.1-RELEASE+and+Ports&arch=default&format=html ''timed(8)''] script ''nojail'' and ''shutdown''. Jail don't run this script. This script runs at system shutdown.
 +
|-
 +
!colspan="2"|
 +
|-
 +
|. /etc/rc.subr||The ''/etc/rc.subr'' functions used by various rc scripts
 +
|-
 +
!colspan="2"|
 +
|-
 +
|name="timed"||Set the variable name.
 +
|-
 +
|desc="Time server daemon"||description field, purpose of the script
 +
|-
 +
|rcvar="timed_enable"||lists the rc.conf variable that toggles this script
 +
|-
 +
|command="/usr/sbin/${name}"||The command identifies which command this script should run after all.
 +
|-
 +
!colspan="2"|
 +
|-
 +
|load_rc_config $name||load the the configuration for the service from '''/etc/[[Rc.conf|rc.conf]]'''
 +
|-
 +
|run_rc_command "$1"||run the command
 +
|}
  
  
  
 
[[Category:Sysutils]]
 
[[Category:Sysutils]]

Latest revision as of 05:23, 25 March 2020

Welcome to Icon Disti GhostBSD.png Rcorder.
OpenRC
Scripts
/etc/rc
rc - shell 		/etc/rc.devd
The generic hook into OpenRC. 		/sbin/rcorder
Ordering rc-scripts
/etc/init.d
Scripts to run OpenRC 		/usr/local/etc/init.d
Scripts to run OpenRC
/etc/rc.d
Scripts automatically executed at boot and shutdown 		/usr/local/etc/rc.d
Special scripts
Configuration
/etc/devd.conf
Configuration file for devd(8) 		/etc/conf.d
Initscript Configuration Files 		/etc/rc.conf.d
Smaller configuration files
/etc/defaults/rc.conf
Specifies the default settings for all the available options. 		/etc/rc.conf
The global OpenRC configuration file 		/etc/rc.conf.ghostbsd
GhostBSD specific configurations
Tools/Helper
/usr/sbin/sysrc
Safely edit system rc files 		/bin/rc-status
Shows which services are running 		/sbin/rc-update
Add or delete services
/sbin/rc-service
Locate and run an OpenRC service
Back to the Icon Disti GhostBSD.pngSystem

Introduction[edit]

The rcorder utility is designed to print out a dependency ordering of a set of interdependent files. Typically it is used to find an execution sequence for a set of shell scripts in which certain files must be executed before others.

Each file passed to rcorder must be annotated with special lines (which look like comments to the shell) which indicate the dependencies the files have upon certain points in the sequence, known as "conditions", and which indicate, for each file, which "conditions" may be expected to be filled by that file.

rc Script Ordering[edit]

Each rc script identifies what resources it needs before it can start. The rcorder(8) sorts all the scripts in /etc/rc.d and /usr/local/etc/rc.d in to the order used at system boot. If your rc scripts have any ordering errors, those errors appear at the beginning of your rcorder(8) output.

A Example rc Script[edit]

Lines Description
#!/bin/sh Indicates the interpreter /bin/sh
#
# $FreeBSD$
#
# PROVIDE: timed PROVIDE tells the rcorder(8) the name of the script: timed.
# REQUIRE: DAEMON REQUIRE says which other scripts must run any time before the script timed.
# BEFORE: LOGIN BEFORE says: timed must run before the LOGIN script.
# KEYWORD: nojail shutdown The KEYWORD command lets select only special sturtup scripts. The timed(8) script nojail and shutdown. Jail don't run this script. This script runs at system shutdown.
. /etc/rc.subr The /etc/rc.subr functions used by various rc scripts
name="timed" Set the variable name.
desc="Time server daemon" description field, purpose of the script
rcvar="timed_enable" lists the rc.conf variable that toggles this script
command="/usr/sbin/${name}" The command identifies which command this script should run after all.
load_rc_config $name load the the configuration for the service from /etc/rc.conf
run_rc_command "$1" run the command
Retrieved from "http://wiki.ghostbsd.org/index.php?title=Rcorder&oldid=5783"