share/man/man5/varsym.conf.5

   1 .\"
   2 .\" Copyright (c) 2007
   3 .\"     The DragonFly Project.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\" 3. Neither the name of The DragonFly Project nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific, prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd December 19, 2018
  33 .Dt VARSYM.CONF 5
  34 .Os
  35 .Sh NAME
  36 .Nm varsym.conf
  37 .Nd set system-wide
  38 .Xr varsym 1
  39 variables
  40 .Sh SYNOPSIS
  41 .Pa /etc/varsym.conf
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 file specifies a list of system-wide variables that can then be used in
  46 variant symlinks.
  47 Each line specifies one variable and its data in the same format of the
  48 .Xr varsym 1
  49 command, i.e.,
  50 .Bd -literal -offset indent
  51 var=data
  52 "variable name"="variable data"
  53 .Ed
  54 .Pp
  55 Spaces are not allowed around the
  56 .Dq =
  57 sign.
  58 Both the variable name and data can contain spaces but must be quoted.
  59 Empty lines or lines beginning with a
  60 .Dq #
  61 are ignored.
  62 Inline comments should not be used.
  63 .Pp
  64 Processing
  65 .Nm
  66 is activated by setting
  67 .Va varsym_enable
  68 in
  69 .Pa /etc/rc.conf
  70 and setting the
  71 .Va vfs.varsym_enable
  72 sysctl.
  73 .Sh FILES
  74 .Bl -tag -width ".Pa /etc/varsym.conf" -compact
  75 .It Pa /etc/varsym.conf
  76 configuration file for specifying system-wide
  77 .Xr varsym 1
  78 variables
  79 .El
  80 .Sh SEE ALSO
  81 .Xr ln 1 ,
  82 .Xr varsym 1 ,
  83 .Xr rc.conf 5
  84 .Sh AUTHORS
  85 This manual page was written by
  86 .An Sascha Wildner .