man: add remote-viewer man page

This commit is contained in:
Marc-André Lureau 2012-02-06 14:04:45 +00:00 committed by Daniel P. Berrange
parent d9825f3c74
commit 0cb4fe4972
5 changed files with 92 additions and 4 deletions

View File

@ -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

78
man/remote-viewer.pod Normal file
View File

@ -0,0 +1,78 @@
=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

View File

@ -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

View File

@ -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

View File

@ -128,7 +128,8 @@ rm -rf $RPM_BUILD_ROOT
%{_datadir}/%{name}/ui/virt-viewer.xml
%{_datadir}/%{name}/ui/virt-viewer-auth.xml
%{_datadir}/%{name}/ui/virt-viewer-about.xml
%{_mandir}/man1/%{name}*
%{_mandir}/man1/virt-viewer.1*
%{_mandir}/man1/remote-viewer.1*
%if %{_with_plugin}
%files plugin