From 898b5e26f8c9b48c01bfd4e5c3d34a7b81cebe3f Mon Sep 17 00:00:00 2001 From: speedie Date: Wed, 19 Jul 2023 04:54:37 +0200 Subject: [PATCH] Add/change some articles --- articles/Download spmenu.md | 57 +++++++++++++++++++ articles/Getting Started.md | 2 +- articles/Goals.md | 29 ++++++++++ articles/Home.md | 12 +++- ...mpiling spmenu.md => Installing spmenu.md} | 2 +- 5 files changed, 97 insertions(+), 5 deletions(-) create mode 100644 articles/Download spmenu.md create mode 100644 articles/Goals.md rename articles/{Compiling spmenu.md => Installing spmenu.md} (99%) diff --git a/articles/Download spmenu.md b/articles/Download spmenu.md new file mode 100644 index 0000000..524cef9 --- /dev/null +++ b/articles/Download spmenu.md @@ -0,0 +1,57 @@ +# Download spmenu + +The latest release of spmenu can be had from my [releases](https://ls.speedie.site/?b=releases%2Fspmenu) +page. Select the latest version (which is at the bottom). You can also get the +latest release [here](https://git.speedie.site/speedie/spmenu/releases/latest) +if you prefer. + +You can also get spmenu + +I provide the following with each release. Older releases may be missing some +of these: + +- Source code tarball (spmenu-VERSION.tar.gz) +- Source code tarball PGP signature (spmenu-VERSION.tar.gz.sig) +- Source code tarball MD5 hash (spmenu-VERSION.tar.gz.md5) +- Source code tarball SHA256 hash (spmenu-VERSION.tar.gz.sha256) +- Arch Linux PKGBUILD (spmenu-VERSION.PKGBUILD) +- Arch Linux prebuilt package (spmenu-VERSION-1-x86_64.pkg.tar.zst) +- Arch Linux prebuilt package PGP signature (spmenu-VERSION-1-x86_64.pkg.tar.zst.sig) +- Arch Linux prebuilt package MD5 hash (spmenu-VERSION-1-x86_64.pkg.tar.zst.md5) +- Arch Linux prebuilt package SHA256 hash (spmenu-VERSION-1-x86_64.pkg.tar.zst.sha256) + +See [[Installing spmenu]] for instructions on installing spmenu. + +## Verifying using PGP + +To verify a file using PGP, you need to make sure you have GPG installed. Then +you can import my public key into your keyring. Do this using: `gpg --recv-keys CEB863B830D1318A`. +If you don't want to use a keyserver, you can get my key [here](https://ls.speedie.site/pubkey.asc). + +Now you can verify it using: `gpg --verify FILE FILE.sig`. For example, to +verify `spmenu-3.0.2.tar.gz`, run the following: `gpg --verify spmenu-3.0.2 +.tar.gz.sig spmenu-3.0.2.tar.gz`. The output should be something like the +following: + +```Shell +gpg: Signature made Wed 19 Jul 2023 03:50:52 AM CEST +gpg: using RSA key AE46FBEA635C56F2B212D036CEB863B830D1318A +gpg: Good signature from "speedie (key) " [ultimate] +``` + +If you do not get a good signature, you should **not** install spmenu using the +tarball/package, you should consider it compromised. + +## Verifying using SHA256 + +To verify the SHA256 hash, run `sha256sum FILE` where `FILE` is the file you want +to check. You should end up with a 64 character (256 bit) string of characters. +Make sure this string is **identical** to the contents of `FILE.sha256`. + +## Verifying using MD5 + +NOTE: It is recommended that you verify using PGP and/or SHA256 instead. + +To verify the MD5 hash, run `md5sum FILE` where `FILE` is the file you want +to check. You should end up with a 32 character (128 bit) string of characters. +Make sure this string is **identical** to the contents of `FILE.md5`. diff --git a/articles/Getting Started.md b/articles/Getting Started.md index a1bb828..8c1e094 100755 --- a/articles/Getting Started.md +++ b/articles/Getting Started.md @@ -14,7 +14,7 @@ It also serves as a dmenu replacement for Wayland users. ## Installing spmenu -For up-to-date compilation instructions for spmenu, see [[Compiling spmenu]] or +For up-to-date compilation instructions for spmenu, see [[Installing spmenu]] or your bundled README.md. ## Using spmenu as a run launcher diff --git a/articles/Goals.md b/articles/Goals.md new file mode 100644 index 0000000..0093df2 --- /dev/null +++ b/articles/Goals.md @@ -0,0 +1,29 @@ +# Goals + +These are the goals that spmenu should achieve. + +- Read from file and standard input + - spmenu should read list items from standard input, or really any file you + can imagine. +- dmenu compatible + - spmenu should be compatible with all existing dmenu scripts. Maybe not + rofi, even if it does have some features in common. +- Customizable + - spmenu should be customizable, when considered feasible through a libconfig + configuration file read on startup. +- Sort of minimal + - While spmenu is significantly more bloated than dmenu, it should still + be a simple program. It currently sits at ~8000 SLOC. To keep it simple + a toolkit like GTK or QT should not be used. Cairo and Pango are used to + draw fonts and shapes for both X and Wayland. +- Good run launcher + - spmenu should provide a useful $PATH run launcher, along with a .desktop + entry run launcher. It should do this in the form of an external shell script, + because "do one thing and do it well" +- X and Wayland support + - spmenu should support both X11 and Wayland natively. It should support + wlroots-based compositors, but not necessarily GNOME or non-wlroots + compositors. +- No arbitrary SLOC limitation + - suckless philosophy works well in many cases, but spmenu does not attempt +to follow the suckless philosophy. diff --git a/articles/Home.md b/articles/Home.md index 4e04e3b..bf3b7ce 100755 --- a/articles/Home.md +++ b/articles/Home.md @@ -1,6 +1,6 @@ ![preview image](/articles/images/banner.png) -# Welcome to the spmenu wiki +# spmenu spmenu is an X11 and Wayland menu application which takes standard input, parses it, lets the user choose an option and sends the selected option to standard output. @@ -9,17 +9,23 @@ It also serves as a run launcher and desktop launcher through the included shell script `spmenu_run`, which handles both $PATH listing, .desktop entries, and file listing. -If you're new to spmenu, check out [[Getting Started]]. +If you're new to spmenu, we recommend that you check out [[Getting Started]]. To contribute to the wiki, please submit issues/pull requests at [the Git repository](https://git.speedie.site/speedie/spmenu-wiki). See [[Contributing to the wiki]] for more information. +Links: + +- [[Download spmenu]] - Download spmenu +- [[Getting Started]] - Learn how to set up and use spmenu + See also: - [spmenu Git repository](https://git.speedie.site/speedie/spmenu) - [spmenu releases](https://ls.speedie.site/?b=releases%2Fspmenu) +- [[Goals]] - [[User scripts]] - [[User themes]] - [[Using spmenu as a run launcher]] -- spmenu(1) and spmenu_run(1) +- spmenu(1) and spmenu_run(1) man pages diff --git a/articles/Compiling spmenu.md b/articles/Installing spmenu.md similarity index 99% rename from articles/Compiling spmenu.md rename to articles/Installing spmenu.md index bbff29b..cc9e33b 100644 --- a/articles/Compiling spmenu.md +++ b/articles/Installing spmenu.md @@ -1,4 +1,4 @@ -# Compiling spmenu +# Installing spmenu This article goes through compiling spmenu from source code.