.\" Manpage for hopmanrc.
.\" Contact kryn@in2p3.fr to correct errors or typos.
.TH man 8 "07 may 2019" "1.0" "hopmanrc man page"
.SH NAME
hopmanrc
Configuration file for hopman.
.SH DESCRIPTION
This is the description of hopman's configuration file. This file is searched
in user's home directory under the name .hopmanrc. If this file is not found, a
system-wide configuration file is searched at /etc/default/hopmanrc. If none is
found, built-in parameters are used.
.br
The syntax of parameter setting is "<parameter_name> = <value>", with one such
assignment per line. Lines not matching this syntax are ignored, as well as
empty lines and lines starting with the hash character '#'.
.br
Spaces at the beginning and the end of the line are optionnal and ignored,
as well as spaces around the equal sign if any. The parameter names are
case-insensitive, as well as the boolean values "True" and "False". The
command-helper scripts are passed verbatim to /bin/sh after substitution of
the conversion specifications they contain.
.br
 
.br
.ul 1
Textual parameters:
.IP - 2      
MountHelper: a shell command to mount a partition
.IP -
UmountHelper: a shell command to unmount a partition
.IP -
FileManager: a shell command to open current directory with the file-manager
.IP -
TerminalEmulator: a shell command to open current directory in a terminal
.IP -
PidFile: the path to a file in which the daemon stores its process-id
.RE
.br

.br
.ul 1
Boolean parameters:
.IP - 2
ShowName: display partitions' names
.IP -
ShowLabel: display filesystems' labels
.IP -
ShowFstype: display filesystem-types (only known when mounted)
.IP -
ShowMountPoint: display mount points
.IP -
Sticky: Show hopman's window on all desktops
.IP -
Autohide: automatically hide window when there is no hotplug partition
.IP -
ToggleHide: toggle window's visibility on signal SIGHUP. If False, then
unconditionnally show the window on SIGHUP.
.IP -
Debug: Write partitions'list on standard error path everytime it changes.
.IP -
Decorate: decorate the window with a title and buttons
.IP -
KeepPosition: If the window has been moved, remember its position and restore
it when hidden and shown again. See also InitialPosition and notes.
.RE
.br
 
.br
.ul 1
Window initial position
.IP - 2
InitialPosition: This parameter can take the form of two integer numbers in the range [0..100] indicating the horizontal and vertical positions of the window
in percentages of screen's witdh and height, or the special value "Mouse"
(case-insensitive), meaning that the whidow will pop up under the mouse.
.RE
.br
 
.br
.SH NOTES
.ul 1
Textual values:
Contextual variables can be used in textual parameter values by the mean of
two-character conversion specifications:
.IP \[bu] 2
%u and %h can be used in all strings and stand for username and home
.IP \[bu] 2
%n, %l, and %m can be used only in helper commands and stand respectively for
partition's name, filesystem's label, and mountpoint.
.RE
.br

.br
.ul 1
Boolean values:
There is no diagnostic on erroneous values; instead, all values not equal to True are considered False.
.br

.br
.ul 1
Show parameters:
If both ShowName and ShowLabel are False, one of them is displayed, label if
possible, else name.
.br

.br
.ul 1
PidFile:
All directories on the path to pidfile will be created by hopman if they don't
exist and if user has permission to do it. On exit, only the pidfile is
deleted; the directories are left.
.br

.br
.ul 1
Window placement:
If an initial window placement is defined, it is always used the first time the
window is shown. When the window is hidden and shown again, the placement then
depends on the value of KeepPosition. If KeepPosition is False, then the
initial position is used everytime the window is shown, otherwise the position
it had before being hidden is restored.
.SH FILES
/etc/default/hopmanrc, .hopmanrc
.SH SEE ALSO
hopman
.SH AUTHOR
Didier Kryn <kryn@in2p3.fr>
