From daa455877ceaef7c3c12f9472ae7a5fd58dd57b9 Mon Sep 17 00:00:00 2001 From: Emanuele Petriglia Date: Fri, 29 Nov 2019 15:28:46 +0100 Subject: [PATCH] Add man page Signed-off-by: Emanuele Petriglia --- Makefile.in.in | 9 ++++- xfce4-panel-profiles.1 | 82 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 1 deletion(-) create mode 100644 xfce4-panel-profiles.1 diff --git a/Makefile.in.in b/Makefile.in.in index 11f80ea..26d8ae6 100644 --- a/Makefile.in.in +++ b/Makefile.in.in @@ -30,7 +30,10 @@ layouts: cd data/layouts/xubuntu-14.04; tar -cvjf "../Xubuntu 14.04 (Trusty).tar.bz2" * cd data/layouts/xubuntu-18.04; tar -cvjf "../Xubuntu 18.04 (Bionic).tar.bz2" * -install: all +xfce4-panel-profiles.1.gz : xfce4-panel-profiles.1 + gzip -c $< > $@ + +install: all xfce4-panel-profiles.1.gz install -d $(DESTDIR)/$(PREFIX)/bin install bin/$(APPNAME) $(DESTDIR)/$(PREFIX)/bin @@ -59,6 +62,9 @@ install: all cp -rf locale $(DESTDIR)/$(PREFIX)/share ln -sf $(PREFIX)/share/locale $(DESTDIR)/$(PREFIX)/share/$(APPNAME)/locale + install -d $(DESTDIR)/$(PREFIX)/share/man/man1 + install xfce4-panel-profiles.1.gz $(DESTDIR)/$(PREFIX)/share/man/man1 + uninstall: rm -f $(DESTDIR)/$(PREFIX)/share/applications/$(APPNAME).desktop rm -rf $(DESTDIR)/$(PREFIX)/share/$(APPNAME) @@ -86,3 +92,4 @@ clean: rm -f xfce4-panel-profiles.desktop rm -f Makefile.in rm -f Makefile + rm -f xfce4-panel-profiles.1.gz diff --git a/xfce4-panel-profiles.1 b/xfce4-panel-profiles.1 new file mode 100644 index 0000000..85330e0 --- /dev/null +++ b/xfce4-panel-profiles.1 @@ -0,0 +1,82 @@ +.\" Man page written by Emanuele Petriglia for xfce4-panel-profiles. +.TH XFCE4-PANEL-PROFILES "1" "November 2019" "xfce4-panel-profiles 1.0.9" "User Commands" + +.SH Name +xfce4-panel-profiles - A simple application to manage Xfce panel layouts + +.SH SYNOPSIS +.B xfce4-panel-profiles +[ +.I COMMAND +] +.I filename + +.SH DESCRIPTION +\fBxfce4-panel-profiles\fP is a simple application to manage Xfce panel layouts. +It allows you to \fIapply\fP, \fIsave\fP, \fIremove\fP, \fIexport\fP, +\fIimport\fP a panel layout as a profile. You can, as example, backup the +current panel layout, or import a previously exported panel profile. + +\fBxfce4-panel-profiles\fP is a \fIGUI application\fP, but it can be also used +via command line with limited features. + +.SH COMMANDS +.TP +\fBload\fP \fIfilename\fP +Load and apply a previously exported \fIfilename\fP panel profile. +.TP +\fBsave\fP \fIfilename\fP +Save the current panel layout as \fIfilename\fP. The profile's name should end +with \fItar.bz2\fP for clarity. + +.SH FILES +.TP +.I ~/.local/share/xfce4-panel-profiles +User's custom panel profiles storage directory. +.TP +.I /usr/share/xfce4-panel-profiles/layouts +System provided panel profiles storage directory. + +.SH EXAMPLES +.TP +.B xfce4-panel-profiles save backup.tar.bz2 +Make a backup of current panel layout. +.TP +.B xfce4-panel-profiles load backup.tar.bz2 +Load and apply the previously exported panel layout. + +.SH AUTHOR +.TP +2015-2019 +.MT bluesabre@xfce.org +Sean Davis +.ME +.TP +2013 +.MT a.j.buxton@gmail.com +Alistair Buxton +.ME + +.SH REPORTING BUGS +If you encounter a bug in \fBxfce4-panel-profiles\fP, please submit a bug report +to the +.UR https://bugzilla.xfce.org +.I Xfce Bugzilla +.UE . Please note that to do this you will need to have or create +an account on Bugzilla. + +.SH COPYING +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 3 of the License, or (at your option) any later +version. + +This program 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 +this program. If not, see +.UR http://www.gnu.org/licenses +GNU website +.UE . -- 2.21.0