This repository has been archived on 2024-01-22. You can view files and clone it, but cannot push or open issues or pull requests.
speedie-page/projects/spmenu.php
2023-04-19 13:04:03 +02:00

95 lines
5.8 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<?php include '../php/projects_header.php';?>
<title>spmenu</title>
<meta charset="UTF-8">
<meta name="description" content="speedie's fork of suckless dmenu.">
<meta name="author" content="speedie">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="speedwm.css">
<title>Welcome to speedie.site</title>
</head>
<body>
<div class="content">
<img src="preview2.png" alt="spmenu screenshot" width="75%">
<h2 id="what-is-spmenu">What is spmenu?</h2>
<p>spmenu is an X11 menu application based on <a href="https://tools.suckless.org/dmenu">dmenu</a> which takes standard input, parses it, and lets the user choose an option and sends the selected option to standard output.</p>
<p>In addition to this, it also serves as a run launcher through the included shell script <code>spmenu_run</code>. Alternatively you may use <code>spmenu_desktop</code> which lists .desktop entries instead of $PATH.</p>
<p>It is designed to integrate well with my <a href="https://dwm.suckless.org">dwm</a> fork, <a href="https://git.speedie.site/speedwm">speedwm</a>.</p>
<h3 id="special-features">Special features</h3>
<p>This build of spmenu has some features written for this build. Of course if you want, this is free software so you can use it in your own build.</p>
<ul>
<li>Proper configuration file support</li>
<li>dwm-like key/mouse bind array (See keybinds.h and mouse.h)</li>
<li>Vim-like modes, including indicator.</li>
<li>The ability to move around items with keybinds.</li>
<li>Customizable/dynamic line/column size.</li>
<li>IME support
<ul><li>Was removed from suckless dmenu years ago due to issues Ive resolved</li></ul></li>
<li>Powerlines</li>
<li>Web browser like keybindings.</li>
<li>256 color support through SGR codes.</li>
<li>Image support
<ul><li>Somewhat based on <a href="https://github.com/Cloudef/dmenu-pango-imlib">this repository</a></li></ul>
<li>Option to block typing.</li>
<li>Rewritten arguments, old arguments still work though.</li>
<li>Hiding each part of the menu.</li>
</ul>
<p>..and more!</p>
<h3 id="other-features">Other features</h3>
<ul>
<li>Pango markup support</li>
<li>Alpha transparency</li>
<li>Pywal/.Xresources support</li>
<li>Grid</li>
<li>Colored Emoji/Font support</li>
<li>Highlighting</li>
<li>Right-to-left language support</li>
<li>Case-insensitive by default</li>
<li>Padding; useful with patched dwm with barpadding or speedwm.</li>
<li>Fuzzy-finding</li>
<li>Preselect support</li>
<li>Line-height</li>
<li>History support</li>
<li>Customizable bar height</li>
</ul>
<h3 id="dependencies">Dependencies</h3>
<ul>
<li>libX11</li>
<li>libXrender</li>
<li>freetype</li>
<li>libXinerama
<ul>
<li>Can be disabled if you dont want/need multi-monitor support.</li>
</ul></li>
<li>tcc compiler (you can swap it out for GCC by passing CC=“gcc” to the <code>make</code> command if you want)</li>
<li>Pango (for drawing fonts)
<ul>
<li>Can be disabled if you don't need this.</li>
</ul></li>
</ul>
<h3 id="installation-most-gnulinux-distributions">Installation (most GNU/Linux distributions)</h3>
<p><code>emerge dev-vcs/git # Install dev-vcs/git using your favorite package manager</code></p>
<p><code>git clone https://git.speedie.site/spmenu</code></p>
<p><code>cd spmenu/</code></p>
<p><code>make clean install # Run as root.</code></p>
<h3 id="installation-gentoo">Installation (Gentoo)</h3>
<p>If you are on Gentoo GNU/Linux, you can add <a href="overlay.php">my overlay</a> which includes <code>x11-misc/spmenu</code> as well as other useful packages.</p>
<h3 id="installation-arch">Installation (Arch)</h3>
<p>If you are on Arch GNU/Linux, you can add <a href="repository.php">my repository</a> which includes <code>x11-misc/spmenu</code> as well as other useful packages.</p>
<h3 id="xresources-values">.Xresources values</h3>
<p>This build allows you to define .Xresources values to load on
startup. See docs/example.Xresources for a list of default values.</p>
<h3 id="scripts">Scripts</h3>
<p>This build of spmenu should work with all spmenu scripts. <a href="https://git.speedie.site/speedwm-extras">Here</a> are a few Ive written/use.</p>
<h3 id="notes-for-gcc-users">Notes for GCC users</h3>
<p>If youre compiling with GCC, chances are youre seeing a lot of warnings. This is because were compiling with -Ofast. I cant seem to find any issues with using -Ofast but if it bothers you, you can compile with -Os or -O2 which dont spit out these warnings.</p>
</div>
</body>
<footer>
<?php include '../php/footer.php';?>
</footer>
</html>