From a29ac8b14c100c17e5f14d9b5bb2fdc815d2300f Mon Sep 17 00:00:00 2001 From: Moritz Luedecke Date: Sat, 23 Sep 2017 15:21:37 +0200 Subject: Rename README to README.md --- README | 65 --------------------------------------------------------------- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 65 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 9f6aea3..0000000 --- a/README +++ /dev/null @@ -1,65 +0,0 @@ -pinentry-dmenu -============== - -pinentry-dmenu is a pinentry program with the charm of [dmenu](https://tools.suckless.org/dmenu). - -This program is a fork from [spine](https://gitgud.io/zavok/spine.git) which is also a fork from [dmenu](https://tools.suckless.org/dmenu). - - -Requirements ------------- -In order to build dmenu you need the Xlib header files. - - -Installation ------------- -Edit config.mk to match your local setup (dmenu is installed into the /usr/local namespace by default). - -Afterwards enter the following command to build and install dmenu -(if necessary as root): - - make clean install - - -Config ------- -To use pinentry-dmenu add in `~/.gnupg/gpg-agent.conf`: - - pinentry-program - -The config is located in `~/.gnupg/pinentry-dmenu.conf`. - -^ Parameter ^ Default ^ Description ^ -| ------------------- | ----------------- | ----------- | -| asterisk | * | Defines the symbol which is showed for each typed character | -| buttom | false | pinentry-dmenu appears at the bottom of the screen | -| min_password_length | 32 | The minimal space of the password field. This value has affect to the description field after the password field | -| monitor | -1 | pinentry-dmenu is displayed on the monitor number supplied. Monitor numbers are starting from 0 | -| prompt | "" | Defines the prompt to be displayed to the left of the input field | -| font | monospace:size=10 | Defines the font or font set used | -| prompt_bg | #bbbbbb | Defines the prompt background color | -| prompt_fg | #222222 | Defines the prompt foreground color | -| normal_bg | #bbbbbb | Defines the normal background color | -| normal_fg | #222222 | Defines the normal foreground color | -| select_bg | #eeeeee | Defines the selected background color | -| select_fg | #005577 | Defines the selected foreground color | -| desc_bg | #bbbbbb | Defines the description background color | -| desc_fg | #222222 | Defines the description foreground color | -| embedded | false | Embed into window | - - -Example -------- -``` -asterisk= "# "; -prompt = "$"; -font = "Noto Sans UI:size=13"; -prompt_fg = "#eeeeee"; -prompt_bg = "#d9904a"; -normal_fg = "#ffffff"; -normal_bg = "#000000"; -select_fg = "#eeeeee"; -select_bg = "#d9904a"; -desc_fg = "#eeeeee"; -desc_bg = "#d9904a"; -``` diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f6aea3 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +pinentry-dmenu +============== + +pinentry-dmenu is a pinentry program with the charm of [dmenu](https://tools.suckless.org/dmenu). + +This program is a fork from [spine](https://gitgud.io/zavok/spine.git) which is also a fork from [dmenu](https://tools.suckless.org/dmenu). + + +Requirements +------------ +In order to build dmenu you need the Xlib header files. + + +Installation +------------ +Edit config.mk to match your local setup (dmenu is installed into the /usr/local namespace by default). + +Afterwards enter the following command to build and install dmenu +(if necessary as root): + + make clean install + + +Config +------ +To use pinentry-dmenu add in `~/.gnupg/gpg-agent.conf`: + + pinentry-program + +The config is located in `~/.gnupg/pinentry-dmenu.conf`. + +^ Parameter ^ Default ^ Description ^ +| ------------------- | ----------------- | ----------- | +| asterisk | * | Defines the symbol which is showed for each typed character | +| buttom | false | pinentry-dmenu appears at the bottom of the screen | +| min_password_length | 32 | The minimal space of the password field. This value has affect to the description field after the password field | +| monitor | -1 | pinentry-dmenu is displayed on the monitor number supplied. Monitor numbers are starting from 0 | +| prompt | "" | Defines the prompt to be displayed to the left of the input field | +| font | monospace:size=10 | Defines the font or font set used | +| prompt_bg | #bbbbbb | Defines the prompt background color | +| prompt_fg | #222222 | Defines the prompt foreground color | +| normal_bg | #bbbbbb | Defines the normal background color | +| normal_fg | #222222 | Defines the normal foreground color | +| select_bg | #eeeeee | Defines the selected background color | +| select_fg | #005577 | Defines the selected foreground color | +| desc_bg | #bbbbbb | Defines the description background color | +| desc_fg | #222222 | Defines the description foreground color | +| embedded | false | Embed into window | + + +Example +------- +``` +asterisk= "# "; +prompt = "$"; +font = "Noto Sans UI:size=13"; +prompt_fg = "#eeeeee"; +prompt_bg = "#d9904a"; +normal_fg = "#ffffff"; +normal_bg = "#000000"; +select_fg = "#eeeeee"; +select_bg = "#d9904a"; +desc_fg = "#eeeeee"; +desc_bg = "#d9904a"; +``` -- cgit v1.2.3