summaryrefslogtreecommitdiffstats
path: root/doc/alpm-hooks.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/alpm-hooks.5.txt')
-rw-r--r--doc/alpm-hooks.5.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/alpm-hooks.5.txt b/doc/alpm-hooks.5.txt
index 3729387c..f33ff8cd 100644
--- a/doc/alpm-hooks.5.txt
+++ b/doc/alpm-hooks.5.txt
@@ -19,6 +19,7 @@ Type = File|Package (Required)
Target = <Path|PkgName> (Required, Repeatable)
[Action] (Required)
+Description = ... (Optional)
When = PreTransaction|PostTransaction (Required)
Exec = <Command> (Required)
Depends = <PkgName> (Optional)
@@ -63,6 +64,10 @@ defined the hook will run if the transaction matches *any* of the triggers.
ACTIONS
-------
+* Description =* ...::
+ An optional description that describes the action being taken by the
+ hook for use in front-end output.
+
*Exec =* <command>::
Command to run. Command arguments are split on whitespace. Values
containing whitespace should be enclosed in quotes. Required.