fish-shell/doc_src/cmds/fish_is_root_user.rst

.. _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
Fix paste-o that duplicated documentation header. 2020-07-01 02:11:56 +08:00			`.. _cmd-fish_is_root_user:`
Add a function to check if the user is root. Add a helper function to check if the user is root. This function can be useful for the prompts for example. Modify the prompts made root checked to use the function instead. Add also the support of Administrator like a root user. Fixes: #7031 2020-06-17 23:55:23 +08:00
			`fish_is_root_user - check if the current user is root`
			`=====================================================`

			`Synopsis`
			`--------`

doc_src: Continue the slog through the letter F. We are using only :: in a synopsis for fishscript examples given of the command being documented. 2021-12-18 07:16:47 +08:00			`fish_is_root_user`
Add a function to check if the user is root. Add a helper function to check if the user is root. This function can be useful for the prompts for example. Modify the prompts made root checked to use the function instead. Add also the support of Administrator like a root user. Fixes: #7031 2020-06-17 23:55:23 +08:00
			`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`