Changeset View
Standalone View
share/man/man5/rc.conf.5
Show All 18 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd October 24, 2017 | .Dd November 30, 2017 | ||||
.Dt RC.CONF 5 | .Dt RC.CONF 5 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm rc.conf | .Nm rc.conf | ||||
.Nd system configuration information | .Nd system configuration information | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The file | The file | ||||
.Nm | .Nm | ||||
▲ Show 20 Lines • Show All 1,774 Lines • ▼ Show 20 Lines | |||||
.Dq :nosticky | .Dq :nosticky | ||||
keyword can be used to override it on per interface basis. | keyword can be used to override it on per interface basis. | ||||
.It Va gif_interfaces | .It Va gif_interfaces | ||||
.Pq Vt str | .Pq Vt str | ||||
This variable is deprecated in favor of | This variable is deprecated in favor of | ||||
.Va cloned_interfaces . | .Va cloned_interfaces . | ||||
Set to the list of | Set to the list of | ||||
.Xr gif 4 | .Xr gif 4 | ||||
tunnel interfaces to configure on this host. | tunnel interfaces to configure on this host. | ||||
A | For each | ||||
wblock: Not yours, I know, but "is assumed to exist" is terrible. Assumed by who? This kind of says… | |||||
Not Done Inline ActionsGood point. How about "variable should exist for each value"? karels: Good point. How about "variable should exist for each value"? | |||||
Not Done Inline ActionsOr maybe " variable should be defined for each value of"? The variable needs to be defined in /etc/rc.conf. karels: Or maybe " variable should be defined for each value of"? The variable needs to be defined in… | |||||
Not Done Inline ActionsHm, I did not take the wording to mean that the user is supposed to define those variables, but that the system did it. An example of the importance of wording, I guess. Anyway, let's just say that in an imperative way (roughly paraphrasing): For each tunnel interface, set a variable named .Va ifconfig_ Ns Aq Ar interface to the values desired to configure the link layer of the tunnel with the A complete example would be good here. The one given does not show an actual example of actual naming of the variable. wblock: Hm, I did not take the wording to mean that the user is supposed to define those variables, but… | |||||
.Va gifconfig_ Ns Aq Ar interface | .Xr gif | ||||
variable is assumed to exist for each value of | tunnel interface, set a variable named | ||||
.Ar interface . | .Va ifconfig_ Ns Aq Ar interface | ||||
with the parameters for the | |||||
.Xr ifconfig 8 | |||||
command to configure the link level for | |||||
.Ar interface | |||||
with the | |||||
.Cm tunnel | |||||
option. | |||||
The value of this variable is used to configure the link layer of the | The value of this variable is used to configure the link layer of the | ||||
tunnel according to the syntax of the | tunnel using the | ||||
.Cm tunnel | .Cm tunnel | ||||
option to | option to | ||||
.Xr ifconfig 8 . | .Xr ifconfig . | ||||
For example, configure two | |||||
Not Done Inline ActionsAnd use this for the full example: For example: .Bd -literal -offset indent ifconfig_gif0="blah blah" .Ed With real values for the variable name and contents of the quotes. Actually, looking at that, it makes me more confused, and I'm not sure if the name of the variable on line 1820 is correct. All the more reason for a literal example. wblock: And use this for the full example:
```For example:
.Bd -literal -offset indent… | |||||
Not Done Inline ActionsSorry, I hadn't noticed this comment before uploading a new version. I can touch up the macro usage, but will wait for comments on the content. karels: Sorry, I hadn't noticed this comment before uploading a new version. I can touch up the macro… | |||||
Not Done Inline ActionsI tried the suggested macros, and they put a blank line before the display but not after, which looks odd. Suggestions for fixing this welcome; i don't think this is a whole line of space in the typeset version. karels: I tried the suggested macros, and they put a blank line before the display but not after, which… | |||||
Not Done Inline ActionsWarren (or anyone), suggestions on how to do this display with reasonable spacing (same before and after)? Any comments on the text? karels: Warren (or anyone), suggestions on how to do this display with reasonable spacing (same before… | |||||
Not Done Inline ActionsI've seen some other places that put a '.Pp' after the '.Ed' (on its own line), which seems to add the desired spacing. bjk: I've seen some other places that put a '.Pp' after the '.Ed' (on its own line), which seems to… | |||||
.Xr gif | |||||
interfaces with: | |||||
.Bd -literal -offset indent | |||||
gif_interfaces="gif0 gif1" | |||||
ifconfig_gif0="tunnel src_addr0 dst_addr0" | |||||
ifconfig_gif1="tunnel src_addr1 dst_addr1" | |||||
.Ed | |||||
.Pp | |||||
Not Done Inline ActionsEnd this sentence here: .Xr ifconfig 8 . wblock: End this sentence here:
```.Xr ifconfig 8 .``` | |||||
Additionally, this option ensures that each listed interface is created | Additionally, this option ensures that each listed interface is created | ||||
via the | via the | ||||
.Cm create | .Cm create | ||||
option to | option to | ||||
.Xr ifconfig 8 | .Xr ifconfig . | ||||
before attempting to configure it. | This example also works with | ||||
.Va cloned_interfaces | |||||
instead of | |||||
.Va gif_interfaces . | |||||
.It Va sppp_interfaces | .It Va sppp_interfaces | ||||
.Pq Vt str | .Pq Vt str | ||||
Set to the list of | Set to the list of | ||||
.Xr sppp 4 | .Xr sppp 4 | ||||
interfaces to configure on this host. | interfaces to configure on this host. | ||||
A | A | ||||
.Va spppconfig_ Ns Aq Ar interface | .Va spppconfig_ Ns Aq Ar interface | ||||
variable is assumed to exist for each value of | variable is assumed to exist for each value of | ||||
▲ Show 20 Lines • Show All 2,729 Lines • Show Last 20 Lines |
Not yours, I know, but "is assumed to exist" is terrible. Assumed by who? This kind of says "the code makes assumptions that will probably break and we are just letting you know."
Is there any reason this can't be changed to just