[virt-tools-list] [PATCH virt-viewer] man: add remote-viewer man page

Marc-André Lureau marcandre.lureau at gmail.com
Wed Feb 1 14:41:11 UTC 2012


---
 man/Makefile.am             |   12 +++++-
 man/remote-viewer.pod       |   79 +++++++++++++++++++++++++++++++++++++++++++
 man/virt-viewer.pod         |    2 +-
 mingw32-virt-viewer.spec.in |    1 +
 virt-viewer.spec.in         |    1 +
 5 files changed, 92 insertions(+), 3 deletions(-)
 create mode 100644 man/remote-viewer.pod

diff --git a/man/Makefile.am b/man/Makefile.am
index 9257ce2..09ca502 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,7 +1,15 @@
+NULL =
 
-man_MANS = virt-viewer.1
+man_MANS =					\
+	remote-viewer.1				\
+	virt-viewer.1				\
+	$(NULL)
+
+EXTRA_DIST =					\
+	remote-viewer.pod			\
+	virt-viewer.pod				\
+	$(NULL)
 
-EXTRA_DIST = virt-viewer.pod
 DISTCLEANFILES = $(man_MANS)
 
 %.1: %.pod
diff --git a/man/remote-viewer.pod b/man/remote-viewer.pod
new file mode 100644
index 0000000..82fd9e5
--- /dev/null
+++ b/man/remote-viewer.pod
@@ -0,0 +1,79 @@
+
+=head1 NAME
+
+remote-viewer - a simple remote desktop client
+
+=head1 SYNOPSIS
+
+B<remote-viewer> [OPTIONS] URI
+
+=head1 DESCRIPTION
+
+B<remote-viewer> is a simple remote display client. The supported
+protocols are SPICE and VNC.
+
+=head1 OPTIONS
+
+The following options are accepted when running C<remote-viewer>:
+
+=over 4
+
+=item -h, --help
+
+Display command line help summary
+
+=item -V, --version
+
+Display program version number
+
+=item -v, --verbose
+
+Display information about the connection
+
+=item -z PCT, --zoom=PCT
+
+Zoom level of the display window in percentage. Range 10-200.
+
+=item -f, --fullscreen
+
+Start with the window maximised to fullscreen
+
+=item --spice-controller
+
+Use the SPICE controller to initialize the connection with the SPICE
+server. This option is used by the SPICE browser addons to allow web
+page to start a client.
+
+=item --debug
+
+Print debugging information
+
+=back
+
+=head1 EXAMPLES
+
+To connect to SPICE server on host "makai" with port 5900
+
+   remote-viewer spice://makai:5900
+
+To connect to VNC server on host "tsingy" with port 5900
+
+   remote-viewer vnc://tsingy:5900
+
+=head1 BUGS
+
+Report bugs to the mailing list C<http://www.redhat.com/mailman/listinfo/virt-tools-list>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2012 Red Hat, Inc, and various contributors.
+This is free software. You may redistribute copies of it under the terms of the GNU General
+Public License C<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent
+permitted by law.
+
+=head1 SEE ALSO
+
+C<virt-viewer(1)>, the project website C<http://virt-manager.org>
+
+=cut
+
diff --git a/man/virt-viewer.pod b/man/virt-viewer.pod
index ec74f33..32f62c7 100644
--- a/man/virt-viewer.pod
+++ b/man/virt-viewer.pod
@@ -97,7 +97,7 @@ Written by Daniel P. Berrange, based on the GTK-VNC example program gvncviewer.
 
 =head1 BUGS
 
-Report bugs to the mailing list C<http://www.redhat.com/mailman/listinfo/et-mgmt-tools>
+Report bugs to the mailing list C<http://www.redhat.com/mailman/listinfo/virt-tools-list>
 
 =head1 COPYRIGHT
 
diff --git a/mingw32-virt-viewer.spec.in b/mingw32-virt-viewer.spec.in
index e0f1c49..c1e7bd9 100644
--- a/mingw32-virt-viewer.spec.in
+++ b/mingw32-virt-viewer.spec.in
@@ -78,5 +78,6 @@ rm -rf $RPM_BUILD_ROOT
 %{_mingw32_datadir}/virt-viewer/ui/virt-viewer-auth.xml
 
 %{_mingw32_mandir}/man1/virt-viewer.1*
+%{_mingw32_mandir}/man1/remote-viewer.1*
 
 %changelog
diff --git a/virt-viewer.spec.in b/virt-viewer.spec.in
index 54c3ad6..9e16307 100644
--- a/virt-viewer.spec.in
+++ b/virt-viewer.spec.in
@@ -145,6 +145,7 @@ fi
 %ghost %{_libexecdir}/spice-xpi-client
 %{_libexecdir}/spice-xpi-client-remote-viewer
 %{_mandir}/man1/%{name}*
+%{_mandir}/man1/remote-viewer.1
 
 %if %{_with_plugin}
 %files plugin
-- 
1.7.7.6




More information about the virt-tools-list mailing list