summaryrefslogtreecommitdiffstats
path: root/src/remmina.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/remmina.1229
1 files changed, 229 insertions, 0 deletions
diff --git a/src/remmina.1 b/src/remmina.1
new file mode 100644
index 0000000..27fc505
--- /dev/null
+++ b/src/remmina.1
@@ -0,0 +1,229 @@
+.\" Generated by scdoc 1.11.2
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "REMMINA" "1" "2022-03-25"
+.PP
+.SH NAME
+.PP
+remmina -- Remmina the GTK+ Remote Desktop Client
+.PP
+.SH SYNOPSIS
+.PP
+remmina [-a|i|n|q|v] [-c FILE] [-e FILE] [-p TABINDEX] [-s SERVER]
+[-t PROTOCOL] [-x PLUGIN] [--update-profile]
+[--set-option OPTION[=VALUE]] [--display DISPLAY]
+.PP
+.SH DESCRIPTION
+.PP
+Remmina is a remote desktop client written in GTK+, aiming to be useful for
+system administrators and travellers, who need to work with lots of remote
+computers in front of either large monitors or tiny netbooks.\& Remmina
+supports multiple network protocols in an integrated and consistent user
+interface.\&
+.PP
+Currently RDP, VNC, SSH, SPICE, and WWW are supported.\&
+.PP
+Remmina is released in separated source packages:
+.PP
+.PD 0
+.IP \(bu 4
+"remmina", the main GTK+ application
+.IP \(bu 4
+"remmina-plugins", a set of plugins
+.PD
+.PP
+Remmina is free and open-source software, released under GNU GPL license.\&
+.PP
+.SH FILES
+.PP
+${XDG_CONFIG_DIRS}/remmina.\&pref or ${XDG_CONFIG_HOME}/remmina/remmina.\&pref :
+.PP
+Remmina configuration files.\&
+.PP
+At the first Remmina execution the system wide Remmina configuration files,
+will be copied in the ${XDG_CONFIG_HOME}
+.PP
+${XDG_DATA_DIRS}/FILE.\&remmina or ${XDG_DATA_HOME}/remmina/FILE.\&remmina :
+.PP
+Remmina profiles, the file name is autogenerated, but you can create
+manually your own files with the FILE name you prefer.\& It'\&s possible to
+specify a custom profile name and location.\&
+.PP
+.SH OPTIONS
+.PP
+\fB-h, --help\fR
+.RS 4
+Show help options
+.PP
+.RE
+\fB-a\fR
+.RS 4
+Show about dialog
+.PP
+.RE
+\fB-c, --connect=FILE\fR
+.RS 4
+Connect directly either to a desktop using options described in a file,
+or a supported URI (RDP, VNC, SSH or SPICE).\&
+.br
+The filetype can be ".\&remmina" or one supported by a plugin capable of
+importing files
+.PP
+.RE
+\fB-e, --edit=FILE\fR
+.RS 4
+Open and edit desktop connection using options described by file,
+file type can be either .\&remmina or one supported by a file
+import capable plugin
+.PP
+.RE
+\fB-k, --kiosk\fR
+.RS 4
+Start Remmina in kiosk mode (thin client)
+.PP
+.RE
+\fB-n, --new\fR
+.RS 4
+Create a new connection profile
+.PP
+.RE
+\fB-p, --pref=TABINDEX\fR
+.RS 4
+Show preferences dialog page
+.PP
+.RE
+\fB-x, --plugin=PLUGIN\fR
+.RS 4
+Execute the plugin
+.PP
+.RE
+\fB-q, --quit\fR
+.RS 4
+Quit the application
+.PP
+.RE
+\fB-s, --server=SERVER\fR
+.RS 4
+Use default server name (for \fB--new\fR)
+.PP
+.RE
+\fB-t, --protocol=PROTOCOL\fR
+.RS 4
+Use default protocol (for \fB--new\fR)
+.PP
+.RE
+\fB-i, --icon\fR
+.RS 4
+Start as tray icon
+.PP
+.RE
+\fB-v, --version\fR
+.RS 4
+Show the application'\&s version
+.PP
+.RE
+\fB--update-profile\fR
+.RS 4
+Modify connection profile, require also \fB--set-option\fR
+.PP
+.RE
+\fB--set-option OPTION[=VALUE]\fR
+.RS 4
+Set one or more profile settings, to be used with \fB--update-pro-file\fR
+.PP
+.RE
+\fB--encrypt-password\fR
+.RS 4
+Encrypt a password
+.PP
+.RE
+\fB--display=DISPLAY\fR
+.RS 4
+X display to use
+.PP
+.RE
+\fB--disable-toolbar\fR
+.RS 4
+Disable toolbar
+.PP
+.RE
+\fB--enable-fullscreen\fR
+.RS 4
+Enable fullscreen
+.PP
+.RE
+\fB--enable-extra-hardening\fR
+.RS 4
+Enable extra hardening (disable closing confirmation, disable unsafe shortcut keys, hide tabs, hide search bar)
+.br
+List of disabled shortcut keys:
+.br
+fullscreen, autofit, prevtab and nexttab, scale, grab, minimize, viewonly, screenshot, disconnect, toolbar
+.PP
+.RE
+\fB--no-tray-icon\fR
+.RS 4
+Disable tray icon
+.PP
+.RE
+.SH EXAMPLES
+.PP
+To connect using an exisitng connection profile use:
+\fBremmina -c FILE.\&remmina\fR
+.PP
+To quick connect using a URI:
+.PP
+remmina -c rdp://username@server
+.br
+remmina -c rdp://domain\\\\username@server
+.br
+remmina -c vnc://username@server
+.br
+remmina -c vnc://server?\&VncUsername=username
+.br
+remmina -c ssh://user@server
+.br
+remmina -c spice://server
+.PP
+To quick connect using a URI along with an encrypted password:
+.PP
+remmina -c rdp://username:encrypted-password@server
+.br
+remmina -c vnc://username:encrypted-password@server
+.br
+remmina -c vnc://server?\&VncUsername=username\\&VncPassword=encrypted-password
+.PP
+To encrypt a password for use with a URI:
+.PP
+remmina --encrypt-password
+.PP
+To update username and password and set a different resolution mode of a
+remmina connection profile use:
+.PP
+echo "ausernamenapassword" | remmina --update-profile /PATH/TO/FOO.\&remmina --set-option username --set-option resolution_mode=2 --set-option password
+.PP
+.SH SEE ALSO
+.PP
+remmina-file-wrapper(1)
+.PP
+.SH AUTHORS
+.PP
+Antenore Gatta <antenore at simbiosi dot org> and
+Giovanni Panozzo <giovanni at panozzo dot it>
+.PP
+See the THANKS file for a more detailed list.\&
+.PP
+Remmina was initially written by Vic Lee <llyzs@163.\&com>
+.PP
+This manual page was written by Antenore Gatta <antenore at simbiosi dot org>.\&
+.PP
+.SH COPYRIGHT
+.PP
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2, or (at your option) any later
+version.\&