Merge branch 'doc/hardening' into 'master'

Manual page refactoring fixes #2056

Closes #2056

See merge request Remmina/Remmina!2393

2 files changed, 365 insertions, 111 deletions

diff --git a/src/remmina.1 b/src/remmina.1
index 9c7fe3904..e479c1de0 100644
--- a/src/remmina.1
+++ b/src/remmina.1
@@ -1,141 +1,229 @@
-.Dd 2018-08-01
-.Dt REMMINA 1
-.Sh NAME
-.Nm remmina
-.Nd Remmina the GTK+ Remote Desktop Client
-.Sh SYNOPSIS
-.Nm
-.Op Fl a|i|n|q|v
-.Op Fl c Ar FILE
-.Op Fl e Ar FILE
-.Op Fl p Ar TABINDEX
-.Op Fl s Ar SERVER
-.Op Fl t Ar PROTOCOL
-.Op Fl x Ar PLUGIN
-.Op Fl -update-profile
-.Op Fl -set-option Ar OPTION[=VALUE]
-.Op Fl -display Ar DISPLAY
-.Sh DESCRIPTION
-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.
-Currently RDP, VNC, SSH, SPICE, and WWW are supported.
-.Lp
+.\" 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:
-.Lp
-    "remmina", the main GTK+ application
-    "remmina-plugins", a set of plugins
-.Lp
-Remmina is free and open-source software, released under GNU GPL license.
-.Sh FILES
-\(Do\(lCXDG_CONFIG_DIRS\(rC/remmina.pref or \(Do\(lCXDG_CONFIG_HOME\(rC/remmina/remmina.pref :
-.Lp
-Remmina configuration files.
-.Lp
+.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 \(Do\(lCXDG_CONFIG_HOME\(rC
-.Lp
-\(Do\(lCXDG_DATA_DIRS\(rC/FILE.remmina or \(Do\(lCXDG_DATA_HOME\(rC/remmina/FILE.remmina :
-.Lp
-Remmina profiles, the file name is autogenerated, but you can create manually your
-own files with the \fBFILE\fR name you prefer. It's possible to specify a custom profile name and location.
-.Sh OPTIONS
-.Bl -tag -width Ds
-.It Fl h, -help
+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
-.It Fl a
+.PP
+.RE
+\fB-a\fR
+.RS 4
 Show about dialog
-.It Fl c, -connect\fR=\fIFILE\fR
-Connect directly either to a desktop using options described in a file, or a supported URI (RDP, VNC, SSH or SPICE). The filetype can be ".remmina" or one supported by a plugin capable of importing files
-.It Fl e, -edit\fR=\fIFILE\fR
-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
-.It Fl k, -kiosk\fR
+.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)
-.It Fl n, -new\fR
+.PP
+.RE
+\fB-n, --new\fR
+.RS 4
 Create a new connection profile
-.It Fl p, -pref\fR=\fITABINDEX\fR
+.PP
+.RE
+\fB-p, --pref=TABINDEX\fR
+.RS 4
 Show preferences dialog page
-.It Fl x, -plugin\fR=\fIPLUGIN\fR
+.PP
+.RE
+\fB-x, --plugin=PLUGIN\fR
+.RS 4
 Execute the plugin
-.It Fl q, -quit\fR
+.PP
+.RE
+\fB-q, --quit\fR
+.RS 4
 Quit the application
-.It Fl s, -server\fR=\fISERVER\fR
-Use default server name (for \fB\-\-new\fR)
-.It Fl t, -protocol\fR=\fIPROTOCOL\fR
-Use default protocol (for \fB\-\-new\fR)
-.It Fl i, -icon\fR
+.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
-.It Fl v, -version\fR
-Show the application's version
-.It --update-profile\fR
-Modify connection profile, require also \-\-set\-option
-.It --set-option \fIOPTION[=VALUE]\fR
-Set one or more profile settings, to be used with \-\-update\-profile
-.It --encrypt-password\fR
+.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
-.It --display\fR=\fIDISPLAY\fR
+.PP
+.RE
+\fB--display=DISPLAY\fR
+.RS 4
 X display to use
-.It --disable-news\fR
+.PP
+.RE
+\fB--disable-news\fR
+.RS 4
 Disable news notification
-.It --disable-toolbar\fR
+.PP
+.RE
+\fB--disable-toolbar\fR
+.RS 4
 Disable toolbar
-.It --enable-fullscreen\fR
+.PP
+.RE
+\fB--enable-fullscreen\fR
+.RS 4
 Enable fullscreen
-.It --enable-extra-hardening\fR
+.PP
+.RE
+\fB--enable-extra-hardening\fR
+.RS 4
 Enable extra hardening (disable closing confirmation, disable unsafe shortcut keys, hide tabs, hide search bar)
-.El
-.Sh EXAMPLES
-.Lp
-To connect using an exisitng connection profile use:
-.RS
-.nf
-\fBremmina -c FILE.remmina\fP
-.fi
+.br
+List of disabled shortcut keys:
+.br
+fullscreen, autofit, prevtab and nexttab, scale, grab, minimize, viewonly, screenshot, disconnect, toolbar
+.PP
 .RE
-.Lp
+.SH EXAMPLES
+.PP
+To connect using an exisitng connection profile use:
+\fBremmina -c FILE.\&remmina\fR
+.PP
 To quick connect using a URI:
-.RS
-.nf
+.PP
 remmina -c rdp://username@server
+.br
 remmina -c rdp://domain\\\\username@server
+.br
 remmina -c vnc://username@server
-remmina -c vnc://server?VncUsername=username
+.br
+remmina -c vnc://server?\&VncUsername=username
+.br
 remmina -c ssh://user@server
+.br
 remmina -c spice://server
-.Lp
+.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
-remmina -c vnc://server?VncUsername=username\\&VncPassword=encrypted-password
-.Lp
+.br
+remmina -c vnc://server?\&VncUsername=username\\&VncPassword=encrypted-password
+.PP
 To encrypt a password for use with a URI:
+.PP
 remmina --encrypt-password
-.Lp
-.fi
-.RE
-.Lp
-To update username and password and set a different resolution mode of a remmina connection profile use:
-.RS
-.nf
-\fBecho "ausername\\napassword" | remmina --update-profile /PATH/TO/FOO.remmina --set-option username --set-option resolution_mode=2 --set-option password\fP
-.fi
-.RS
-.Lp
-.Lp
-.Sh SEE ALSO
-.Xr remmina-file-wrapper 1
-.Sh AUTHORS
-Antenore Gatta <antenore at simbiosi dot org> and Giovanni Panozzo <giovanni at panozzo dot it>
-.Lp
-See the THANKS file for a more detailed list.
-.Lp
-Remmina was initially written by Vic Lee <llyzs@163.com>
-.Lp
-This manual page was written by Antenore Gatta <antenore at simbiosi dot org>.
-.Lp
-.Sh COPYRIGHT
+.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.
+Free Software Foundation; either version 2, or (at your option) any later
+version.\&
diff --git a/src/remmina.scd b/src/remmina.scd
new file mode 100644
index 000000000..dca5704ee
--- /dev/null
+++ b/src/remmina.scd
@@ -0,0 +1,166 @@
+REMMINA(1)
+
+# NAME
+
+remmina -- Remmina the GTK+ Remote Desktop Client
+
+# SYNOPSIS
+
+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]
+
+# DESCRIPTION
+
+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.
+
+Currently RDP, VNC, SSH, SPICE, and WWW are supported.
+
+Remmina is released in separated source packages:
+
+- "remmina", the main GTK+ application
+- "remmina-plugins", a set of plugins
+
+Remmina is free and open-source software, released under GNU GPL license.
+
+# FILES
+
+${XDG_CONFIG_DIRS}/remmina.pref or ${XDG_CONFIG_HOME}/remmina/remmina.pref :
+
+Remmina configuration files.
+
+At the first Remmina execution the system wide Remmina configuration files,
+will be copied in the ${XDG_CONFIG_HOME}
+
+${XDG_DATA_DIRS}/FILE.remmina or ${XDG_DATA_HOME}/remmina/FILE.remmina :
+
+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.
+
+# OPTIONS
+
+*-h, --help*
+	Show help options
+
+*-a*
+	Show about dialog
+
+*-c, --connect=FILE*
+	Connect directly either to a desktop using options described in a file,
+	or a supported URI (RDP, VNC, SSH or SPICE).++
+The filetype can be ".remmina" or one supported by a plugin capable of
+	importing files
+
+*-e, --edit=FILE*
+	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
+
+*-k, --kiosk*
+	Start Remmina in kiosk mode (thin client)
+
+*-n, --new*
+	Create a new connection profile
+
+*-p, --pref=TABINDEX*
+	Show preferences dialog page
+
+*-x, --plugin=PLUGIN*
+	Execute the plugin
+
+*-q, --quit*
+	Quit the application
+
+*-s, --server=SERVER*
+	Use default server name (for *--new*)
+
+*-t, --protocol=PROTOCOL*
+	Use default protocol (for *--new*)
+
+*-i, --icon*
+	Start as tray icon
+
+*-v, --version*
+	Show the application's version
+
+*--update-profile*
+	Modify connection profile, require also *--set-option*
+
+*--set-option OPTION[=VALUE]*
+	Set one or more profile settings, to be used with *--update-pro-file*
+
+*--encrypt-password*
+	Encrypt a password
+
+*--display=DISPLAY*
+	X display to use
+
+*--disable-news*
+	Disable news notification
+
+*--disable-toolbar*
+	Disable toolbar
+
+*--enable-fullscreen*
+	Enable fullscreen
+
+*--enable-extra-hardening*
+	Enable extra hardening (disable closing confirmation, disable unsafe shortcut keys, hide tabs, hide search bar)++
+List of disabled shortcut keys:++
+fullscreen, autofit, prevtab and nexttab, scale, grab, minimize, viewonly, screenshot, disconnect, toolbar
+
+# EXAMPLES
+
+To connect using an exisitng connection profile use:
+*remmina -c FILE.remmina*
+
+To quick connect using a URI:
+
+remmina -c rdp://username@server++
+remmina -c rdp://domain\\\\username@server++
+remmina -c vnc://username@server++
+remmina -c vnc://server?VncUsername=username++
+remmina -c ssh://user@server++
+remmina -c spice://server
+
+To quick connect using a URI along with an encrypted password:
+
+remmina -c rdp://username:encrypted-password@server++
+remmina -c vnc://username:encrypted-password@server++
+remmina -c vnc://server?VncUsername=username\\&VncPassword=encrypted-password
+
+To encrypt a password for use with a URI:
+
+remmina --encrypt-password
+
+To update username and password and set a different resolution mode of a
+remmina connection profile use:
+
+echo "ausername\napassword" | remmina --update-profile /PATH/TO/FOO.remmina --set-option username --set-option resolution_mode=2 --set-option password
+
+# SEE ALSO
+
+remmina-file-wrapper(1)
+
+# AUTHORS
+
+Antenore Gatta <antenore at simbiosi dot org> and
+Giovanni Panozzo <giovanni at panozzo dot it>
+
+See the THANKS file for a more detailed list.
+
+Remmina was initially written by Vic Lee <llyzs@163.com>
+
+This manual page was written by Antenore Gatta <antenore at simbiosi dot org>.
+
+# COPYRIGHT
+
+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.