diff --git a/README b/README index 7b798aea9374fdd230eaf6633729dab55db99a4b..08b0b52bb0bb210a0597382839f93c0afa09daa2 100644 --- a/README +++ b/README @@ -8,7 +8,7 @@ candidates for zero-el input methods. You can check zero-el document at https://blog.emacsos.com/zero-el.html -* To build zero-panel +* To build zero-panel from source Get [[https://mesonbuild.com][meson build tool]]. #+BEGIN_SRC sh @@ -18,7 +18,7 @@ meson setup --buildtype release release/ ninja -C release/ #+END_SRC -* To create zero-panel deb package +* To create zero-panel deb package from source rsync and [[https://github.com/jordansissel/fpm][fpm]] is required. #+BEGIN_SRC sh diff --git a/create-deb.sh b/create-deb.sh index e2dbe1b5340436c2dfc61231be66db5c525f0572..deff5ffb7f556df2fcb1c9a55dfee0f06113281e 100755 --- a/create-deb.sh +++ b/create-deb.sh @@ -23,13 +23,17 @@ mkdir -p \ "$DEST"/usr/share/dbus-1/interfaces/ \ "$DEST"/usr/share/dbus-1/services/ \ "$DEST"/usr/bin/ \ - "$DEST"/usr/share/zero-panel/ + "$DEST"/usr/share/zero-panel/ \ + "$DEST"/usr/share/man/man1/ \ + "$DEST"/usr/share/doc/zero-panel/ cp 'com.emacsos.zero.Panel1.PanelInterface.xml' "$DEST"/usr/share/dbus-1/interfaces/ cp 'com.emacsos.zero.Panel1.service' "$DEST"/usr/share/dbus-1/services/ sed -i -E 's:/home/sylecn/d/zero-panel:/usr/bin/zero-panel:' "$DEST"/usr/share/dbus-1/services/com.emacsos.zero.Panel1.service cp release/zero-panel "$DEST"/usr/bin/ rsync -air themes/ "$DEST"/usr/share/zero-panel/ +cp zero-panel.1 "$DEST"/usr/share/man/man1/ +cp README "$DEST"/usr/share/doc/zero-panel/ fpm -f -t deb -s dir -n zero-panel -v "$VERSION" \ -d libgtk-3-0 \ diff --git a/meson.build b/meson.build index 43567a3cb1e079e2bb68cea8dd6fd5bb842ca4d2..e64ee0769497066c9f55d0db408f73890d8f8f9a 100644 --- a/meson.build +++ b/meson.build @@ -1,6 +1,6 @@ # -*- mode: conf -*- project('zero-panel', 'c', - version: '1.0.1', + version: '1.1.0', license: 'EPL-2.0', default_options: [ 'warning_level=3', @@ -20,6 +20,10 @@ install_data('com.emacsos.zero.Panel1.service', install_subdir('themes', install_dir: '/usr/share/zero-panel/', strip_directory: true) +install_data('zero-panel.1', + install_dir: '/usr/share/man/man1/') +install_data('README', + install_dir: '/usr/share/doc/zero-panel/') gen_inc = include_directories('.') diff --git a/operational b/operational index a9ef1a03ddfaedf6c15bc5770bd6eb5b021151f0..eab444a997c60c0b685f27d16b403f6b88fca263 100644 --- a/operational +++ b/operational @@ -6,6 +6,18 @@ Time-stamp: <2019-09-02> * later :entry: * current :entry: ** +** 2019-09-02 support user configuration of theme and panel orientation. +is it supported by zero-el? +** 2019-09-02 should I add README in deb file? where to install it to? +/usr/share/doc/zero-panel/README + +- maybe also write a man page. + /usr/share/man/man1/zero-panel.1.gz + + example man page + /usr/share/man/man1/python3.5.1.gz + /usr/share/man/man1/ls.1.gz generated by help-to-man + ** 2019-09-02 remove black bg in round corner. should be transparent. is it because I don't have a compositor that support alpha? * done :entry: diff --git a/zero-panel.1 b/zero-panel.1 new file mode 100644 index 0000000000000000000000000000000000000000..a1696c6685f9087031e1419bce000f656d86f6aa --- /dev/null +++ b/zero-panel.1 @@ -0,0 +1,41 @@ +.TH zero-panel 1 2019-09-02 +.SH NAME +zero-panel \- show candidates for zero-el input methods +.SH SYNOPSIS +.B zero-panel +[OPTION...] +.SH DESCRIPTION +Run panel service for zero-el input methods. +zero-panel is usually started automatically via dbus named service invocation. +You don't need to run it yourself. +.PP +zero-panel support themes. +Themes are gtk3 ui and css files. +Theme can make the panel prettier. +.PP +zero-panel is a single instance daemon. +If you start zero-panel when another zero-panel process is already running, it will print a message and exit immediately. +.SH OPTIONS +.TP +.BR \-? ", " \-\-help +show help options +.TP +.BR \-h ", " \-\-horizontal +use horizontal mode. +default is vertical mode +.TP +.BR \-t ", " \-\-theme +which theme to use +.SH FILES +/usr/share/dbus-1/services/com.emacsos.zero.Panel1.service \(em zero-panel dbus service file. +.PP +/usr/share/dbus-1/interfaces/com.emacsos.zero.Panel1.PanelInterface.xml \(em dbus service interface file. +This file describes the API. +.PP +/usr/share/zero-panel/ \(em zero-panel theme dir. +Each theme should have a .ui file and optionally a .css file. +.SH BUGS +.TP +zero-panel doesn't work with GNOME 3 GNOME shell environment. +.SH AUTHOR +Yuanle Song