mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-28 05:43:11 +00:00
af61ea1325
We are using only :: in a synopsis for fishscript examples given of the command being documented.
29 lines
542 B
ReStructuredText
29 lines
542 B
ReStructuredText
.. _cmd-fish_is_root_user:
|
|
|
|
fish_is_root_user - check if the current user is root
|
|
=====================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
**fish_is_root_user**
|
|
|
|
Description
|
|
-----------
|
|
|
|
``fish_is_root_user`` will check if the current user is root. It can be useful
|
|
for the prompt to display something different if the user is root, for example.
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
A simple example:
|
|
|
|
::
|
|
|
|
function example --description 'Just an example'
|
|
if fish_is_root_user
|
|
do_something_different
|
|
end
|
|
end
|