'\" -*- coding: utf-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH x2gomountdirs 8 "Nov 2018" "Version 4.1.0.3" "X2Go Server Tool"
.SH NAME
x2gomountdirs \- Share Client-Side Folder with X2Go Session
.SH SYNOPSIS
'nh
.fi
.ad l
x2gomountdirs <mount_type> <session_id> <username> <key_file> <dir1> [<dir2> [<dir3> [...]]]

.SH DESCRIPTION
\fBx2gomountdirs\fR mounts client\-side folders or devices onto mountpoints that are accessible
from within your remote X2Go session.
.PP
\fBx2gomountdirs\fR is run with X2Go user privileges and normally issued by an X2Go client application.
.SH ARGUMENTS
.TP
\*(T<\fB\<mount_type>\fR\*(T>
If the mount type is set to ,,dir'' then the client-side mount target is interpreted as a folder. If other,
it is interpreted as a device.
.TP
\*(T<\fB\<session_id>\fR\*(T>
The <session_id> is the unique identifier of the X2Go session that this command is run for.
.TP
\*(T<\fB\<username>\fR\*(T>
The owner of session <session_id> is given as the <username> argument.
.TP
\*(T<\fB\<key_file>\fR\*(T>
Location of a temporary private SSH key file (only valid for this command execution).
.TP
\*(T<\fB\<dir1> [<dir2> [<dir3> [...]]]\fR\*(T>
A list of client-side folders or device mount points that shall be mounted for X2Go session <session_id>.
.PP
.SH PERMISSIONS
X2Go uses the fuse-based SSH filesystem (SSHFS) for sharing client\-side file resources with X2Go sessions.
Users that shall use X2Go folder sharing must be members of the X2Go server's ,,fuse'' POSIX group.
.SH RETURN VALUES
\fBx2gomountdirs\fR returns some mount point information to stdout if the mounting process has been successful.
The mount results are printed line\-by\-line. The individual lines must be interpreted as shown below:

    line 01: dirs:<local_path>__REVERSESSH_PORT__<sshfs_port>
    line 02: ssh port:<sshfs_port>
    line 03: Host:<client_ip>
    line 04: User:<user>
    line 05: inserted, sshfs  \-o <options> \\
                "<user">@<client_ip>:"<local_path>" \\
                "<server_path>" \-p <sshfs_port>
    line 06: mount <local_path> ok
    line 07: fname: <desktop_icon_name>
.PP
If mounting of a client folder fails, either of the errors is returned (on stdout):

    error 01: mounting of <local_path> failed
    error 02: insertion of <local_path> failed (already mounted?), not mounting
.PP
As exitcode \fBx2gomoundirs\fR always returns 0.
.SH SEE ALSO
x2goumount-session(8)
.SH AUTHOR
This manual has been written by Mike Gabriel <mike.gabriel@das-netzwerkteam.de> for the X2Go project
(https://www.x2go.org).