Paths

Table of Contentst

-
lib/
-
libc/
-
compat-43/
-
sigvec.2
-
db/man/
-
man/
-
dbm.3
-
gen/
19/19
alarm.3
19/19
fnmatch.3
-
pause.3
-
setjmp.3
-
locale/
-
ctype.3
-
isalnum.3
-
isascii.3
-
iscntrl.3
-
islower.3
-
isprint.3
-
ispunct.3
-
isspace.3
-
isupper.3
-
stdio/
-
ferror.3
-
fgets.3
-
fread.3
-
fseek.3
-
scanf.3
-
stdlib/
-
abs.3
-
ldiv.3
-
string/
-
strcat.3
-
strcmp.3
-
strlen.3
-
sys/
-
nanosleep.2
-
msun/man/
-
man/
-
cosh.3
-
floor.3
-
fmod.3
-
sinh.3
-
tanh.3

libc: Add HISTORY sections to the manual pages
ClosedPublic
Actions

Authored by gbe on Apr 3 2022, 10:03 AM.

Details

Reviewers

jilles
imp

Group Reviewers

manpages

Commits

rG2699604d8eae: libc: Add HISTORY sections to the manual pages
rG4b7f35db44cb: libc: Add HISTORY sections to the manual pages

Summary

Add various HISTORY sections to the libc manual pages.

Obtained from: OpenBSD
MFC after: 2 weeks

Test Plan

mandoc output review and 'mandoc -Tlint' checks

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 44975
Build 41863: arc lint + arc unit

Event Timeline

gbe created this revision.Apr 3 2022, 10:03 AM

Herald added a subscriber: andrew. · View Herald TranscriptApr 3 2022, 10:03 AM

gbe requested review of this revision.Apr 3 2022, 10:03 AM

Harbormaster completed remote builds in B44975: Diff 104529.Apr 3 2022, 10:03 AM

Summary needs s/sections the/sections to the/ before it ends up in the commit message

lib/libc/compat-43/sigvec.2
346–347	Given it's a wrapper now, shouldn't it be in section 3, like alarm(3) is?
lib/libc/db/man/dbm.3
227	When did dbm_clearerr, dbm_close, dbm_dirfno, dbm_error, and dbm_open appear? May want to mention when the dbm_ prefix appeared too.
lib/libc/gen/setjmp.3
173	When did the others appear?
lib/libc/locale/ctype.3
152	What about the other functions? Also, when did the macro+function dual implementation come to be? I vaguely remember they were only macros at first.
lib/libc/stdio/ferror.3
132	When did the _unlocked versions appear?

gbe edited the summary of this revision. (Show Details)Apr 3 2022, 2:21 PM

@pauamma_gundo.com good questions, I do some research in the next couple of days.

This revision was not accepted when it landed; it landed in state Needs Review.May 5 2022, 4:51 PM

Closed by commit rG4b7f35db44cb: libc: Add HISTORY sections to the manual pages (authored by gbe). · Explain Why

This revision was automatically updated to reflect the committed changes.

gbe added a commit: rG4b7f35db44cb: libc: Add HISTORY sections to the manual pages.

gbe added a commit: rG2699604d8eae: libc: Add HISTORY sections to the manual pages.Jun 4 2022, 6:00 AM

Revision Contents
Changeset List

Path

Size

lib/

libc/

compat-43/

sigvec.2

11 lines

db/

man/

dbm.3

13 lines

gen/

10 lines

6 lines

20 lines

8 lines

locale/

17 lines

7 lines

7 lines

7 lines

7 lines

7 lines

7 lines

7 lines

7 lines

stdio/

11 lines

9 lines

9 lines

10 lines

17 lines

stdlib/

abs.3

7 lines

ldiv.3

8 lines

string/

strcat.3

11 lines

strcmp.3

11 lines

strlen.3

10 lines

sys/

nanosleep.2

19 lines

msun/

man/

7 lines

7 lines

7 lines

7 lines

7 lines

Diff 104529

View Options

lib/libc/compat-43/sigvec.2

