essentials/dotfiles/awesome/lain/wiki/fs.md

<- widgets

Shows disk space usage for a set partition.

Displays a notification when the partition is full or has low space.

mypartition = lain.widgets.fs()

input table

Variable	Meaning	Type	Default
timeout	Refresh timeout seconds -	int	600
partition	Partition to monitor	string	"/"
notification_preset	Notification preset	table	{fg = beautiful.fg_normal}
followmouse	Display the notification on mouse screen	boolean	false
settings	User settings	function	empty function

settings can use the following partition related float values: fs_now.used, fs_now.available, fs_now.size_mb, fs_now.size_gb.

Within settings, you can obtain other partition values from internal fs_info table. For each partition, there are four index:

• fs_info[other_partition .. " used_p"]
• fs_info[other_partition .. " avail_p"]
• fs_info[other_partition .. " size_mb"]
• fs_info[other_partition .. " size_gb"]

just like the variables of fs_now. See here for an usage example.

Also, settings can modify fs_notification_preset table. This table will be the preset for the naughty notifications. Check here for the list of variables it can contain. Default definition:

fs_notification_preset = { fg = beautiful.fg_normal }

In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen when the widget is hovered with the mouse. By setting followmouse to true it will be shown on the same screen containing the widget.

output table

Variable	Meaning	Type
widget	The widget	wibox.widget.textbox
show	The notification	function

You can display the notification with a key binding like this:

awful.key({ altkey }, "h", function () mypartition.show(seconds, scr) end),

where altkey = "Mod1" and show arguments, both optional, are:

• seconds, notification time in seconds;
• screen, screen in which display the notification.

Note that naughty notification requires beautiful.font or fs_notification_preset.font to be monospaced, in order to correctly display the output.