A fully free, highly customizable and very efficient shell wrapper for git and SSH, which imitates Dropbox
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
gnupot/man/gnupot.man

133 lines
2.7 KiB

.\"
.\" gnupot.man
.\"
.\" Copyright (C) 2015, 2016 frnmst (Franco Masotti) <franco.masotti@live.com>
.\" <franco.masotti@student.unife.it>
.\"
.\" This file is part of GNUpot.
.\"
.\" GNUpot 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 3 of the License, or
.\" (at your option) any later version.
.\"
.\" GNUpot is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with GNUpot. If not, see <http://www.gnu.org/licenses/>.
.\"
.TH GNUPOT 1 "March 2016" "0.5" "User Commands"
.SH NAME
gnupot \- Libre file syncronization witten in bash, based on git.
.SH SYNOPSIS
.B gnupot
[OPTION]
.SH DESCRIPTION
A fully free, highly customizable and very efficient shell wrapper for git
and SSH, which imitates Dropbox.
.PP
Only none or a single option is permitted. If no option is specified GNUpot
starts normally.
.TP
.B -d
.RS
Start GNUpot in debug mode. The program will behave normally but all the
execution flow will be shown on the console. This is useful to detect
and report problems to the developers.
.RE
.TP
.B -h
.RS
Show GNUpot's help.
.RE
.TP
.B -k
.RS
Quit GNUpot.
.RE
.TP
.B -n
.RS
Setup a GNUpot instance.
.RE
.TP
.B -p
.RS
Print configuration file.
.RE
.TP
.B -s
.RS
Show if GNUpot is running or not.
.RE
.TP
.B -v
.RS
Show GNUpot's version.
.RE
.TP
.B
Exit status:
.RS
0 No error,
.PP
.RE
.RS
1 Some kind of error (printed on stderr).
.RE
.SH FILES
.I ~/.config/gnupot
.RS
Directory where the configuration file and the SSH keys are stored (the
latter by default configuration).
.RE
.I ~/.config/gnupot.config
.RS
GNUpot's configuration file.
.RE
.SH AUTHOR
Written by Franco Masotti <franco.masotti@student.unife.it>
.SH REPORT BUGS
Report bugs in the issue page: <https://github.com/frnmst/gnupot/issues>
.br
or email at: <franco.masotti@student.unife.it>
.SH COPYRIGHT
Copyright © 2015, 2016 frnmst/Franco Masotti. License GPLv3+: GNU GPL
version 3 or later <http://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it. There
is NO WARRANTY, to the extent permitted by law.
.SH SEE ALSO
Full documentation (i.e. server configuration) at:
<https://github.com/frnmst/gnupot/wiki>
.PP
.BR gnupot.conf(5),
.BR bash(1),
.BR ssh(1),
.BR ssh_config(5),
.BR git(1),
.BR inotifywait(1),
.BR trickle(1),
.BR notify-send\ --help.