[OpenAFS-Doc] new man page: vos_changeaddr

[Jason Edgecombe]

This is a multi-part message in MIME format.
--------------080104060409010503050101
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit

new man page: vos changeloc.pod
a small diff against the latest cvs.

Jason

--------------080104060409010503050101
Content-Type: text/plain; x-mac-type="0"; x-mac-creator="0";
 name="vos_changeloc.pod"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="vos_changeloc.pod"

=head1 NAME

vos changeloc - Change a volume's entry in the volume database

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<vos changeloc> S<<< [B<-server>] <I<new server name>> >>>
   S<<< [B<-partition>] <I<new partition location>> >>>
   S<<< [B<-id>] <I<volume name or ID>> >>>
   S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-localauth>]
   [B<-verbose>] [B<-encrypt>] [B<-help>]

=for html
</div>

=head1 DESCRIPTION

The B<vos changeloc> command changes the location of a volume in the
Volume Location Database (VLDB) without needing to contact the
original file server on which the volume was hosted. This is useful
when a file server has gone down permanently and the OpenAFS /vicepx
disks have been moved to a new file server with a different name and
IP address. Without this command, the OpenAFS administrator could not
relocate the volumes to the new server. The recovered volumes can be
moved to any live file server, not just the new file server. After the
volumes have been "moved" to a live server, then B<vos syncvldb> and
B<vos syncserv> can be used to synchronize the volumes housed on the
file servers and VLDB.

In essence, B<vos changeloc> performs the same operations on the VLDB
as B<vos move>, but it does NOT move the data from one server's hard
drive to another.

=head1 CAUTIONS

Using B<vos changeloc> causes the VLDB to be out of sync with the data
on the servers. If the servers are on-line, then B<vos move> should be
used instead. It is highly recommended that B<vos syncvldb> and B<vos
syncserv> be run after using the B<vos changeloc> command in order to
synchronize the VLDB with the file servers.

=head1 OPTIONS

B<vos changeloc> takes the following options:

=over 4

=item B<-server> <I<new server name>>

Specifies the new server where the volume should reside according to
the VLDB.

=item B<-cell> <I<cell name>>

Specifies the new partition where the volume should reside according
to the VLDB.

=item B<-id> <I<volume name or ID>>

Specifies the volume name or ID on which to operate.

=item B<-cell> <I<cell name>>

Specifies an alternate cell to talk to.

=item B<-noauth>

Perform the action as the unauthenticated user instead of using the
current users credentials.

=item B<-localauth>

Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
to the Volume Server and Volume Location Server during mutual
authentication. Do not combine this flag with the B<-cell> argument or
B<-noauth> flag. For more details, see L<vos(1)>.

=item B<-verbose>

Shows more output about what's going on.

=item B<-encrypt>

Encrypts the commands that are sent to the server.

=item B<-help>

Prints a brief help message.

=back

=head1 OUTPUT

B<vos changeloc> shows a brief message upon completion:
   Changed location to server2 /vicepa for volume user.jdoe

=head1 EXAMPLES

The following command changes the location of the user.jdoe volume to
be /vicepa on server2 while being verbose:

   % vos changeloc server2 a user.jdoe -verbose
    done
   Changed location to server2 /vicepa for volume user.jdoe

The following command changes the location of the user.jdoe volume to
be /vicepa on server1 without being verbose:

   % vos changeloc server1 a user.jdoe
   Changed location to server1 /vicepa for volume user.jdoe

=head1 PRIVILEGE REQUIRED

The user must be an OpenAFS Administrator in order to use the B<vos changeloc>
command.

=head1 SEE ALSO

L<vos(1)>,
L<vos_move(1)>,
L<vos_syncserv(1)>,
L<vos_syncvldb(1)>

L<http://www.openafs.org/pipermail/openafs-info/2005-December/020887.html>

=head1 COPYRIGHT

Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>

This documentation is covered by the IBM Public License Version 1.0. This
man page was written by Jason Edgecombe for OpenAFS.

--------------080104060409010503050101
Content-Type: text/plain;
 name="diff.txt"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="diff.txt"

? vos_changeloc.pod
Index: pts.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/pts.pod,v
retrieving revision 1.3
diff -u -r1.3 pts.pod
--- pts.pod	17 Aug 2007 23:35:45 -0000	1.3
+++ pts.pod	18 Aug 2007 01:53:59 -0000
@@ -52,6 +52,17 @@
 
 =item *
 
+<<<<<<< pts.pod
+Commands to run commands interactively: B<pts interactive>, B<pts
+sleep>, and B<pts quit>
+
+=item *
+
+A command to read bulk commands form a file: B<pts source>
+
+=item *
+
+=======
 Commands to run commands interactively: B<pts interactive>, B<pts
 sleep>, and B<pts quit>.
 
@@ -61,6 +72,7 @@
 
 =item *
 
+>>>>>>> 1.3
 Commands to obtain help: B<pts apropos> and B<pts help>.
 
 =back
Index: pts_source.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/pts_source.pod,v
retrieving revision 1.2
diff -u -r1.2 pts_source.pod
--- pts_source.pod	17 Aug 2007 23:35:45 -0000	1.2
+++ pts_source.pod	18 Aug 2007 01:53:59 -0000
@@ -40,6 +40,10 @@
 Names the cell in which to run the command. For more details, see
 L<pts(1)>.
 
+=item B<-file> <I<file name>>
+
+Specifies the filename from which to read commands.
+
 =item B<-force>
 
 Enables the command to continue executing as far as possible when errors
Index: vos.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/vos.pod,v
retrieving revision 1.4
diff -u -r1.4 vos.pod
--- vos.pod	5 Aug 2007 21:58:35 -0000	1.4
+++ vos.pod	18 Aug 2007 01:54:00 -0000
@@ -236,6 +236,7 @@
 L<vos_backup(1)>,
 L<vos_backupsys(1)>,
 L<vos_changeaddr(1)>,
+L<vos_changeloc(1)>,
 L<vos_create(1)>,
 L<vos_delentry(1)>,
 L<vos_dump(1)>,

--------------080104060409010503050101--