jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-18 23:10:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
18b4243772
openafs/doc/man-pages/pod1/vos_online.pod.in

90 lines
2.2 KiB
Plaintext
Raw Normal View History

man-vos-online-20070611 Add initial man pages for vos offline and vos online.
2007-06-12 05:42:01 +01:00
=head1 NAME
man-page-name-underscore-20071111 The NAME heading for man pages can't contain a space in the program side or the man pages won't index with some man implementations.
2007-11-11 22:54:56 +00:00
vos_online - Brings a volume online
man-vos-online-20070611 Add initial man pages for vos offline and vos online.
2007-06-12 05:42:01 +01:00
=head1 SYNOPSIS
=for html
<div class="synopsis">
Update vos suite manpages Larger collection of all vos suite commands, including but not limited to: -- documented all commands / options, verified against both 1.4 and 1.5 tree (including the common -encrypt/-noresolve options) -- correct order, POD formatting and synopsis for all commands' options -- shorthand synopsis provided for all commands that missed it, with proper non-ambiguous command abbreviations of all options -- POD synopsis formatted to 80-columns in commands where it was running over -- for newer options, documented which OpenAFS version they became available -- proper manpage links using L<> in vos.pod Reviewed-on: http://gerrit.openafs.org/609 Tested-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 18:31:00 +01:00
B<vos online> S<<< B<-server> <I<machine name>> >>>
S<<< B<-partition> <I<partition name>> >>>
S<<< B<-id> <I<volume name or ID>> >>>
Remove bless-related options from vos manpages 'vos online' and 'vos offline' were documented as taking -bless and -unbless options, respectively. They do not actually take these options, and since adding that functionality, while useful, will require protocol changes, they are likely to take some time to appear. Change-Id: I91800e9637162e24873beac5d41f3ad456f25af8 Reviewed-on: http://gerrit.openafs.org/2481 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-29 18:43:25 +01:00
S<<< [B<-cell> <I<cell name>>] >>>
Update vos suite manpages Larger collection of all vos suite commands, including but not limited to: -- documented all commands / options, verified against both 1.4 and 1.5 tree (including the common -encrypt/-noresolve options) -- correct order, POD formatting and synopsis for all commands' options -- shorthand synopsis provided for all commands that missed it, with proper non-ambiguous command abbreviations of all options -- POD synopsis formatted to 80-columns in commands where it was running over -- for newer options, documented which OpenAFS version they became available -- proper manpage links using L<> in vos.pod Reviewed-on: http://gerrit.openafs.org/609 Tested-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 18:31:00 +01:00
[B<-noauth>] B<-localauth>]
doc: vos manpage fixes - Add missing -config option to 'common' vos options, and to the synopsis for all commands - Remove brackets in the options descriptions for vos_shadow, vos_create, and vos_clone. We don't do this in other manpages. - vos_create: Add missing -id, -roid to synopsis - vos_clone: Add missing -readwrite option - vos_shadow: Add missing -toid option Change-Id: I41fd56509e78116698c82a2f3f4fd07f26cdc95f Reviewed-on: http://gerrit.openafs.org/10397 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
2013-06-20 23:45:05 +01:00
[B<-verbose>] [B<-encrypt>] [B<-noresolve>]
S<<< [B<-config> <I<config directory>>] >>>
[B<-help>]
Update vos suite manpages Larger collection of all vos suite commands, including but not limited to: -- documented all commands / options, verified against both 1.4 and 1.5 tree (including the common -encrypt/-noresolve options) -- correct order, POD formatting and synopsis for all commands' options -- shorthand synopsis provided for all commands that missed it, with proper non-ambiguous command abbreviations of all options -- POD synopsis formatted to 80-columns in commands where it was running over -- for newer options, documented which OpenAFS version they became available -- proper manpage links using L<> in vos.pod Reviewed-on: http://gerrit.openafs.org/609 Tested-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 18:31:00 +01:00
B<vos on> S<<< B<-s> <I<machine name>> >>>
S<<< B<-p> <I<partition name>> >>>
S<<< B<-i> <I<volume name or ID>> >>>
Remove bless-related options from vos manpages 'vos online' and 'vos offline' were documented as taking -bless and -unbless options, respectively. They do not actually take these options, and since adding that functionality, while useful, will require protocol changes, they are likely to take some time to appear. Change-Id: I91800e9637162e24873beac5d41f3ad456f25af8 Reviewed-on: http://gerrit.openafs.org/2481 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-29 18:43:25 +01:00
S<<< [B<-c> <I<cell name>>] >>>
doc: vos manpage fixes - Add missing -config option to 'common' vos options, and to the synopsis for all commands - Remove brackets in the options descriptions for vos_shadow, vos_create, and vos_clone. We don't do this in other manpages. - vos_create: Add missing -id, -roid to synopsis - vos_clone: Add missing -readwrite option - vos_shadow: Add missing -toid option Change-Id: I41fd56509e78116698c82a2f3f4fd07f26cdc95f Reviewed-on: http://gerrit.openafs.org/10397 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
2013-06-20 23:45:05 +01:00
[B<-noa>] B<-l>] [B<-v>] [B<-e>] [B<-nor>]
S<<< [B<-co> <I<config directory>>] >>>
[B<-h>]
man-vos-online-20070611 Add initial man pages for vos offline and vos online.
2007-06-12 05:42:01 +01:00
=for html
</div>
=head1 DESCRIPTION
The B<vos online> command brings an offline volume on line with the
B<fileserver>.
=head1 CAUTIONS
None.
=head1 OPTIONS
=over 4
=item B<-server> <I<machine name>>
Identifies the file server machine where the volume resides.
Provide the machine's IP address or its host name (either fully
qualified or using an unambiguous abbreviation). For details, see
L<vos(1)>.
=item B<-partition> <I<partition name>>
Identifies the partition where the volume resides, on the
file server machine named by the B<-server> argument. Provide the
partition's complete name with preceding slash (for example, C</vicepa>)
or use one of the three acceptable abbreviated forms. For details, see
L<vos(1)>.
=item B<-id> <I<volume name or ID>>
Specifies either the complete name or volume ID number of the volume.
doc: Make all vos pages =include common options Many manpages for "vos" subcommands were not using the "common" vos fragments, and instead were just repeating the information directly in their manpage. Make them all use the "common" vos fragment to avoid duplication. Change-Id: I62d84a1164b4ba46082e33a6d27fd24e3722014c Reviewed-on: http://gerrit.openafs.org/10398 Reviewed-by: Derrick Brashear <shadow@your-file-system.com> Tested-by: BuildBot <buildbot@rampaginggeek.com>
2013-06-30 03:06:51 +01:00
=include fragments/vos-common.pod
man-vos-online-20070611 Add initial man pages for vos offline and vos online.
2007-06-12 05:42:01 +01:00
=back
=head1 EXAMPLES
The following example brings an offline volume online:
doc: replace hostnames with IETF example hostnames There were several different real and made-up hostnames and company names used throughout our documentation examples. The IETF has reserved "example.com" and other "example" TLDs for use in examples (RFC 2606). Replace almost all references to ABC Corporation, DEF Corporation, and State University, as well as "abc.com", "bigcell.com", "def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu", "stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com". Standardize on "Example Corporation", "Example Network", "Example Organization" (example.com, example.net, and example.org). The Scout documentation in the Admin Guide contains PNG images that contain the old cell names, so I left those references until the images can be replaced. Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367 Reviewed-on: http://gerrit.openafs.org/6697 Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com> Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-11 16:43:30 +00:00
% vos online -server sv7.example.org -partition /vicepb -id root.afs
man-vos-online-20070611 Add initial man pages for vos offline and vos online.
2007-06-12 05:42:01 +01:00
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine specified with the B<-server> argument and on each database server
machine. If the B<-localauth> flag is included, the issuer must instead be
logged on to a server machine as the local superuser C<root>.
=head1 SEE ALSO
L<vos(1)>,
L<vos_offline(1)>,
L<bos_salvage(8)>,
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This man page was created by Steven Jenkins.
Reference in New Issue Copy Permalink