Snoooopy/dtos-dotfiles
1
0
Fork 0
mirror of https://gitlab.com/dwt1/dotfiles.git synced 2026-04-24 12:00:24 +10:00
Code Issues Packages Projects Releases Wiki Activity

Awesome configs for Ben.

Browse Source
This commit is contained in:
Derek Taylor
2023-04-05 14:32:50 -05:00
parent 1966d656c1
commit 6252ad30c1
608 changed files with 9300 additions and 3600 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
.config/awesome/lain/wiki/fs.md Executable file → Normal file
View File

@@ -1,12 +1,12 @@
## Usage
[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage)
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
### Description
Shows file systems informations.
Shows disk space usage for a set partition.
If a partition is given in input, a notification will be displayed when it is almost full.
Displays a notification when the partition is full or has low space.
```lua
local mypartition = lain.widget.fs()
@@ -16,38 +16,52 @@ local mypartition = lain.widget.fs()
Variable | Meaning | Type | Default
--- | --- | --- | ---
`timeout` | Refresh timeout (in seconds) | integer | 600
`partition` | (Optional) Partition to watch: a notification will be displayed when full | string | `nil`
`threshold` | Percentage threshold at which the notification is triggered | integer | 99
`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/fs#default-notification_preset)
`timeout` | Refresh timeout seconds -| number | 600
`partition` | Partition to monitor | string | "/"
`options` | Additional options to pass to [`dfs`](https://github.com/copycat-killer/lain/blob/master/scripts/dfs) | string, in the form `--type='fstype' | --exclude-type='fstype'` | nil
`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/copycat-killer/lain/wiki/fs#default-notification_preset)
`followtag` | Display the notification on currently focused screen | boolean | false
`notify` | Display notifications | string | "on"
`showpopup` | Display popups with mouse hovering | string, possible values: "on", "off" | "on"
`settings` | User settings | function | empty function
`settings` can use the table `fs_now`, which contains a string entry for each file system path available. For instance, root infos are located in the variable `fs_now["/"]`. Every entry in this table have the following variables:
`settings` can use the following `partition` related strings:
Variable | Meaning | Type
--- | --- | ---
`units` | (multiple of) units used | string ("Kb", "Mb", "Gb", and so on)
`percentage` | the used percentage | integer
`size` | size in `units` of the given fs | float
`used` | amount of space used in the given fs, expressed in `units` | float
`free` | amount of free space in the given fs, expressed in `units` | float
* `fs_now.size_mb`
* `fs_now.size_gb`
* `fs_now.used`
* `fs_now.used_mb`
* `fs_now.used_gb`
* `fs_now.available`
* `fs_now.available_mb`
* `fs_now.available_gb`
Usage example:
Within `settings`, you can obtain other partition values from internal `fs_info` table. For each partition, the following indexes are available:
* `fs_info[other_partition .. " size_mb"]`
* `fs_info[other_partition .. " size_gb"]`
* `fs_info[other_partition .. " used_p"]`
* `fs_info[other_partition .. " used_mb"]`
* `fs_info[other_partition .. " used_gb"]`
* `fs_info[other_partition .. " avail_p"]`
* `fs_info[other_partition .. " avail_mb"]`
* `fs_info[other_partition .. " avail_gb"]`
just like the variables of `fs_now`. Example:
```lua
-- shows used (percentage) and remaining space in home partition
-- shows root and home partitions percentage used
local fsroothome = lain.widget.fs({
settings = function()
widget:set_text("/home: " .. fs_now["/home"].percentage .. "% (" ..
fs_now["/home"].free .. " " .. fs_now["/home"].units .. " left)")
local home_used = tonumber(fs_info["/home used_p"]) or 0
widget:set_text("/ " .. fs_now.used .. "% | /home " .. home_used .. "% ")
end
})
-- output example: "/home: 37% (239.4 Gb left)"
```
With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
Also, `settings` can modify `notification_preset` table. This table will be the preset for the naughty notifications. Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the list of variables it can contain.
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
### Default `notification_preset`
@@ -79,4 +93,4 @@ where ``altkey = "Mod1"`` and ``show`` arguments, both optionals, are:
## Note
Naughty notifications require `notification_preset.font` to be **monospaced**, in order to correctly display the output.
Naughty notifications require `notification_preset.font` to be **monospaced**, in order to correctly display the output.