Context not available.
	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.
	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.

		[[service-jails]]
		=== Service Jails

		A service jail shares the complete filesystem tree directly with the host (the jail root path is [.filename]#/#) and as such can access and modify any file on the host, and shares the same user accounts with the host.
		bcrUnsubmitted Done Inline Actions s/Service/service/g bcr: s/Service/service/g
		netchildAuthorUnsubmitted Done Inline Actions I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I may have not understood when to use the uppercase "Thick jail" vs. the "thick jail" part... Can you give me a hint before I blindly lowercase "Service" in the middle of a sentence? netchild: I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I…
		By default it has no access to the network or other resources which are restricted in jails, but they can be configured to re-use the network of the host and to remove some of the jail-restrictions.
		The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon.
		fernapeUnsubmitted Done Inline Actions Something to change the use of `jailing` as a verb (which is repetitive with regards to `service jail`): The use case for service jails is automatic jailing... --> The use case for service jails is automatic confinement of services/daemons inside a jail... The last part does not read very clear to me: `with the least amount of configuration` refers to the jail, but in the middle there is information about needed files... How about: `The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon`. fernape: Something to change the use of `jailing` as a verb (which is repetitive with regards to…
		Service jails exist since FreeBSD 15.

		Advantages of Service Jails:
		bcrUnsubmitted Done Inline Actions Is this a section heading? bcr: Is this a section heading?
		netchildAuthorUnsubmitted Done Inline Actions No. It is a list like for Thick Jails and Thin Jails in the existing text above. netchild: No. It is a list like for Thick Jails and Thin Jails in the existing text above.

		fernapeUnsubmitted Done Inline Actions This list does not render properly. A blank line between the above line an the first bullet is needed (I did not test it). You can run `make run` and visit the local doc set to do some proofreading. fernape: This list does not render properly. A blank line between the above line an the first bullet is…
		netchildAuthorUnsubmitted Done Inline Actions I more or less copy&pasted what was above. There are no blank lines either. Do you have a reference to which ports/packages I need to install to be able to "make run". netchild: I more or less copy&pasted what was above. There are no blank lines either. Do you have a…
		fernapeUnsubmitted Done Inline Actions Just `hugo`. fernape: Just `hugo`.
		* Zero Administration: A service jail ready service needs only one config line in [.filename]#/etc/rc.conf#, a service which is not service jails ready needs two config lines.
		fernapeUnsubmitted Done Inline Actions Service --> service and then Thin --> thin for consistency. fernape: //Service// --> //service// and then //Thin// --> //thin// for consistency.
		netchildAuthorUnsubmitted Done Inline Actions Done... but all the existing parts around it use uppercase versions of Thick/Thin... netchild: Done... but all the existing parts around it use uppercase versions of Thick/Thin...
		* Resource Efficiency: Service jails are more resource efficient than thin jails, as they do not need any additional disk space or network resource.
		* Faster Deployment: Creating and launching service jails is generally faster compared to thin jails if only distinct services/daemons shall be jailed and no parallel instances of the same service/daemon is needed.
		* Shared Resources: Service jails share all resources such as libraries and binaries with the host system. This can potentially lead to more efficient disk caching and improved performance for applications within the jail.
		* Process Isolation: Service jails isolate a particular service, it can not see processes which are not a child of the service jail, even if they run within the same user account.

		Disadvantages of Service Jails:

		* Reduced Isolation: The primary disadvantage of service jails is that they offer no filesystem isolation compared to thick or thin jails.
		* Security Concerns: The reduced isolation in service jails could pose security risks, as a compromise in one jail might have a greater potential to affect everything on the host system.

		Most of the configuration of jails which is discussed below is not needed for service jails.
		To understand how jails work, it is recommended to understand those configuration possibilities. The details about what is needed to configure a service jail is in crossref:jails[service-jails-config, Configuring service jails].

	[[vnet-jails]]	[[vnet-jails]]
	=== VNET Jails	=== VNET Jails

Context not available.

	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].

		[[service-jails-config]]
		pauamma_gundo.comUnsubmitted Done Inline Actions s/basesystem/base system/ here too. pauamma_gundo.com: s/basesystem/base system/ here too.
		=== Configuring Service Jails

		bcrUnsubmitted Done Inline Actions s/Basesystem/Base system/ bcr: s/Basesystem/Base system/
		fernapeUnsubmitted Done Inline Actions Very long line with many examples in the middle of the sentence. How about: `Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.` `Some examples of such a service are servicew which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.` Also typo someting/ --> something// fernape: Very long line with many examples in the middle of the sentence. How about: `Base system…
		A service jail is configured completely via [.filename]#/etc/rc.conf# or man:sysrc[8].
		The base system services are service jails ready.
		fernapeUnsubmitted Done Inline Actions 3rd --> Third fernape: //3rd// --> //Third//
		They contain a config line which enables networking or lift other restrictions of jails.
		Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.
		Some examples of such a service are services which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.

		Third party services may or may not be service jails ready. To check if a service is service jail ready, the following command can be used:

		[source,shell]
		....
		# grep _svcj_options /path/to/rc.d/servicename
		fernapeUnsubmitted Done Inline Actions Typo neccessary --> necessary fernape: Typo //neccessary// --> //necessary//
		....

		If there is no output, the service is not service jail ready, or does not need any additional privileges like e.g. network access.

		If the service is not service jail ready, and needs network access, it can be made ready by adding the necessary config to [.filename]#/etc/rc.conf#:

		[source,shell]
		fernapeUnsubmitted Done Inline Actions _svcj_options --> `_svcj_options` (to signal this is "code" text and not "normal" text). fernape: //_svcj_options// --> //`_svcj_options`// (to signal this is "code" text and not "normal" text).
		....
		# sysrc servicename_svcj_options=net_basic
		....
		bcrUnsubmitted Done Inline Actions s/So// s/can be used/Use the following sequence/ (active voice) bcr: s/So// s/can be used/Use the following sequence/ (active voice)

		For all possible `_svcj_options` see the man:rc.conf[5] man-page.

		To enable a service jail for a given service, the service needs to be stopped and the `servicename_svcj` variable needs to be set to YES.
		To put man:syslogd[8] into a service jail, use the following sequence of commands:

		[source,shell]
		....
		# service syslogd stop
		fernapeUnsubmitted Done Inline Actions Try to avoid the use of `you`. Use the passive voice here. fernape: Try to avoid the use of `you`. Use the passive voice here.
		# sysrc syslogd_svcj=YES
		# service syslogd start
		....

		fernapeUnsubmitted Done Inline Actions This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it should point to http://localhost:1313/en/books/handbook/jails/#jail-management (note the `jail` --> `jails` in the URL). These are easily caught with `make run` :-) fernape: This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it…
		If the `servicename_svcj` variable is changed, the service needs to be stopped before it is changed.
		If it is not stopped, the rc framework will not detect the correct state of the service and will not be able to do what is requested.

		Service jails are managed only via man:rc.conf[5]/man:sysrc[8] and the man:service[8] command.
		The jail utilities, like man:jls[8] as described in crossref:jails[jail-management,Jail Management] can be used to investigate the operation, but the man:jail[8] command is not supposed to be used to manage them.

	[[jail-management]]	[[jail-management]]
	== Jail Management	== Jail Management

Context not available.

View Options

lib/libc/db/man/dbm.3

Context not available.
	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.
	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.

		[[service-jails]]
		=== Service Jails

		A service jail shares the complete filesystem tree directly with the host (the jail root path is [.filename]#/#) and as such can access and modify any file on the host, and shares the same user accounts with the host.
		bcrUnsubmitted Done Inline Actions s/Service/service/g bcr: s/Service/service/g
		netchildAuthorUnsubmitted Done Inline Actions I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I may have not understood when to use the uppercase "Thick jail" vs. the "thick jail" part... Can you give me a hint before I blindly lowercase "Service" in the middle of a sentence? netchild: I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I…
		By default it has no access to the network or other resources which are restricted in jails, but they can be configured to re-use the network of the host and to remove some of the jail-restrictions.
		The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon.
		fernapeUnsubmitted Done Inline Actions Something to change the use of `jailing` as a verb (which is repetitive with regards to `service jail`): The use case for service jails is automatic jailing... --> The use case for service jails is automatic confinement of services/daemons inside a jail... The last part does not read very clear to me: `with the least amount of configuration` refers to the jail, but in the middle there is information about needed files... How about: `The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon`. fernape: Something to change the use of `jailing` as a verb (which is repetitive with regards to…
		Service jails exist since FreeBSD 15.

		Advantages of Service Jails:
		bcrUnsubmitted Done Inline Actions Is this a section heading? bcr: Is this a section heading?
		netchildAuthorUnsubmitted Done Inline Actions No. It is a list like for Thick Jails and Thin Jails in the existing text above. netchild: No. It is a list like for Thick Jails and Thin Jails in the existing text above.

		fernapeUnsubmitted Done Inline Actions This list does not render properly. A blank line between the above line an the first bullet is needed (I did not test it). You can run `make run` and visit the local doc set to do some proofreading. fernape: This list does not render properly. A blank line between the above line an the first bullet is…
		netchildAuthorUnsubmitted Done Inline Actions I more or less copy&pasted what was above. There are no blank lines either. Do you have a reference to which ports/packages I need to install to be able to "make run". netchild: I more or less copy&pasted what was above. There are no blank lines either. Do you have a…
		fernapeUnsubmitted Done Inline Actions Just `hugo`. fernape: Just `hugo`.
		* Zero Administration: A service jail ready service needs only one config line in [.filename]#/etc/rc.conf#, a service which is not service jails ready needs two config lines.
		fernapeUnsubmitted Done Inline Actions Service --> service and then Thin --> thin for consistency. fernape: //Service// --> //service// and then //Thin// --> //thin// for consistency.
		netchildAuthorUnsubmitted Done Inline Actions Done... but all the existing parts around it use uppercase versions of Thick/Thin... netchild: Done... but all the existing parts around it use uppercase versions of Thick/Thin...
		* Resource Efficiency: Service jails are more resource efficient than thin jails, as they do not need any additional disk space or network resource.
		* Faster Deployment: Creating and launching service jails is generally faster compared to thin jails if only distinct services/daemons shall be jailed and no parallel instances of the same service/daemon is needed.
		* Shared Resources: Service jails share all resources such as libraries and binaries with the host system. This can potentially lead to more efficient disk caching and improved performance for applications within the jail.
		* Process Isolation: Service jails isolate a particular service, it can not see processes which are not a child of the service jail, even if they run within the same user account.

		Disadvantages of Service Jails:

		* Reduced Isolation: The primary disadvantage of service jails is that they offer no filesystem isolation compared to thick or thin jails.
		* Security Concerns: The reduced isolation in service jails could pose security risks, as a compromise in one jail might have a greater potential to affect everything on the host system.

		Most of the configuration of jails which is discussed below is not needed for service jails.
		To understand how jails work, it is recommended to understand those configuration possibilities. The details about what is needed to configure a service jail is in crossref:jails[service-jails-config, Configuring service jails].

	[[vnet-jails]]	[[vnet-jails]]
	=== VNET Jails	=== VNET Jails

Context not available.

	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].

		[[service-jails-config]]
		pauamma_gundo.comUnsubmitted Done Inline Actions s/basesystem/base system/ here too. pauamma_gundo.com: s/basesystem/base system/ here too.
		=== Configuring Service Jails

		bcrUnsubmitted Done Inline Actions s/Basesystem/Base system/ bcr: s/Basesystem/Base system/
		fernapeUnsubmitted Done Inline Actions Very long line with many examples in the middle of the sentence. How about: `Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.` `Some examples of such a service are servicew which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.` Also typo someting/ --> something// fernape: Very long line with many examples in the middle of the sentence. How about: `Base system…
		A service jail is configured completely via [.filename]#/etc/rc.conf# or man:sysrc[8].
		The base system services are service jails ready.
		fernapeUnsubmitted Done Inline Actions 3rd --> Third fernape: //3rd// --> //Third//
		They contain a config line which enables networking or lift other restrictions of jails.
		Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.
		Some examples of such a service are services which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.

		Third party services may or may not be service jails ready. To check if a service is service jail ready, the following command can be used:

		[source,shell]
		....
		# grep _svcj_options /path/to/rc.d/servicename
		fernapeUnsubmitted Done Inline Actions Typo neccessary --> necessary fernape: Typo //neccessary// --> //necessary//
		....

		If there is no output, the service is not service jail ready, or does not need any additional privileges like e.g. network access.

		If the service is not service jail ready, and needs network access, it can be made ready by adding the necessary config to [.filename]#/etc/rc.conf#:

		[source,shell]
		fernapeUnsubmitted Done Inline Actions _svcj_options --> `_svcj_options` (to signal this is "code" text and not "normal" text). fernape: //_svcj_options// --> //`_svcj_options`// (to signal this is "code" text and not "normal" text).
		....
		# sysrc servicename_svcj_options=net_basic
		....
		bcrUnsubmitted Done Inline Actions s/So// s/can be used/Use the following sequence/ (active voice) bcr: s/So// s/can be used/Use the following sequence/ (active voice)

		For all possible `_svcj_options` see the man:rc.conf[5] man-page.

		To enable a service jail for a given service, the service needs to be stopped and the `servicename_svcj` variable needs to be set to YES.
		To put man:syslogd[8] into a service jail, use the following sequence of commands:

		[source,shell]
		....
		# service syslogd stop
		fernapeUnsubmitted Done Inline Actions Try to avoid the use of `you`. Use the passive voice here. fernape: Try to avoid the use of `you`. Use the passive voice here.
		# sysrc syslogd_svcj=YES
		# service syslogd start
		....

		fernapeUnsubmitted Done Inline Actions This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it should point to http://localhost:1313/en/books/handbook/jails/#jail-management (note the `jail` --> `jails` in the URL). These are easily caught with `make run` :-) fernape: This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it…
		If the `servicename_svcj` variable is changed, the service needs to be stopped before it is changed.
		If it is not stopped, the rc framework will not detect the correct state of the service and will not be able to do what is requested.

		Service jails are managed only via man:rc.conf[5]/man:sysrc[8] and the man:service[8] command.
		The jail utilities, like man:jls[8] as described in crossref:jails[jail-management,Jail Management] can be used to investigate the operation, but the man:jail[8] command is not supposed to be used to manage them.

	[[jail-management]]	[[jail-management]]
	== Jail Management	== Jail Management

Context not available.

View Options

lib/libc/gen/alarm.3

Context not available.
	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.
	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.

		[[service-jails]]
		=== Service Jails

		A service jail shares the complete filesystem tree directly with the host (the jail root path is [.filename]#/#) and as such can access and modify any file on the host, and shares the same user accounts with the host.
		bcrUnsubmitted Done Inline Actions s/Service/service/g bcr: s/Service/service/g
		netchildAuthorUnsubmitted Done Inline Actions I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I may have not understood when to use the uppercase "Thick jail" vs. the "thick jail" part... Can you give me a hint before I blindly lowercase "Service" in the middle of a sentence? netchild: I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I…
		By default it has no access to the network or other resources which are restricted in jails, but they can be configured to re-use the network of the host and to remove some of the jail-restrictions.
		The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon.
		fernapeUnsubmitted Done Inline Actions Something to change the use of `jailing` as a verb (which is repetitive with regards to `service jail`): The use case for service jails is automatic jailing... --> The use case for service jails is automatic confinement of services/daemons inside a jail... The last part does not read very clear to me: `with the least amount of configuration` refers to the jail, but in the middle there is information about needed files... How about: `The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon`. fernape: Something to change the use of `jailing` as a verb (which is repetitive with regards to…
		Service jails exist since FreeBSD 15.

		Advantages of Service Jails:
		bcrUnsubmitted Done Inline Actions Is this a section heading? bcr: Is this a section heading?
		netchildAuthorUnsubmitted Done Inline Actions No. It is a list like for Thick Jails and Thin Jails in the existing text above. netchild: No. It is a list like for Thick Jails and Thin Jails in the existing text above.

		fernapeUnsubmitted Done Inline Actions This list does not render properly. A blank line between the above line an the first bullet is needed (I did not test it). You can run `make run` and visit the local doc set to do some proofreading. fernape: This list does not render properly. A blank line between the above line an the first bullet is…
		netchildAuthorUnsubmitted Done Inline Actions I more or less copy&pasted what was above. There are no blank lines either. Do you have a reference to which ports/packages I need to install to be able to "make run". netchild: I more or less copy&pasted what was above. There are no blank lines either. Do you have a…
		fernapeUnsubmitted Done Inline Actions Just `hugo`. fernape: Just `hugo`.
		* Zero Administration: A service jail ready service needs only one config line in [.filename]#/etc/rc.conf#, a service which is not service jails ready needs two config lines.
		fernapeUnsubmitted Done Inline Actions Service --> service and then Thin --> thin for consistency. fernape: //Service// --> //service// and then //Thin// --> //thin// for consistency.
		netchildAuthorUnsubmitted Done Inline Actions Done... but all the existing parts around it use uppercase versions of Thick/Thin... netchild: Done... but all the existing parts around it use uppercase versions of Thick/Thin...
		* Resource Efficiency: Service jails are more resource efficient than thin jails, as they do not need any additional disk space or network resource.
		* Faster Deployment: Creating and launching service jails is generally faster compared to thin jails if only distinct services/daemons shall be jailed and no parallel instances of the same service/daemon is needed.
		* Shared Resources: Service jails share all resources such as libraries and binaries with the host system. This can potentially lead to more efficient disk caching and improved performance for applications within the jail.
		* Process Isolation: Service jails isolate a particular service, it can not see processes which are not a child of the service jail, even if they run within the same user account.

		Disadvantages of Service Jails:

		* Reduced Isolation: The primary disadvantage of service jails is that they offer no filesystem isolation compared to thick or thin jails.
		* Security Concerns: The reduced isolation in service jails could pose security risks, as a compromise in one jail might have a greater potential to affect everything on the host system.

		Most of the configuration of jails which is discussed below is not needed for service jails.
		To understand how jails work, it is recommended to understand those configuration possibilities. The details about what is needed to configure a service jail is in crossref:jails[service-jails-config, Configuring service jails].

	[[vnet-jails]]	[[vnet-jails]]
	=== VNET Jails	=== VNET Jails

Context not available.

	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].

		[[service-jails-config]]
		pauamma_gundo.comUnsubmitted Done Inline Actions s/basesystem/base system/ here too. pauamma_gundo.com: s/basesystem/base system/ here too.
		=== Configuring Service Jails

		bcrUnsubmitted Done Inline Actions s/Basesystem/Base system/ bcr: s/Basesystem/Base system/
		fernapeUnsubmitted Done Inline Actions Very long line with many examples in the middle of the sentence. How about: `Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.` `Some examples of such a service are servicew which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.` Also typo someting/ --> something// fernape: Very long line with many examples in the middle of the sentence. How about: `Base system…
		A service jail is configured completely via [.filename]#/etc/rc.conf# or man:sysrc[8].
		The base system services are service jails ready.
		fernapeUnsubmitted Done Inline Actions 3rd --> Third fernape: //3rd// --> //Third//
		They contain a config line which enables networking or lift other restrictions of jails.
		Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.
		Some examples of such a service are services which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.

		Third party services may or may not be service jails ready. To check if a service is service jail ready, the following command can be used:

		[source,shell]
		....
		# grep _svcj_options /path/to/rc.d/servicename
		fernapeUnsubmitted Done Inline Actions Typo neccessary --> necessary fernape: Typo //neccessary// --> //necessary//
		....

		If there is no output, the service is not service jail ready, or does not need any additional privileges like e.g. network access.

		If the service is not service jail ready, and needs network access, it can be made ready by adding the necessary config to [.filename]#/etc/rc.conf#:

		[source,shell]
		fernapeUnsubmitted Done Inline Actions _svcj_options --> `_svcj_options` (to signal this is "code" text and not "normal" text). fernape: //_svcj_options// --> //`_svcj_options`// (to signal this is "code" text and not "normal" text).
		....
		# sysrc servicename_svcj_options=net_basic
		....
		bcrUnsubmitted Done Inline Actions s/So// s/can be used/Use the following sequence/ (active voice) bcr: s/So// s/can be used/Use the following sequence/ (active voice)

		For all possible `_svcj_options` see the man:rc.conf[5] man-page.

		To enable a service jail for a given service, the service needs to be stopped and the `servicename_svcj` variable needs to be set to YES.
		To put man:syslogd[8] into a service jail, use the following sequence of commands:

		[source,shell]
		....
		# service syslogd stop
		fernapeUnsubmitted Done Inline Actions Try to avoid the use of `you`. Use the passive voice here. fernape: Try to avoid the use of `you`. Use the passive voice here.
		# sysrc syslogd_svcj=YES
		# service syslogd start
		....

		fernapeUnsubmitted Done Inline Actions This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it should point to http://localhost:1313/en/books/handbook/jails/#jail-management (note the `jail` --> `jails` in the URL). These are easily caught with `make run` :-) fernape: This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it…
		If the `servicename_svcj` variable is changed, the service needs to be stopped before it is changed.
		If it is not stopped, the rc framework will not detect the correct state of the service and will not be able to do what is requested.

		Service jails are managed only via man:rc.conf[5]/man:sysrc[8] and the man:service[8] command.
		The jail utilities, like man:jls[8] as described in crossref:jails[jail-management,Jail Management] can be used to investigate the operation, but the man:jail[8] command is not supposed to be used to manage them.

	[[jail-management]]	[[jail-management]]
	== Jail Management	== Jail Management

Context not available.

View Options

lib/libc/gen/fnmatch.3

Context not available.
	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.	* Dependency Conflicts: If multiple thin jails require different versions of the same libraries or software, managing dependencies can become complex. In some cases, this might require additional effort to ensure compatibility.
	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.	* Compatibility Challenges: Applications within a thin jail might encounter compatibility issues if they assume a certain base system environment that differs from the shared components provided by the template.

		[[service-jails]]
		=== Service Jails

		A service jail shares the complete filesystem tree directly with the host (the jail root path is [.filename]#/#) and as such can access and modify any file on the host, and shares the same user accounts with the host.
		bcrUnsubmitted Done Inline Actions s/Service/service/g bcr: s/Service/service/g
		netchildAuthorUnsubmitted Done Inline Actions I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I may have not understood when to use the uppercase "Thick jail" vs. the "thick jail" part... Can you give me a hint before I blindly lowercase "Service" in the middle of a sentence? netchild: I tried to match the style of the existing Thick Jails and Thin Jails above this new part. I…
		By default it has no access to the network or other resources which are restricted in jails, but they can be configured to re-use the network of the host and to remove some of the jail-restrictions.
		The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon.
		fernapeUnsubmitted Done Inline Actions Something to change the use of `jailing` as a verb (which is repetitive with regards to `service jail`): The use case for service jails is automatic jailing... --> The use case for service jails is automatic confinement of services/daemons inside a jail... The last part does not read very clear to me: `with the least amount of configuration` refers to the jail, but in the middle there is information about needed files... How about: `The use case for service jails is automatic confinement of services/daemons inside a jail with minimal configuration, and without any knowledge of the files needed by such service/daemon`. fernape: Something to change the use of `jailing` as a verb (which is repetitive with regards to…
		Service jails exist since FreeBSD 15.

		Advantages of Service Jails:
		bcrUnsubmitted Done Inline Actions Is this a section heading? bcr: Is this a section heading?
		netchildAuthorUnsubmitted Done Inline Actions No. It is a list like for Thick Jails and Thin Jails in the existing text above. netchild: No. It is a list like for Thick Jails and Thin Jails in the existing text above.

		fernapeUnsubmitted Done Inline Actions This list does not render properly. A blank line between the above line an the first bullet is needed (I did not test it). You can run `make run` and visit the local doc set to do some proofreading. fernape: This list does not render properly. A blank line between the above line an the first bullet is…
		netchildAuthorUnsubmitted Done Inline Actions I more or less copy&pasted what was above. There are no blank lines either. Do you have a reference to which ports/packages I need to install to be able to "make run". netchild: I more or less copy&pasted what was above. There are no blank lines either. Do you have a…
		fernapeUnsubmitted Done Inline Actions Just `hugo`. fernape: Just `hugo`.
		* Zero Administration: A service jail ready service needs only one config line in [.filename]#/etc/rc.conf#, a service which is not service jails ready needs two config lines.
		fernapeUnsubmitted Done Inline Actions Service --> service and then Thin --> thin for consistency. fernape: //Service// --> //service// and then //Thin// --> //thin// for consistency.
		netchildAuthorUnsubmitted Done Inline Actions Done... but all the existing parts around it use uppercase versions of Thick/Thin... netchild: Done... but all the existing parts around it use uppercase versions of Thick/Thin...
		* Resource Efficiency: Service jails are more resource efficient than thin jails, as they do not need any additional disk space or network resource.
		* Faster Deployment: Creating and launching service jails is generally faster compared to thin jails if only distinct services/daemons shall be jailed and no parallel instances of the same service/daemon is needed.
		* Shared Resources: Service jails share all resources such as libraries and binaries with the host system. This can potentially lead to more efficient disk caching and improved performance for applications within the jail.
		* Process Isolation: Service jails isolate a particular service, it can not see processes which are not a child of the service jail, even if they run within the same user account.

		Disadvantages of Service Jails:

		* Reduced Isolation: The primary disadvantage of service jails is that they offer no filesystem isolation compared to thick or thin jails.
		* Security Concerns: The reduced isolation in service jails could pose security risks, as a compromise in one jail might have a greater potential to affect everything on the host system.

		Most of the configuration of jails which is discussed below is not needed for service jails.
		To understand how jails work, it is recommended to understand those configuration possibilities. The details about what is needed to configure a service jail is in crossref:jails[service-jails-config, Configuring service jails].

	[[vnet-jails]]	[[vnet-jails]]
	=== VNET Jails	=== VNET Jails

Context not available.

	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].	More information can be found in the chapter crossref:linuxemu[linuxemu,Linux Binary Compatibility].

		[[service-jails-config]]
		pauamma_gundo.comUnsubmitted Done Inline Actions s/basesystem/base system/ here too. pauamma_gundo.com: s/basesystem/base system/ here too.
		=== Configuring Service Jails

		bcrUnsubmitted Done Inline Actions s/Basesystem/Base system/ bcr: s/Basesystem/Base system/
		fernapeUnsubmitted Done Inline Actions Very long line with many examples in the middle of the sentence. How about: `Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.` `Some examples of such a service are servicew which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.` Also typo someting/ --> something// fernape: Very long line with many examples in the middle of the sentence. How about: `Base system…
		A service jail is configured completely via [.filename]#/etc/rc.conf# or man:sysrc[8].
		The base system services are service jails ready.
		fernapeUnsubmitted Done Inline Actions 3rd --> Third fernape: //3rd// --> //Third//
		They contain a config line which enables networking or lift other restrictions of jails.
		Base system services which do not make sense to run inside jails are configured to not be started as a service jail, even if enabled in [.filename]#/etc/rc.conf#.
		Some examples of such a service are services which want to mount or unmount something in the start of stop method, or only configure something like a route, or firewall, or the like.

		Third party services may or may not be service jails ready. To check if a service is service jail ready, the following command can be used:

		[source,shell]
		....
		# grep _svcj_options /path/to/rc.d/servicename
		fernapeUnsubmitted Done Inline Actions Typo neccessary --> necessary fernape: Typo //neccessary// --> //necessary//
		....

		If there is no output, the service is not service jail ready, or does not need any additional privileges like e.g. network access.

		If the service is not service jail ready, and needs network access, it can be made ready by adding the necessary config to [.filename]#/etc/rc.conf#:

		[source,shell]
		fernapeUnsubmitted Done Inline Actions _svcj_options --> `_svcj_options` (to signal this is "code" text and not "normal" text). fernape: //_svcj_options// --> //`_svcj_options`// (to signal this is "code" text and not "normal" text).
		....
		# sysrc servicename_svcj_options=net_basic
		....
		bcrUnsubmitted Done Inline Actions s/So// s/can be used/Use the following sequence/ (active voice) bcr: s/So// s/can be used/Use the following sequence/ (active voice)

		For all possible `_svcj_options` see the man:rc.conf[5] man-page.

		To enable a service jail for a given service, the service needs to be stopped and the `servicename_svcj` variable needs to be set to YES.
		To put man:syslogd[8] into a service jail, use the following sequence of commands:

		[source,shell]
		....
		# service syslogd stop
		fernapeUnsubmitted Done Inline Actions Try to avoid the use of `you`. Use the passive voice here. fernape: Try to avoid the use of `you`. Use the passive voice here.
		# sysrc syslogd_svcj=YES
		# service syslogd start
		....

		fernapeUnsubmitted Done Inline Actions This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it should point to http://localhost:1313/en/books/handbook/jails/#jail-management (note the `jail` --> `jails` in the URL). These are easily caught with `make run` :-) fernape: This crossref points to http://localhost:1313/en/books/handbook/jail/#jail-management while it…
		If the `servicename_svcj` variable is changed, the service needs to be stopped before it is changed.
		If it is not stopped, the rc framework will not detect the correct state of the service and will not be able to do what is requested.

		Service jails are managed only via man:rc.conf[5]/man:sysrc[8] and the man:service[8] command.
		The jail utilities, like man:jls[8] as described in crossref:jails[jail-management,Jail Management] can be used to investigate the operation, but the man:jail[8] command is not supposed to be used to manage them.

	[[jail-management]]	[[jail-management]]
	== Jail Management	== Jail Management

Context not available.