github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/user-guide/bang-prefix_doc.yaml (about)

     1  - DocumentID: bang-prefix
     2    Title: >-
     3      Bang Prefix
     4    CategoryID: user-guide
     5    Summary: >-
     6      Bang prefixing to reverse default actions
     7    Description: |-
     8      ## Description
     9  
    10      Some builtins support a bang prefix, `!`, which provides a shorthand negative
    11      action to default behavior. For example, `set` defines a variable where as
    12      `!set` will undefine a variable.
    13  
    14      Sometimes the shortcut will be logical, like a **not** operator, as is the case
    15      with `and` where typically each result has to equal **true** normally or
    16      **false** if used in `!and`.
    17      
    18      Sometimes the shortcut will be more philosophical, such as with `config` where
    19      normal operations is to query or set configuration but `!config` resets the
    20      configuration to defaults (thus operating the same as `config default`).
    21  
    22      Please read the respecting commands doc for details on whether it supports a
    23      bang prefix and what the behavior of that prefix is.
    24    Synonyms:
    25    - bang-prefix
    26    - bang
    27    Related:
    28    - pipeline
    29    - reserved-vars
    30    - not-func
    31    - set
    32    - and
    33    - or
    34    - config
    35  
    36