From b32c9954d3da430392575e9e637a2d8d114e34d0 Mon Sep 17 00:00:00 2001 From: Phil Jones Date: Mon, 17 Jul 2023 22:16:42 +0100 Subject: [PATCH] Add EXIT STATUS section to manpage. --- doc/tofi.1.md | 15 ++++++++++++++- doc/tofi.1.scd | 13 ++++++++++++- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/doc/tofi.1.md b/doc/tofi.1.md index 5b7c4d3..fe6e575 100644 --- a/doc/tofi.1.md +++ b/doc/tofi.1.md @@ -102,10 +102,23 @@ the form **--key=value**. > Numeric count of commands selected in **tofi-drun**, to enable sorting > results by run count. +## EXIT STATUS + +**tofi** exits with one of the following values: + +0 + +> Success; a selection was made, or **tofi** was invoked with the **-h** +> option. + +1 + +> An error occurred, or the user exited without making a selection. + ## AUTHORS Philip Jones \<\> ## SEE ALSO -**tofi**(5), **dmenu**(1) **rofi**(1) +**tofi**(5), **dmenu**(1), **rofi**(1) diff --git a/doc/tofi.1.scd b/doc/tofi.1.scd index 1cf46cd..716421d 100644 --- a/doc/tofi.1.scd +++ b/doc/tofi.1.scd @@ -85,10 +85,21 @@ _$XDG_STATE_HOME/tofi-drun-history_ Numeric count of commands selected in *tofi-drun*, to enable sorting results by run count. +# EXIT STATUS + +*tofi* exits with one of the following values: + +0 + Success; a selection was made, or *tofi* was invoked with the *-h* + option. + +1 + An error occurred, or the user exited without making a selection. + # AUTHORS Philip Jones # SEE ALSO -*tofi*(5), *dmenu*(1) *rofi*(1) +*tofi*(5), *dmenu*(1), *rofi*(1)