Commit | Line | Data |
---|---|---|
805e021f CE |
1 | =head1 NAME |
2 | ||
3 | fs_discon - Manage client "disconnected mode" | |
4 | ||
5 | =head1 SYNOPSIS | |
6 | ||
7 | =for html | |
8 | <div class="synopsis"> | |
9 | ||
10 | B<fs discon> S<<< B<-mode> <offline | online> >>> | |
11 | S<<< [B<-policy> <client | server>] >>> | |
12 | [B<-force>] | |
13 | S<<< [B<-uid> <I<uid>>] >>> | |
14 | [B<-help>] | |
15 | ||
16 | B<fs disc> S<<< B<-m> <offline | online> >>> | |
17 | S<<< [B<-p> <client | server>] >>> | |
18 | [B<-f>] | |
19 | S<<< [B<-u> <I<uid>>] >>> | |
20 | [B<-h>] | |
21 | ||
22 | =for html | |
23 | </div> | |
24 | ||
25 | =head1 DESCRIPTION | |
26 | ||
27 | The B<fs discon> command configures "disconnected mode" in the OpenAFS Cache | |
28 | Manager. Disconnected mode allows you to keep reading and writing files in AFS | |
29 | without a network connection, and any changes to files are recorded locally. | |
30 | When the network connection is restored and disconnected mode is turned off, | |
31 | any locally recorded changes are sent to the relevant server. | |
32 | ||
33 | This command was introduced in OpenAFS 1.5.38. | |
34 | ||
35 | =head1 CAUTIONS | |
36 | ||
37 | The "disconnected mode" of the OpenAFS cache manager is still considered an | |
38 | experimental feature. It can be a bit rough around the edges, and you may lose | |
39 | or corrupt data you have written while in disconnected mode. Use with caution. | |
40 | ||
41 | =head1 OPTIONS | |
42 | ||
43 | =over 4 | |
44 | ||
45 | =item B<-mode> <offline | online> | |
46 | ||
47 | This turns "disconnected mode" on or off. If C<offline> is specified, the | |
48 | client will go into disconnected mode, and the client will no longer make any | |
49 | effort to reach any server over the network. | |
50 | ||
51 | If C<online> is specified, the client will come out of disconnected mode, and | |
52 | any pending changes will be sent to the relevant server. If there are errors | |
53 | when synchronizing changes to the server, the client will stay in disconnected | |
54 | mode, unless the B<-force> flag is also given. See B<-force>. | |
55 | ||
56 | =item B<-policy> <client | server> | |
57 | ||
58 | This specifies the conflict resolution policy when resynchronizing data afer | |
59 | coming back online. A conflict resolution policy is needed when changes have | |
60 | been made locally on the client while in disconnected mode, and different | |
61 | changes have occurred on the server while we were in disconnected mode. When | |
62 | this happens, there are two different possible results: | |
63 | ||
64 | If C<client> is specified, the local changes on the client will overwrite any | |
65 | conflicting changes on the server. This means that if we change a file locally | |
66 | while in disconnected mode, and another user changes the same file in the same | |
67 | place on the fileserver while we are disconnected, the other user's changes | |
68 | will be lost. | |
69 | ||
70 | If C<server> is specified, the conflicting changes on the server will overwrite | |
71 | our local changes. This means that if we change a file locally while in | |
72 | disconnected mode, and another user changes the same file in the same place on | |
73 | the fileserver while we are disconnected, our local changes will be lost. | |
74 | ||
75 | The default value is C<server>. | |
76 | ||
77 | =item B<-force> | |
78 | ||
79 | If B<-force> is specified when coming back online, any errors during | |
80 | resynchronization are ignored by throwing away our local changes. That is, if | |
81 | we write our local pending changes to a server while coming back online, and | |
82 | there is an error while writing those changes, those changes will be lost. | |
83 | ||
84 | Without B<-force>, such an error causes the client to stay offline. | |
85 | ||
86 | =item B<-uid> <I<uid>> | |
87 | ||
88 | When resynchronizing local pending changes to the relevant fileserver, by | |
89 | default we use the credentials of the user issuing B<fs discon> to send the | |
90 | changes to the fileserver. If B<-uid> is specified, we will instead use the | |
91 | credentials for the specified uid. | |
92 | ||
93 | Note that this will only use the PAG-less credentials of the specified uid. It | |
94 | is currently not possible to specify an arbitrary PAG here. | |
95 | ||
96 | =item B<-help> | |
97 | ||
98 | Prints the online help for this command. All other valid options are | |
99 | ignored. | |
100 | ||
101 | =back | |
102 | ||
103 | =head1 PRIVILEGE REQUIRED | |
104 | ||
105 | The issuer must be logged in as the local superuser C<root>. | |
106 | ||
107 | =head1 SEE ALSO | |
108 | ||
109 | L<afsd(8)> | |
110 | ||
111 | =head1 COPYRIGHT | |
112 | ||
113 | Copyright 2013 Sine Nomine Associates | |
114 | ||
115 | This documentation is covered by the BSD License as written in the | |
116 | doc/LICENSE file. This man page was written by Andrew Deason for | |
117 | OpenAFS. |