]> git.madduck.net Git - etc/awesome.git/blobdiff - mpd.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated bat (markdown)
[etc/awesome.git] / mpd.md
diff --git a/mpd.md b/mpd.md
index 17acab893ee4c4c5f0ac981654528d4d1eff4290..2a0ba326a8d477412a074add6fb2a929e403b953 100644 (file)
--- a/mpd.md
+++ b/mpd.md
@@ -1,4 +1,6 @@
-Shows mpd status in a textbox.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
+Shows MPD status in a textbox.
 
        mympd = lain.widgets.mpd()
 
@@ -20,18 +22,20 @@ The function takes a table as optional argument, which can contain:
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
-`password` | Mpd password | string | ""
-`host` | Mpd server | string | "127.0.0.1"
-`port` | Mpd port | string | "6600"
+`password` | MPD password | string | ""
+`host` | MPD server | string | "127.0.0.1"
+`port` | MPD port | string | "6600"
 `music_dir` | Music directory | string | "~/Music"
 `refresh_timeout` | Refresh timeout seconds | int | 1
-`color_artist` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color_song` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF"
+`header` | Text before values | string | "" 
+`artist_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF"
+`song_color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF"
 `spr` | Separator text between artist and song values | string | " "
+`footer` | Text to append after values | string | "" 
 `app` | Music program to spawn on click | string | "ncmpcpp"
 `shadow` | Hide widget when there are no songs playing | boolean | false 
 
-**Note**: `spr` can be a markup text.
+**Note**: `spr` and `footer` can be markup text.
 
 `lain.widgets.mpd` outputs the following table:
 
@@ -44,24 +48,24 @@ Finally, you can control the widget with key bindings like these:
 
     -- MPD control
     awful.key({ altkey, "Control" }, "Up",
-    function ()
-        awful.util.spawn_with_shell( "mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle", false )
-        mympd.notify()
-     end),
+        function ()
+            awful.util.spawn_with_shell("mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle")
+            mpdwidget.notify()
+        end),
     awful.key({ altkey, "Control" }, "Down",
-    function ()
-        awful.util.spawn_with_shell( "mpc stop || ncmpcpp stop || ncmpc stop || pms stop", false )
-        mympd.notify()
-    end),
+        function ()
+            awful.util.spawn_with_shell("mpc stop || ncmpcpp stop || ncmpc stop || pms stop")
+            mpdwidget.notify()
+        end),
     awful.key({ altkey, "Control" }, "Left",
-    function ()
-        awful.util.spawn_with_shell( "mpc prev || ncmpcpp prev || ncmpc prev || pms prev", false )
-        mympd.notify()
-    end),
+        function ()
+            awful.util.spawn_with_shell("mpc prev || ncmpcpp prev || ncmpc prev || pms prev")
+            mpdwidget.notify()
+        end),
     awful.key({ altkey, "Control" }, "Right",
-    function ()
-        awful.util.spawn_with_shell( "mpc next || ncmpcpp next || ncmpc next || pms next", false )
-        mympd.notify()
-    end),
+        function ()
+            awful.util.spawn_with_shell("mpc next || ncmpcpp next || ncmpc next || pms next")
+            mpdwidget.notify()
+        end),
 
 where `altkey = "Mod1"`.
\ No newline at end of file