After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 625879 - vinagre should document the format of .vnc files
vinagre should document the format of .vnc files
Status: RESOLVED OBSOLETE
Product: vinagre
Classification: Applications
Component: Documentation
3.10.x
Other Linux
: Normal enhancement
: ---
Assigned To: Maintainers of Gnome user documentation
vinagre-maint
Depends on: 627931
Blocks:
 
 
Reported: 2010-08-02 22:00 UTC by Victor Vargas
Modified: 2021-05-26 09:25 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add chapter "Format of a .vnc File" to help (1.98 KB, patch)
2010-12-28 20:16 UTC, Kenny Meyer
rejected Details | Review

Description Victor Vargas 2010-08-02 22:00:05 UTC
This report was originally filled at:
https://bugs.edge.launchpad.net/ubuntu/+source/vinagre/+bug/393351


1) the documentation and the help screen show the -f option; however, the format of the file is not described anywhere. This alone is enough to warrant documenting the format.
2) the benefit is being able to start vinagre from the command line, without having to provide the password interactively - because the password can be in the password file.


The format of a .vnc file
is similar to this:

[connection]
host=myhost.my.domian.com:2
#port=5900 --optional
#username=user --optional
password=mypwd

The help pages should document this format. Thanks -Yury
Comment 1 Jonh Wendell 2010-08-25 11:58:09 UTC
Once we have moved to Mallard format, this documentation should be done in VNC plugin.
Comment 2 Kenny Meyer 2010-12-28 20:16:06 UTC
Created attachment 177159 [details] [review]
Add chapter "Format of a .vnc File" to help

I added a chapter of the format of a .vnc file to the "Getting Started" section.

We should also add it to the man documentation.
Comment 4 David King 2011-04-17 13:16:09 UTC
RealVNC was the software that implemented the .vnc file format initially, and there is some reasonable documentation on the RealVNC website:

http://www.realvnc.com/products/free/4.1/winvncviewer.html#ColorEncoding

I think that this is administrator-specific documentation, and should only be mentioned in passing in the (user) documentation, at least until Vinagre can create .vnc files. A description of the format in the man page would be most appropriate for the moment. Bug 520828 is related to exporting server information.
Comment 5 David King 2011-04-17 13:17:55 UTC
Comment on attachment 177159 [details] [review]
Add chapter "Format of a .vnc File" to help

Vinagre has moved to Mallard help now, so this will need to be rewritten for the new syntax. Also, i think that the man page is the more appropriate place to add this information, for the moment.
Comment 6 Pete Travis 2013-01-12 21:40:57 UTC
Name        : vinagre
Version     : 3.4.2
Release     : 1.fc17

Still no documentation included on the format of this file, in the Help files or the manpage. *.vnc files are the only apparent way to start an authenticated session without going through the dialogs with each connection, so I consider it a useful feature.
Comment 7 Stéphane Gourichon 2015-02-04 11:53:34 UTC
Hello,

## Bug still open

Trying to find an alternative to xtightvncviewer that can be fed a password without typing it interactively, I tried vinagre.

Just hit that bug. vinagre package does not describe .vnc file format. help menu item send to https://wiki.gnome.org/Apps/Vinagre which does not help.

Found link to here in https://bugs.launchpad.net/ubuntu/+source/vinagre/+bug/393351 . 

## File format changed ?

Anyway I wrote a simple .vnc file using hints in this bug report.
Vinagre complained until the .vnc file looked like this:

[Connection]
Host=somehostname
Password=somesecreatpassword

Capital letters for "Connection" and "Host" were requested by an explicit error message. (Regarding "Password" there was no such request, it would just be consistent.)

## Still fail

Connections happens to fail later, but I noticed it fails the same when connecting using graphical user interface, so it's probably unrelated to this bug.

Having an short spec stating what vinagre expects in the .vnc file would be a good start to reduce guessing work.

Thank you for your attention.



## Platform/version

Ubuntu 14.04 AMD64.

LC_ALL=C apt-cache policy vinagre

vinagre:
  Installed: 3.10.2-0ubuntu1
  Candidate: 3.10.2-0ubuntu1
  Version table:
 *** 3.10.2-0ubuntu1 0
        500 http://fr.archive.ubuntu.com/ubuntu/ trusty/universe amd64 Packages
        100 /var/lib/dpkg/status
Comment 8 André Klapper 2021-05-26 09:25:46 UTC
GNOME is going to shut down bugzilla.gnome.org in favor of gitlab.gnome.org.
As part of that, we are mass-closing older open tickets in bugzilla.gnome.org
which have not seen updates for a longer time (resources are unfortunately
quite limited so not every ticket can get handled).

If you can still reproduce the situation described in this ticket in a recent
and supported software version of Vinagre, then please follow
  https://wiki.gnome.org/GettingInTouch/BugReportingGuidelines
and create a new enhancement request ticket at
  https://gitlab.gnome.org/GNOME/vinagre/-/issues/

Thank you for your understanding and your help.