293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / updatehome.1m
blob2d97934d39a6de5eb693eab04f5cf6b265d0a989
1 '\" te
2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH UPDATEHOME 1M "Jul 20, 2007"
7 .SH NAME
8 updatehome \- update the home directory copy and link files for the current
9 label
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/usr/bin/updatehome\fR  [\fB-cirs\fR]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 \fBupdatehome\fR reads the user's minimum-label copy and link-control files
20 (\fB\&.copy_files\fR and \fB\&.link_files\fR). These files contain a list of
21 files to be copied and symbolically linked from the user's minimum-label home
22 directory to the user's home directory at the current label.
23 .sp
24 .LP
25 The Solaris Trusted Extensions \fBdtsession\fR program performs an
26 \fBupdatehome\fR whenever a newly labeled workspace is created so that the
27 user's favorite files are available for use. For example, the user probably
28 wants a symbolic link to such files as \fB\&.profile\fR, \fB\&.login\fR,
29 \fB\&.cshrc\fR, \fB\&.exrc\fR, \fB\&.mailrc\fR, and \fB~/bin\fR. The
30 \fBupdatehome\fR command provides a convenient mechanism for accomplishing this
31 symlink. The user can add files to those to be copied (\fB\&.copy_files\fR) and
32 to those to be symbolically linked (\fB\&.link_files\fR).
33 .SH OPTIONS
34 .sp
35 .ne 2
36 .na
37 \fB\fB-c\fR\fR
38 .ad
39 .RS 6n
40 Replace existing home-directory copies at the current label. The default is to
41 skip over existing copies.
42 .RE
44 .sp
45 .ne 2
46 .na
47 \fB\fB-i\fR\fR
48 .ad
49 .RS 6n
50 Ignore errors encountered. The default aborts on error.
51 .RE
53 .sp
54 .ne 2
55 .na
56 \fB\fB-r\fR\fR
57 .ad
58 .RS 6n
59 Replace existing home-directory copies or symbolic links at the current label.
60 This option implies options \fB-c\fR and \fB-s\fR. The default is to skip over
61 existing copies or symbolic links.
62 .RE
64 .sp
65 .ne 2
66 .na
67 \fB\fB-s\fR\fR
68 .ad
69 .RS 6n
70 Replace existing home-directory symbolic links at the current label. The
71 default is to skip over existing symbolic links.
72 .RE
74 .SH EXIT STATUS
75 .sp
76 .LP
77 Upon success, \fBupdatehome\fR returns \fB0\fR. Upon failure, \fBupdatehome\fR
78 returns \fB1\fR and writes diagnostic messages to standard error.
79 .SH EXAMPLES
80 .LP
81 \fBExample 1 \fRA Sample \fB\&.copy_files\fR File
82 .sp
83 .LP
84 The files that are listed in \fB\&.copy_files\fR can be modified at every
85 user's label.
87 .sp
88 .in +2
89 .nf
90 \&.cshrc
91 \&.mailrc
92 \&.mozilla/bookmarks.html
93 .fi
94 .in -2
95 .sp
97 .LP
98 \fBExample 2 \fRA Sample \fB\&.link_files\fR File
99 .sp
101 The files that are listed in \fB\&.link_files\fR can be modified at the lowest
102 label. The changes propagate to the other labels that are available to the
103 user.
106 .in +2
108 ~/bin
109 \&.mozilla/preferences
110 \&.xrc
111 \&.rhosts
113 .in -2
117 \fBExample 3 \fRUpdating the Linked and Copied Files
120 The \fB\&.copy_files\fR and \fB\&.link_files\fR were updated by the user at the
121 minimum label. At a higher label, the user refreshes the copies and the links.
122 No privileges are required to run the command.
125 .in +2
127 % \fBupdatehome -r\fR
129 .in -2
132 .SH FILES
134 .ne 2
136 \fB\fB$HOME/.copy_files\fR\fR
138 .RS 21n
139 List of files to be copied
143 .ne 2
145 \fB\fB$HOME/.link_files\fR\fR
147 .RS 21n
148 List of files to be symbolically linked
151 .SH ATTRIBUTES
154 See \fBattributes\fR(5) for descriptions of the following attributes:
159 box;
160 c | c
161 l | l .
162 ATTRIBUTE TYPE  ATTRIBUTE VALUE
164 Interface Stability     Committed
167 .SH SEE ALSO
170 \fBattributes\fR(5)
173 \fI\&.copy_files and .link_files Files\fR in \fISolaris Trusted Extensions
174 Administrator\&'s Procedures\fR
175 .SH NOTES
178 The functionality described on this manual page is available only if the system
179 is configured with Trusted Extensions.