b3dac3038995d78ba90de52cd643b63318fa36bf
[dragonfly.git] / bin / varsym / varsym.1
1 .\" Copyright (c) 2003 Matthew Dillon <dillon@backplane.com>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $DragonFly: src/bin/varsym/varsym.1,v 1.10 2008/02/22 05:19:25 swildner Exp $
26 .\"
27 .Dd November 5, 2003
28 .Dt VARSYM 1
29 .Os
30 .Sh NAME
31 .Nm varsym
32 .Nd get and set user and system-wide variables for variant symlinks
33 .Sh SYNOPSIS
34 .Nm
35 .Op Fl qadsup
36 .Ar var[=data]
37 .Sh DESCRIPTION
38 The
39 .Nm
40 program manages user and system-wide variables.  These variables are typically
41 used by the system to resolve variant symlinks but may also be used generally.
42 .Pp
43 For each operand set, modify, retrieve, or delete the specified variable.
44 By default variables specified without data are retrieved and variables
45 specified with data are set.  Variables may be set to empty.
46 .Bl -tag -width Ar
47 .It Fl a
48 List all variables at the specified level.  Note that per-process variables
49 override per-user variables and per-user variables override system-wide
50 variables.  By default, per-user variables are listed.
51 .It Fl q
52 Quiet mode.  When retrieving a variable only its data is printed.
53 .It Fl d
54 Delete mode.  The specified variables are deleted.  Any specified data is
55 ignored.
56 .It Fl s
57 This option causes variables to be set system-wide and restricts retrievals
58 to system-specific variables.
59 .It Fl u
60 This option causes variables to be set on a per-user-id basis and restricts
61 retrievals to user-specific variables.  This is the default.
62 .It Fl p
63 This option causes variables to be set on a per-process basis and restricts
64 retrievals to process-specific variables.  Note that since
65 .Nm
66 is run as its own process, using this option to set a variable will not
67 affect your shell's namespace.
68 .El
69 .Sh DIAGNOSTICS
70 The
71 .Nm
72 utility exits with one of the following values:
73 .Bl -tag -width Ds
74 .It 0
75 No errors occurred.
76 .It 1
77 A requested variable could not be found
78 .It 2
79 A requested variable could not be set
80 .El
81 .Sh SEE ALSO
82 .Xr ln 1 ,
83 .Xr varsym 2 ,
84 .Xr varsym.conf 5