From a80177cc847102d5a6e43a8ff87769e86f30bd6c Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Mon, 18 Oct 2010 13:18:20 +0100 Subject: [PATCH] tools: Add section describing quoting libvirt domain names to docs (RHBZ#643624) --- inspector/virt-inspector | 7 +++++++ tools/virt-cat | 7 +++++++ tools/virt-df | 7 +++++++ tools/virt-edit | 7 +++++++ tools/virt-list-filesystems | 7 +++++++ tools/virt-list-partitions | 7 +++++++ tools/virt-ls | 7 +++++++ tools/virt-make-fs | 7 +++++++ tools/virt-rescue | 7 +++++++ tools/virt-resize | 7 +++++++ tools/virt-tar | 7 +++++++ tools/virt-win-reg | 7 +++++++ 12 files changed, 84 insertions(+) diff --git a/inspector/virt-inspector b/inspector/virt-inspector index dc15f0d..04a0771 100755 --- a/inspector/virt-inspector +++ b/inspector/virt-inspector @@ -843,6 +843,13 @@ sub output_query_kernel_arch =back +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-cat b/tools/virt-cat index e000e25..67506c0 100755 --- a/tools/virt-cat +++ b/tools/virt-cat @@ -160,6 +160,13 @@ mount_operating_system ($g, $os); # NB: https://bugzilla.redhat.com/show_bug.cgi?id=501888 print $g->download($filename, "/dev/stdout"); +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-df b/tools/virt-df index 71658f7..1551221 100755 --- a/tools/virt-df +++ b/tools/virt-df @@ -533,6 +533,13 @@ for Perl or Python's built-in csv library). Most spreadsheets and databases can import CSV directly. +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-edit b/tools/virt-edit index 128872e..59b5b2b 100755 --- a/tools/virt-edit +++ b/tools/virt-edit @@ -322,6 +322,13 @@ If not set, C is used. =back +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-list-filesystems b/tools/virt-list-filesystems index 921704b..7b4d5ad 100755 --- a/tools/virt-list-filesystems +++ b/tools/virt-list-filesystems @@ -188,6 +188,13 @@ sub canonicalize $_; } +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-list-partitions b/tools/virt-list-partitions index 8bda62e..0edecc4 100755 --- a/tools/virt-list-partitions +++ b/tools/virt-list-partitions @@ -226,6 +226,13 @@ sub human_size } } +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-ls b/tools/virt-ls index 8813d2f..9271a91 100755 --- a/tools/virt-ls +++ b/tools/virt-ls @@ -207,6 +207,13 @@ unless ($mode) { close F; } +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-make-fs b/tools/virt-make-fs index 3f27a62..1a6aee4 100755 --- a/tools/virt-make-fs +++ b/tools/virt-make-fs @@ -524,6 +524,13 @@ sub create_pipe return $pipe; } +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-rescue b/tools/virt-rescue index 7a87fbc..b8902a5 100755 --- a/tools/virt-rescue +++ b/tools/virt-rescue @@ -228,6 +228,13 @@ exit 0; Several environment variables affect virt-rescue. See L for the complete list. +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-resize b/tools/virt-resize index 6e11d47..4bb8821 100755 --- a/tools/virt-resize +++ b/tools/virt-resize @@ -1396,6 +1396,13 @@ hand-calculating sector offsets, which is something that virt-resize was designed to avoid. If you want to see the guestfish-equivalent commands that virt-resize runs, use the C<--debug> flag. +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-tar b/tools/virt-tar index 3e6e20b..5e6e95a 100755 --- a/tools/virt-tar +++ b/tools/virt-tar @@ -254,6 +254,13 @@ undef $g; exit 0; +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, diff --git a/tools/virt-win-reg b/tools/virt-win-reg index afa8087..16688f4 100755 --- a/tools/virt-win-reg +++ b/tools/virt-win-reg @@ -458,6 +458,13 @@ sub upload_hive } } +=head1 SHELL QUOTING + +Libvirt guest names can contain arbitrary characters, some of which +have meaning to the shell such as C<#> and space. You may need to +quote or escape these characters on the command line. See the shell +manual page L for details. + =head1 SEE ALSO L, -- 1.8.3.1