From 189e63c128f61c5986294ab7ee5cf42b3e023b1f Mon Sep 17 00:00:00 2001 From: James Booth Date: Wed, 16 Mar 2016 21:41:17 +0000 Subject: [PATCH] Added doc strings with theme examples --- pid/pid.c | 10 ++++++++++ platform-info.py | 9 +++++++++ syscmd.py | 10 ++++++++++ whoami.py | 9 +++++++++ 4 files changed, 38 insertions(+) diff --git a/pid/pid.c b/pid/pid.c index 8f15996..971d5e6 100644 --- a/pid/pid.c +++ b/pid/pid.c @@ -1,3 +1,13 @@ +/* +Simple plugin to display the PID of the Profanity process and its parent + +Theme example in ~/.local/share/profanity/plugin_themes + +[pid] +self=bold_white +parent=white +*/ + #include #include #include diff --git a/platform-info.py b/platform-info.py index 62b58ab..c70ce1d 100644 --- a/platform-info.py +++ b/platform-info.py @@ -1,3 +1,12 @@ +""" +Shows platform details in the console + +Theme items in ~/.local/share/profanity/plugin_themes + +[platform] +line=cyan +""" + import prof import platform diff --git a/syscmd.py b/syscmd.py index d8db732..67727df 100644 --- a/syscmd.py +++ b/syscmd.py @@ -1,3 +1,13 @@ +""" +Allow running system commands in a plugin window, or send result to recipient + +Theme options in ~/.local/share/profanity/plugin_themes + +[system] +command=magenta +result=green +""" + import prof import subprocess diff --git a/whoami.py b/whoami.py index 1f1c3bd..452dddf 100644 --- a/whoami.py +++ b/whoami.py @@ -1,3 +1,12 @@ +""" +Calls the 'whoami' command + +Theme in ~/.local/share/profanity/plugin_themes + +[whoami] +result=bold_magenta +""" + import prof import getpass