config

Personal configuration.
git clone git://code.dwrz.net/config
Log | Files | Refs

transient.info (152996B)


      1 This is transient.info, produced by makeinfo version 6.7 from
      2 transient.texi.
      3 
      4      Copyright (C) 2018–2024 Free Software Foundation, Inc.
      5 
      6      You can redistribute this document and/or modify it under the terms
      7      of the GNU General Public License as published by the Free Software
      8      Foundation, either version 3 of the License, or (at your option)
      9      any later version.
     10 
     11      This document is distributed in the hope that it will be useful,
     12      but WITHOUT ANY WARRANTY; without even the implied warranty of
     13      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     14      General Public License for more details.
     15 
     16 INFO-DIR-SECTION Emacs misc features
     17 START-INFO-DIR-ENTRY
     18 * Transient: (transient). Transient Commands.
     19 END-INFO-DIR-ENTRY
     20 
     21 
     22 File: transient.info,  Node: Top,  Next: Introduction,  Up: (dir)
     23 
     24 Transient User and Developer Manual
     25 ***********************************
     26 
     27 Transient is the library used to implement the keyboard-driven “menus”
     28 in Magit.  It is distributed as a separate package, so that it can be
     29 used to implement similar menus in other packages.
     30 
     31    This manual can be bit hard to digest when getting started.  A useful
     32 resource to get over that hurdle is Psionic K’s interactive tutorial,
     33 available at <https://github.com/positron-solutions/transient-showcase>.
     34 
     35 This manual is for Transient version 0.7.2.
     36 
     37      Copyright (C) 2018–2024 Free Software Foundation, Inc.
     38 
     39      You can redistribute this document and/or modify it under the terms
     40      of the GNU General Public License as published by the Free Software
     41      Foundation, either version 3 of the License, or (at your option)
     42      any later version.
     43 
     44      This document is distributed in the hope that it will be useful,
     45      but WITHOUT ANY WARRANTY; without even the implied warranty of
     46      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     47      General Public License for more details.
     48 
     49 * Menu:
     50 
     51 * Introduction::
     52 * Usage::
     53 * Modifying Existing Transients::
     54 * Defining New Commands::
     55 * Classes and Methods::
     56 * FAQ::
     57 * Keystroke Index::
     58 * Command and Function Index::
     59 * Variable Index::
     60 * Concept Index::
     61 * GNU General Public License::
     62 
     63 — The Detailed Node Listing —
     64 
     65 Usage
     66 
     67 * Invoking Transients::
     68 * Aborting and Resuming Transients::
     69 * Common Suffix Commands::
     70 * Saving Values::
     71 * Using History::
     72 * Getting Help for Suffix Commands::
     73 * Enabling and Disabling Suffixes::
     74 * Other Commands::
     75 * Configuration::
     76 
     77 Defining New Commands
     78 
     79 * Technical Introduction::
     80 * Defining Transients::
     81 * Binding Suffix and Infix Commands::
     82 * Defining Suffix and Infix Commands::
     83 * Using Infix Arguments::
     84 * Transient State::
     85 
     86 Binding Suffix and Infix Commands
     87 
     88 * Group Specifications::
     89 * Suffix Specifications::
     90 
     91 
     92 Classes and Methods
     93 
     94 * Group Classes::
     95 * Group Methods::
     96 * Prefix Classes::
     97 * Suffix Classes::
     98 * Suffix Methods::
     99 * Prefix Slots::
    100 * Suffix Slots::
    101 * Predicate Slots::
    102 
    103 Suffix Methods
    104 
    105 * Suffix Value Methods::
    106 * Suffix Format Methods::
    107 
    108 
    109 
    110 
    111 File: transient.info,  Node: Introduction,  Next: Usage,  Prev: Top,  Up: Top
    112 
    113 1 Introduction
    114 **************
    115 
    116 Transient is the library used to implement the keyboard-driven “menus”
    117 in Magit.  It is distributed as a separate package, so that it can be
    118 used to implement similar menus in other packages.
    119 
    120    This manual can be bit hard to digest when getting started.  A useful
    121 resource to get over that hurdle is Psionic K’s interactive tutorial,
    122 available at <https://github.com/positron-solutions/transient-showcase>.
    123 
    124 Some things that Transient can do
    125 =================================
    126 
    127    • Display current state of arguments
    128    • Display and manage lifecycle of modal bindings
    129    • Contextual user interface
    130    • Flow control for wizard-like composition of interactive forms
    131    • History & persistence
    132    • Rendering arguments for controlling CLI programs
    133 
    134 Complexity in CLI programs
    135 ==========================
    136 
    137 Complexity tends to grow with time.  How do you manage the complexity of
    138 commands?  Consider the humble shell command ‘ls’.  It now has over
    139 _fifty_ command line options.  Some of these are boolean flags (‘ls
    140 -l’).  Some take arguments (‘ls --sort=s’).  Some have no effect unless
    141 paired with other flags (‘ls -lh’).  Some are mutually exclusive.  Some
    142 shell commands even have so many options that they introduce
    143 _subcommands_ (‘git branch’, ‘git commit’), each with their own rich set
    144 of options (‘git branch -f’).
    145 
    146 Using Transient for composing interactive commands
    147 ==================================================
    148 
    149 What about Emacs commands used interactively?  How do these handle
    150 options?  One solution is to make many versions of the same command, so
    151 you don’t need to!  Consider: ‘delete-other-windows’ vs.
    152 ‘delete-other-windows-vertically’ (among many similar examples).
    153 
    154    Some Emacs commands will simply prompt you for the next "argument"
    155 (‘M-x switch-to-buffer’).  Another common solution is to use prefix
    156 arguments which usually start with ‘C-u’.  Sometimes these are sensibly
    157 numerical in nature (‘C-u 4 M-x forward-paragraph’ to move forward 4
    158 paragraphs).  But sometimes they function instead as boolean "switches"
    159 (‘C-u C-SPACE’ to jump to the last mark instead of just setting it, ‘C-u
    160 C-u C-SPACE’ to unconditionally set the mark).  Since there aren’t many
    161 standards for the use of prefix options, you have to read the command’s
    162 documentation to find out what the possibilities are.
    163 
    164    But when an Emacs command grows to have a truly large set of options
    165 and arguments, with dependencies between them, lots of option values,
    166 etc., these simple approaches just don’t scale.  Transient is designed
    167 to solve this issue.  Think of it as the humble prefix argument ‘C-u’,
    168 _raised to the power of 10_.  Like ‘C-u’, it is key driven.  Like the
    169 shell, it supports boolean "flag" options, options that take arguments,
    170 and even "sub-commands", with their own options.  But instead of
    171 searching through a man page or command documentation, well-designed
    172 transients _guide_ their users to the relevant set of options (and even
    173 their possible values!)  directly, taking into account any important
    174 pre-existing Emacs settings.  And while for shell commands like ‘ls’,
    175 there is only one way to "execute" (hit ‘Return’!), transients can
    176 "execute" using multiple different keys tied to one of many
    177 self-documenting _actions_ (imagine having 5 different colored return
    178 keys on your keyboard!).  Transients make navigating and setting large,
    179 complex groups of command options and arguments easy.  Fun even.  Once
    180 you’ve tried it, it’s hard to go back to the ‘C-u what can I do here
    181 again?’ way.
    182 
    183 
    184 File: transient.info,  Node: Usage,  Next: Modifying Existing Transients,  Prev: Introduction,  Up: Top
    185 
    186 2 Usage
    187 *******
    188 
    189 * Menu:
    190 
    191 * Invoking Transients::
    192 * Aborting and Resuming Transients::
    193 * Common Suffix Commands::
    194 * Saving Values::
    195 * Using History::
    196 * Getting Help for Suffix Commands::
    197 * Enabling and Disabling Suffixes::
    198 * Other Commands::
    199 * Configuration::
    200 
    201 
    202 File: transient.info,  Node: Invoking Transients,  Next: Aborting and Resuming Transients,  Up: Usage
    203 
    204 2.1 Invoking Transients
    205 =======================
    206 
    207 A transient prefix command is invoked like any other command by pressing
    208 the key that is bound to that command.  The main difference to other
    209 commands is that a transient prefix command activates a transient
    210 keymap, which temporarily binds the transient’s infix and suffix
    211 commands.  Bindings from other keymaps may, or may not, be disabled
    212 while the transient state is in effect.
    213 
    214    There are two kinds of commands that are available after invoking a
    215 transient prefix command; infix and suffix commands.  Infix commands set
    216 some value (which is then shown in a popup buffer), without leaving the
    217 transient.  Suffix commands, on the other hand, usually quit the
    218 transient and they may use the values set by the infix commands, i.e.,
    219 the infix *arguments*.
    220 
    221    Instead of setting arguments to be used by a suffix command, infix
    222 commands may also set some value by side-effect, e.g., by setting the
    223 value of some variable.
    224 
    225 
    226 File: transient.info,  Node: Aborting and Resuming Transients,  Next: Common Suffix Commands,  Prev: Invoking Transients,  Up: Usage
    227 
    228 2.2 Aborting and Resuming Transients
    229 ====================================
    230 
    231 To quit the transient without invoking a suffix command press ‘C-g’.
    232 
    233    Key bindings in transient keymaps may be longer than a single event.
    234 After pressing a valid prefix key, all commands whose bindings do not
    235 begin with that prefix key are temporarily unavailable and grayed out.
    236 To abort the prefix key press ‘C-g’ (which in this case only quits the
    237 prefix key, but not the complete transient).
    238 
    239    A transient prefix command can be bound as a suffix of another
    240 transient.  Invoking such a suffix replaces the current transient state
    241 with a new transient state, i.e., the available bindings change and the
    242 information displayed in the popup buffer is updated accordingly.
    243 Pressing ‘C-g’ while a nested transient is active only quits the
    244 innermost transient, causing a return to the previous transient.
    245 
    246    ‘C-q’ or ‘C-z’ on the other hand always exits all transients.  If you
    247 use the latter, then you can later resume the stack of transients using
    248 ‘M-x transient-resume’.
    249 
    250 ‘C-g’ (‘transient-quit-seq’)
    251 ‘C-g’ (‘transient-quit-one’)
    252      This key quits the currently active incomplete key sequence, if
    253      any, or else the current transient.  When quitting the current
    254      transient, it returns to the previous transient, if any.
    255 
    256    Transient’s predecessor bound ‘q’ instead of ‘C-g’ to the quit
    257 command.  To learn how to get that binding back see
    258 ‘transient-bind-q-to-quit’’s documentation string.
    259 
    260 ‘C-q’ (‘transient-quit-all’)
    261      This command quits the currently active incomplete key sequence, if
    262      any, and all transients, including the active transient and all
    263      suspended transients, if any.
    264 
    265 ‘C-z’ (‘transient-suspend’)
    266      Like ‘transient-quit-all’, this command quits an incomplete key
    267      sequence, if any, and all transients.  Additionally, it saves the
    268      stack of transients so that it can easily be resumed (which is
    269      particularly useful if you quickly need to do “something else” and
    270      the stack is deeper than a single transient, and/or you have
    271      already changed the values of some infix arguments).
    272 
    273      Note that only a single stack of transients can be saved at a time.
    274      If another stack is already saved, then saving a new stack discards
    275      the previous stack.
    276 
    277 ‘M-x transient-resume’
    278      This command resumes the previously suspended stack of transients,
    279      if any.
    280 
    281 
    282 File: transient.info,  Node: Common Suffix Commands,  Next: Saving Values,  Prev: Aborting and Resuming Transients,  Up: Usage
    283 
    284 2.3 Common Suffix Commands
    285 ==========================
    286 
    287 A few shared suffix commands are available in all transients.  These
    288 suffix commands are not shown in the popup buffer by default.
    289 
    290    This includes the aborting commands mentioned in the previous
    291 section, as well as some other commands that are all bound to ‘C-x KEY’.
    292 After ‘C-x’ is pressed, a section featuring all these common commands is
    293 temporarily shown in the popup buffer.  After invoking one of them, the
    294 section disappears again.  Note, however, that one of these commands is
    295 described as “Show common permanently”; invoke that if you want the
    296 common commands to always be shown for all transients.
    297 
    298 ‘C-x t’ (‘transient-toggle-common’)
    299      This command toggles whether the generic commands that are common
    300      to all transients are always displayed or only after typing the
    301      incomplete prefix key sequence ‘C-x’.  This only affects the
    302      current Emacs session.
    303 
    304  -- User Option: transient-show-common-commands
    305      This option controls whether shared suffix commands are shown
    306      alongside the transient-specific infix and suffix commands.  By
    307      default, the shared commands are not shown to avoid overwhelming
    308      the user with too many options.
    309 
    310      While a transient is active, pressing ‘C-x’ always shows the common
    311      commands.  The value of this option can be changed for the current
    312      Emacs session by typing ‘C-x t’ while a transient is active.
    313 
    314    The other common commands are described in either the previous or in
    315 one of the following sections.
    316 
    317    Some of Transient’s key bindings differ from the respective bindings
    318 of Magit-Popup; see *note FAQ:: for more information.
    319 
    320 
    321 File: transient.info,  Node: Saving Values,  Next: Using History,  Prev: Common Suffix Commands,  Up: Usage
    322 
    323 2.4 Saving Values
    324 =================
    325 
    326 After setting the infix arguments in a transient, the user can save
    327 those arguments for future invocations.
    328 
    329    Most transients will start out with the saved arguments when they are
    330 invoked.  There are a few exceptions, though.  Some transients are
    331 designed so that the value that they use is stored externally as the
    332 buffer-local value of some variable.  Invoking such a transient again
    333 uses the buffer-local value.  (1)
    334 
    335    If the user does not save the value and just exits using a regular
    336 suffix command, then the value is merely saved to the transient’s
    337 history.  That value won’t be used when the transient is next invoked,
    338 but it is easily accessible (see *note Using History::).
    339 
    340 ‘C-x s’ (‘transient-set’)
    341      This command saves the value of the active transient for this Emacs
    342      session.
    343 
    344 ‘C-x C-s’ (‘transient-save’)
    345      Save the value of the active transient persistently across Emacs
    346      sessions.
    347 
    348 ‘C-x C-k’ (‘transient-reset’)
    349      Clear the set and saved values of the active transient.
    350 
    351  -- User Option: transient-values-file
    352      This option names the file that is used to persist the values of
    353      transients between Emacs sessions.
    354 
    355    ---------- Footnotes ----------
    356 
    357    (1) ‘magit-diff’ and ‘magit-log’ are two prominent examples, and
    358 their handling of buffer-local values is actually a bit more complicated
    359 than outlined above and even customizable.
    360 
    361 
    362 File: transient.info,  Node: Using History,  Next: Getting Help for Suffix Commands,  Prev: Saving Values,  Up: Usage
    363 
    364 2.5 Using History
    365 =================
    366 
    367 Every time the user invokes a suffix command the transient’s current
    368 value is saved to its history.  These values can be cycled through the
    369 same way one can cycle through the history of commands that read
    370 user-input in the minibuffer.
    371 
    372 ‘C-M-p’ (‘transient-history-prev’)
    373 ‘C-x p’
    374      This command switches to the previous value used for the active
    375      transient.
    376 
    377 ‘C-M-n’ (‘transient-history-next’)
    378 ‘C-x n’
    379      This command switches to the next value used for the active
    380      transient.
    381 
    382    In addition to the transient-wide history, Transient of course
    383 supports per-infix history.  When an infix reads user-input using the
    384 minibuffer, the user can use the regular minibuffer history commands to
    385 cycle through previously used values.  Usually the same keys as those
    386 mentioned above are bound to those commands.
    387 
    388    Authors of transients should arrange for different infix commands
    389 that read the same kind of value to also use the same history key (see
    390 *note Suffix Slots::).
    391 
    392    Both kinds of history are saved to a file when Emacs is exited.
    393 
    394  -- User Option: transient-history-file
    395      This option names the file that is used to persist the history of
    396      transients and their infixes between Emacs sessions.
    397 
    398  -- User Option: transient-history-limit
    399      This option controls how many history elements are kept at the time
    400      the history is saved in ‘transient-history-file’.
    401 
    402 
    403 File: transient.info,  Node: Getting Help for Suffix Commands,  Next: Enabling and Disabling Suffixes,  Prev: Using History,  Up: Usage
    404 
    405 2.6 Getting Help for Suffix Commands
    406 ====================================
    407 
    408 Transients can have many suffixes and infixes that the user might not be
    409 familiar with.  To make it trivial to get help for these, Transient
    410 provides access to the documentation directly from the active transient.
    411 
    412 ‘C-h’ (‘transient-help’)
    413      This command enters help mode.  When help mode is active, typing a
    414      key shows information about the suffix command that the key
    415      normally is bound to (instead of invoking it).  Pressing ‘C-h’ a
    416      second time shows information about the _prefix_ command.
    417 
    418      After typing a key, the stack of transient states is suspended and
    419      information about the suffix command is shown instead.  Typing ‘q’
    420      in the help buffer buries that buffer and resumes the transient
    421      state.
    422 
    423    What sort of documentation is shown depends on how the transient was
    424 defined.  For infix commands that represent command-line arguments this
    425 ideally shows the appropriate manpage.  ‘transient-help’ then tries to
    426 jump to the correct location within that.  Info manuals are also
    427 supported.  The fallback is to show the command’s documentation string,
    428 for non-infix suffixes this is usually appropriate.
    429 
    430 
    431 File: transient.info,  Node: Enabling and Disabling Suffixes,  Next: Other Commands,  Prev: Getting Help for Suffix Commands,  Up: Usage
    432 
    433 2.7 Enabling and Disabling Suffixes
    434 ===================================
    435 
    436 The user base of a package that uses transients can be very diverse.
    437 This is certainly the case for Magit; some users have been using it and
    438 Git for a decade, while others are just getting started now.
    439 
    440    For that reason a mechanism is needed that authors can use to
    441 classify a transient’s infixes and suffixes along the
    442 essentials...everything spectrum.  We use the term “levels” to describe
    443 that mechanism.
    444 
    445    Each suffix command is placed on a level and each transient has a
    446 level (called “transient-level”), which controls which suffix commands
    447 are available.  Integers between 1 and 7 (inclusive) are valid levels.
    448 For suffixes, 0 is also valid; it means that the suffix is not displayed
    449 at any level.
    450 
    451    The levels of individual transients and/or their individual suffixes
    452 can be changed interactively, by invoking the transient and then
    453 pressing ‘C-x l’ to enter the “edit” mode, see below.
    454 
    455    The default level for both transients and their suffixes is 4.  The
    456 ‘transient-default-level’ option only controls the default for
    457 transients.  The default suffix level is always 4.  The authors of
    458 transients should place certain suffixes on a higher level, if they
    459 expect that it won’t be of use to most users, and they should place very
    460 important suffixes on a lower level, so that they remain available even
    461 if the user lowers the transient level.
    462 
    463  -- User Option: transient-default-level
    464      This option controls which suffix levels are made available by
    465      default.  It sets the transient-level for transients for which the
    466      user has not set that individually.
    467 
    468  -- User Option: transient-levels-file
    469      This option names the file that is used to persist the levels of
    470      transients and their suffixes between Emacs sessions.
    471 
    472 ‘C-x l’ (‘transient-set-level’)
    473      This command enters edit mode.  When edit mode is active, then all
    474      infixes and suffixes that are currently usable are displayed along
    475      with their levels.  The colors of the levels indicate whether they
    476      are enabled or not.  The level of the transient is also displayed
    477      along with some usage information.
    478 
    479      In edit mode, pressing the key that would usually invoke a certain
    480      suffix instead prompts the user for the level that suffix should be
    481      placed on.
    482 
    483      Help mode is available in edit mode.
    484 
    485      To change the transient level press ‘C-x l’ again.
    486 
    487      To exit edit mode press ‘C-g’.
    488 
    489      Note that edit mode does not display any suffixes that are not
    490      currently usable.  ‘magit-rebase’, for example, shows different
    491      suffixes depending on whether a rebase is already in progress or
    492      not.  The predicates also apply in edit mode.
    493 
    494      Therefore, to control which suffixes are available given a certain
    495      state, you have to make sure that that state is currently active.
    496 
    497 ‘C-x a’ (‘transient-toggle-level-limit’)
    498      This command toggle whether suffixes that are on levels higher than
    499      the level specified by ‘transient-default-level’ are temporarily
    500      available anyway.
    501 
    502 
    503 File: transient.info,  Node: Other Commands,  Next: Configuration,  Prev: Enabling and Disabling Suffixes,  Up: Usage
    504 
    505 2.8 Other Commands
    506 ==================
    507 
    508 When invoking a transient in a small frame, the transient window may not
    509 show the complete buffer, making it necessary to scroll, using the
    510 following commands.  These commands are never shown in the transient
    511 window, and the key bindings are the same as for ‘scroll-up-command’ and
    512 ‘scroll-down-command’ in other buffers.
    513 
    514  -- Command: transient-scroll-up arg
    515      This command scrolls text of transient popup window upward ARG
    516      lines.  If ARG is ‘nil’, then it scrolls near full screen.  This is
    517      a wrapper around ‘scroll-up-command’ (which see).
    518 
    519  -- Command: transient-scroll-down arg
    520      This command scrolls text of transient popup window down ARG lines.
    521      If ARG is ‘nil’, then it scrolls near full screen.  This is a
    522      wrapper around ‘scroll-down-command’ (which see).
    523 
    524 
    525 File: transient.info,  Node: Configuration,  Prev: Other Commands,  Up: Usage
    526 
    527 2.9 Configuration
    528 =================
    529 
    530 More options are described in *note Common Suffix Commands::, in *note
    531 Saving Values::, in *note Using History:: and in *note Enabling and
    532 Disabling Suffixes::.
    533 
    534 Essential Options
    535 -----------------
    536 
    537 Also see *note Common Suffix Commands::.
    538 
    539  -- User Option: transient-show-popup
    540      This option controls whether the current transient’s infix and
    541      suffix commands are shown in the popup buffer.
    542 
    543         • If ‘t’ (the default) then the popup buffer is shown as soon as
    544           a transient prefix command is invoked.
    545 
    546         • If ‘nil’, then the popup buffer is not shown unless the user
    547           explicitly requests it, by pressing an incomplete prefix key
    548           sequence.
    549 
    550         • If a number, then the a brief one-line summary is shown
    551           instead of the popup buffer.  If zero or negative, then not
    552           even that summary is shown; only the pressed key itself is
    553           shown.
    554 
    555           The popup is shown when the user explicitly requests it by
    556           pressing an incomplete prefix key sequence.  Unless this is
    557           zero, the popup is shown after that many seconds of inactivity
    558           (using the absolute value).
    559 
    560  -- User Option: transient-enable-popup-navigation
    561      This option controls whether navigation commands are enabled in the
    562      transient popup buffer.
    563 
    564      While a transient is active the transient popup buffer is not the
    565      current buffer, making it necessary to use dedicated commands to
    566      act on that buffer itself.  This is disabled by default.  If this
    567      option is non-‘nil’, then the following features are available:
    568 
    569         • ‘<UP>’ moves the cursor to the previous suffix.
    570         • ‘<DOWN>’ moves the cursor to the next suffix.
    571         • ‘<RET>’ invokes the suffix the cursor is on.
    572         • ‘mouse-1’ invokes the clicked on suffix.
    573         • ‘C-s’ and ‘C-r’ start isearch in the popup buffer.
    574 
    575  -- User Option: transient-display-buffer-action
    576      This option specifies the action used to display the transient
    577      popup buffer.  The transient popup buffer is displayed in a window
    578      using ‘(display-buffer BUFFER transient-display-buffer-action)’.
    579 
    580      The value of this option has the form ‘(FUNCTION . ALIST)’, where
    581      FUNCTION is a function or a list of functions.  Each such function
    582      should accept two arguments: a buffer to display and an alist of
    583      the same form as ALIST.  See *note (elisp)Choosing Window::, for
    584      details.
    585 
    586      The default is:
    587 
    588           (display-buffer-in-side-window
    589             (side . bottom)
    590             (inhibit-same-window . t)
    591             (window-parameters (no-other-window . t)))
    592 
    593      This displays the window at the bottom of the selected frame.
    594      Another useful FUNCTION is ‘display-buffer-below-selected’, which
    595      is what ‘magit-popup’ used by default.  For more alternatives see
    596      *note (elisp)Buffer Display Action Functions::, and *note
    597      (elisp)Buffer Display Action Alists::.
    598 
    599      Note that the buffer that was current before the transient buffer
    600      is shown should remain the current buffer.  Many suffix commands
    601      act on the thing at point, if appropriate, and if the transient
    602      buffer became the current buffer, then that would change what is at
    603      point.  To that effect ‘inhibit-same-window’ ensures that the
    604      selected window is not used to show the transient buffer.
    605 
    606      It may be possible to display the window in another frame, but
    607      whether that works in practice depends on the window-manager.  If
    608      the window manager selects the new window (Emacs frame), then that
    609      unfortunately changes which buffer is current.
    610 
    611      If you change the value of this option, then you might also want to
    612      change the value of ‘transient-mode-line-format’.
    613 
    614 Accessibility Options
    615 ---------------------
    616 
    617  -- User Option: transient-force-single-column
    618      This option controls whether the use of a single column to display
    619      suffixes is enforced.  This might be useful for users with low
    620      vision who use large text and might otherwise have to scroll in two
    621      dimensions.
    622 
    623 Auxiliary Options
    624 -----------------
    625 
    626  -- User Option: transient-mode-line-format
    627      This option controls whether the transient popup buffer has a
    628      mode-line, separator line, or neither.
    629 
    630      If ‘nil’, then the buffer has no mode-line.  If the buffer is not
    631      displayed right above the echo area, then this probably is not a
    632      good value.
    633 
    634      If ‘line’ (the default) or a natural number, then the buffer has no
    635      mode-line, but a line is drawn is drawn in its place.  If a number
    636      is used, that specifies the thickness of the line.  On termcap
    637      frames we cannot draw lines, so there ‘line’ and numbers are
    638      synonyms for ‘nil’.
    639 
    640      The color of the line is used to indicate if non-suffixes are
    641      allowed and whether they exit the transient.  The foreground color
    642      of ‘transient-key-noop’ (if non-suffix are disallowed),
    643      ‘transient-key-stay’ (if allowed and transient stays active), or
    644      ‘transient-key-exit’ (if allowed and they exit the transient) is
    645      used to draw the line.
    646 
    647      Otherwise this can be any mode-line format.  See *note (elisp)Mode
    648      Line Format::, for details.
    649 
    650  -- User Option: transient-semantic-coloring
    651      This option controls whether colors are used to indicate the
    652      transient behavior of commands.
    653 
    654      If non-‘nil’, then the key binding of each suffix is colorized to
    655      indicate whether it exits the transient state or not.  The color of
    656      the prefix is indicated using the line that is drawn when the value
    657      of ‘transient-mode-line-format’ is ‘line’.
    658 
    659  -- User Option: transient-highlight-mismatched-keys
    660      This option controls whether key bindings of infix commands that do
    661      not match the respective command-line argument should be
    662      highlighted.  For other infix commands this option has no effect.
    663 
    664      When this option is non-‘nil’, the key binding for an infix
    665      argument is highlighted when only a long argument (e.g.,
    666      ‘--verbose’) is specified but no shorthand (e.g., ‘-v’).  In the
    667      rare case that a shorthand is specified but the key binding does
    668      not match, then it is highlighted differently.
    669 
    670      Highlighting mismatched key bindings is useful when learning the
    671      arguments of the underlying command-line tool; you wouldn’t want to
    672      learn any short-hands that do not actually exist.
    673 
    674      The highlighting is done using one of the faces
    675      ‘transient-mismatched-key’ and ‘transient-nonstandard-key’.
    676 
    677  -- User Option: transient-substitute-key-function
    678      This function is used to modify key bindings.  If the value of this
    679      option is ‘nil’ (the default), then no substitution is performed.
    680 
    681      This function is called with one argument, the prefix object, and
    682      must return a key binding description, either the existing key
    683      description it finds in the ‘key’ slot, or the key description that
    684      replaces the prefix key.  It could be used to make other
    685      substitutions, but that is discouraged.
    686 
    687      For example, ‘=’ is hard to reach using my custom keyboard layout,
    688      so I substitute ‘(’ for that, which is easy to reach using a layout
    689      optimized for lisp.
    690 
    691           (setq transient-substitute-key-function
    692                 (lambda (obj)
    693                   (let ((key (oref obj key)))
    694                     (if (string-match "\\`\\(=\\)[a-zA-Z]" key)
    695                         (replace-match "(" t t key 1)
    696                       key))))
    697 
    698  -- User Option: transient-read-with-initial-input
    699      This option controls whether the last history element is used as
    700      the initial minibuffer input when reading the value of an infix
    701      argument from the user.  If ‘nil’, there is no initial input and
    702      the first element has to be accessed the same way as the older
    703      elements.
    704 
    705  -- User Option: transient-hide-during-minibuffer-read
    706      This option controls whether the transient buffer is hidden while
    707      user input is being read in the minibuffer.
    708 
    709  -- User Option: transient-align-variable-pitch
    710      This option controls whether columns are aligned pixel-wise in the
    711      popup buffer.
    712 
    713      If this is non-‘nil’, then columns are aligned pixel-wise to
    714      support variable-pitch fonts.  Keys are not aligned, so you should
    715      use a fixed-pitch font for the ‘transient-key’ face.  Other key
    716      faces inherit from that face unless a theme is used that breaks
    717      that relationship.
    718 
    719      This option is intended for users who use a variable-pitch font for
    720      the ‘default’ face.
    721 
    722  -- User Option: transient-force-fixed-pitch
    723      This option controls whether to force the use of a monospaced font
    724      in popup buffer.  Even if you use a proportional font for the
    725      ‘default’ face, you might still want to use a monospaced font in
    726      transient’s popup buffer.  Setting this option to ‘t’ causes
    727      ‘default’ to be remapped to ‘fixed-pitch’ in that buffer.
    728 
    729 Developer Options
    730 -----------------
    731 
    732 These options are mainly intended for developers.
    733 
    734  -- User Option: transient-detect-key-conflicts
    735      This option controls whether key binding conflicts should be
    736      detected at the time the transient is invoked.  If so, this results
    737      in an error, which prevents the transient from being used.  Because
    738      of that, conflicts are ignored by default.
    739 
    740      Conflicts cannot be determined earlier, i.e., when the transient is
    741      being defined and when new suffixes are being added, because at
    742      that time there can be false-positives.  It is actually valid for
    743      multiple suffixes to share a common key binding, provided the
    744      predicates of those suffixes prevent that more than one of them is
    745      enabled at a time.
    746 
    747  -- User Option: transient-highlight-higher-levels
    748      This option controls whether suffixes that would not be available
    749      by default are highlighted.
    750 
    751      When non-‘nil’ then the descriptions of suffixes are highlighted if
    752      their level is above 4, the default of ‘transient-default-level’.
    753      Assuming you have set that variable to 7, this highlights all
    754      suffixes that won’t be available to users without them making the
    755      same customization.
    756 
    757 
    758 File: transient.info,  Node: Modifying Existing Transients,  Next: Defining New Commands,  Prev: Usage,  Up: Top
    759 
    760 3 Modifying Existing Transients
    761 *******************************
    762 
    763 To an extent, transients can be customized interactively, see *note
    764 Enabling and Disabling Suffixes::.  This section explains how existing
    765 transients can be further modified non-interactively.  Let’s begin with
    766 an example:
    767 
    768      (transient-append-suffix 'magit-patch-apply "-3"
    769        '("-R" "Apply in reverse" "--reverse"))
    770 
    771    This inserts a new infix argument to toggle the ‘--reverse’ argument
    772 after the infix argument that toggles ‘-3’ in ‘magit-patch-apply’.
    773 
    774    The following functions share a few arguments:
    775 
    776    • PREFIX is a transient prefix command, a symbol.
    777 
    778    • SUFFIX is a transient infix or suffix specification in the same
    779      form as expected by ‘transient-define-prefix’.  Note that an infix
    780      is a special kind of suffix.  Depending on context “suffixes” means
    781      “suffixes (including infixes)” or “non-infix suffixes”.  Here it
    782      means the former.  See *note Suffix Specifications::.
    783 
    784      SUFFIX may also be a group in the same form as expected by
    785      ‘transient-define-prefix’.  See *note Group Specifications::.
    786 
    787    • LOC is a command, a key vector, a key description (a string as
    788      returned by ‘key-description’), or a list specifying coordinates
    789      (the last element may also be a command or key).  For example ‘(1 0
    790      -1)’ identifies the last suffix (‘-1’) of the first subgroup (‘0’)
    791      of the second group (‘1’).
    792 
    793      If LOC is a list of coordinates, then it can be used to identify a
    794      group, not just an individual suffix command.
    795 
    796      The function ‘transient-get-suffix’ can be useful to determine
    797      whether a certain coordination list identifies the suffix or group
    798      that you expect it to identify.  In hairy cases it may be necessary
    799      to look at the definition of the transient prefix command.
    800 
    801    These functions operate on the information stored in the
    802 ‘transient--layout’ property of the PREFIX symbol.  Suffix entries in
    803 that tree are not objects but have the form ‘(LEVEL CLASS PLIST)’, where
    804 PLIST should set at least ‘:key’, ‘:description’ and ‘:command’.
    805 
    806  -- Function: transient-insert-suffix prefix loc suffix &optional
    807           keep-other
    808  -- Function: transient-append-suffix prefix loc suffix &optional
    809           keep-other
    810      These functions insert the suffix or group SUFFIX into PREFIX
    811      before or after LOC.
    812 
    813      Conceptually adding a binding to a transient prefix is similar to
    814      adding a binding to a keymap, but this is complicated by the fact
    815      that multiple suffix commands can be bound to the same key,
    816      provided they are never active at the same time, see *note
    817      Predicate Slots::.
    818 
    819      Unfortunately both false-positives and false-negatives are
    820      possible.  To deal with the former use non-‘nil’ KEEP-OTHER.  To
    821      deal with the latter remove the conflicting binding explicitly.
    822 
    823  -- Function: transient-replace-suffix prefix loc suffix
    824      This function replaces the suffix or group at LOC in PREFIX with
    825      suffix or group SUFFIX.
    826 
    827  -- Function: transient-remove-suffix prefix loc
    828      This function removes the suffix or group at LOC in PREFIX.
    829 
    830  -- Function: transient-get-suffix prefix loc
    831      This function returns the suffix or group at LOC in PREFIX.  The
    832      returned value has the form mentioned above.
    833 
    834  -- Function: transient-suffix-put prefix loc prop value
    835      This function edits the suffix or group at LOC in PREFIX, by
    836      setting the PROP of its plist to VALUE.
    837 
    838    Most of these functions do not signal an error if they cannot perform
    839 the requested modification.  The functions that insert new suffixes show
    840 a warning if LOC cannot be found in PREFIX without signaling an error.
    841 The reason for doing it like this is that establishing a key binding
    842 (and that is what we essentially are trying to do here) should not
    843 prevent the rest of the configuration from loading.  Among these
    844 functions only ‘transient-get-suffix’ and ‘transient-suffix-put’ may
    845 signal an error.
    846 
    847 
    848 File: transient.info,  Node: Defining New Commands,  Next: Classes and Methods,  Prev: Modifying Existing Transients,  Up: Top
    849 
    850 4 Defining New Commands
    851 ***********************
    852 
    853 * Menu:
    854 
    855 * Technical Introduction::
    856 * Defining Transients::
    857 * Binding Suffix and Infix Commands::
    858 * Defining Suffix and Infix Commands::
    859 * Using Infix Arguments::
    860 * Transient State::
    861 
    862 
    863 File: transient.info,  Node: Technical Introduction,  Next: Defining Transients,  Up: Defining New Commands
    864 
    865 4.1 Technical Introduction
    866 ==========================
    867 
    868 Taking inspiration from prefix keys and prefix arguments, Transient
    869 implements a similar abstraction involving a prefix command, infix
    870 arguments and suffix commands.
    871 
    872    When the user calls a transient prefix command, a transient
    873 (temporary) keymap is activated, which binds the transient’s infix and
    874 suffix commands, and functions that control the transient state are
    875 added to ‘pre-command-hook’ and ‘post-command-hook’.  The available
    876 suffix and infix commands and their state are shown in a popup buffer
    877 until the transient state is exited by invoking a suffix command.
    878 
    879    Calling an infix command causes its value to be changed.  How that is
    880 done depends on the type of the infix command.  The simplest case is an
    881 infix command that represents a command-line argument that does not take
    882 a value.  Invoking such an infix command causes the switch to be toggled
    883 on or off.  More complex infix commands may read a value from the user,
    884 using the minibuffer.
    885 
    886    Calling a suffix command usually causes the transient to be exited;
    887 the transient keymaps and hook functions are removed, the popup buffer
    888 no longer shows information about the (no longer bound) suffix commands,
    889 the values of some public global variables are set, while some internal
    890 global variables are unset, and finally the command is actually called.
    891 Suffix commands can also be configured to not exit the transient.
    892 
    893    A suffix command can, but does not have to, use the infix arguments
    894 in much the same way any command can choose to use or ignore the prefix
    895 arguments.  For a suffix command that was invoked from a transient, the
    896 variable ‘transient-current-suffixes’ and the function ‘transient-args’
    897 serve about the same purpose as the variables ‘prefix-arg’ and
    898 ‘current-prefix-arg’ do for any command that was called after the prefix
    899 arguments have been set using a command such as ‘universal-argument’.
    900 
    901    Transient can be used to implement simple “command dispatchers”.  The
    902 main benefit then is that the user can see all the available commands in
    903 a popup buffer, which can be thought of as a “menus”.  That is useful by
    904 itself because it frees the user from having to remember all the keys
    905 that are valid after a certain prefix key or command.  Magit’s
    906 ‘magit-dispatch’ (on ‘C-x M-g’) command is an example of using Transient
    907 to merely implement a command dispatcher.
    908 
    909    In addition to that, Transient also allows users to interactively
    910 pass arguments to commands.  These arguments can be much more complex
    911 than what is reasonable when using prefix arguments.  There is a limit
    912 to how many aspects of a command can be controlled using prefix
    913 arguments.  Furthermore, what a certain prefix argument means for
    914 different commands can be completely different, and users have to read
    915 documentation to learn and then commit to memory what a certain prefix
    916 argument means to a certain command.
    917 
    918    Transient suffix commands, on the other hand, can accept dozens of
    919 different arguments without the user having to remember anything.  When
    920 using Transient, one can call a command with arguments that are just as
    921 complex as when calling the same function non-interactively from Lisp.
    922 
    923    Invoking a transient suffix command with arguments is similar to
    924 invoking a command in a shell with command-line completion and history
    925 enabled.  One benefit of the Transient interface is that it remembers
    926 history not only on a global level (“this command was invoked using
    927 these arguments, and previously it was invoked using those other
    928 arguments”), but also remembers the values of individual arguments
    929 independently.  See *note Using History::.
    930 
    931    After a transient prefix command is invoked, ‘C-h KEY’ can be used to
    932 show the documentation for the infix or suffix command that ‘KEY’ is
    933 bound to (see *note Getting Help for Suffix Commands::), and infixes and
    934 suffixes can be removed from the transient using ‘C-x l KEY’.  Infixes
    935 and suffixes that are disabled by default can be enabled the same way.
    936 See *note Enabling and Disabling Suffixes::.
    937 
    938    Transient ships with support for a few different types of specialized
    939 infix commands.  A command that sets a command line option, for example,
    940 has different needs than a command that merely toggles a boolean flag.
    941 Additionally, Transient provides abstractions for defining new types,
    942 which the author of Transient did not anticipate (or didn’t get around
    943 to implementing yet).
    944 
    945    Note that suffix commands also support regular prefix arguments.  A
    946 suffix command may even be called with both infix and prefix arguments
    947 at the same time.  If you invoke a command as a suffix of a transient
    948 prefix command, but also want to pass prefix arguments to it, then first
    949 invoke the prefix command, and only after doing that invoke the prefix
    950 arguments, before finally invoking the suffix command.  If you instead
    951 began by providing the prefix arguments, then those would apply to the
    952 prefix command, not the suffix command.  Likewise, if you want to change
    953 infix arguments before invoking a suffix command with prefix arguments,
    954 then change the infix arguments before invoking the prefix arguments.
    955 In other words, regular prefix arguments always apply to the next
    956 command, and since transient prefix, infix and suffix commands are just
    957 regular commands, the same applies to them.  (Regular prefix keys behave
    958 differently because they are not commands at all, instead they are just
    959 incomplete key sequences, and those cannot be interrupted with prefix
    960 commands.)
    961 
    962 
    963 File: transient.info,  Node: Defining Transients,  Next: Binding Suffix and Infix Commands,  Prev: Technical Introduction,  Up: Defining New Commands
    964 
    965 4.2 Defining Transients
    966 =======================
    967 
    968 A transient consists of a prefix command and at least one suffix
    969 command, though usually a transient has several infix and suffix
    970 commands.  The below macro defines the transient prefix command *and*
    971 binds the transient’s infix and suffix commands.  In other words, it
    972 defines the complete transient, not just the transient prefix command
    973 that is used to invoke that transient.
    974 
    975  -- Macro: transient-define-prefix name arglist [docstring] [keyword
    976           value]... group... [body...]
    977      This macro defines NAME as a transient prefix command and binds the
    978      transient’s infix and suffix commands.
    979 
    980      ARGLIST are the arguments that the prefix command takes.  DOCSTRING
    981      is the documentation string and is optional.
    982 
    983      These arguments can optionally be followed by keyword-value pairs.
    984      Each key has to be a keyword symbol, either ‘:class’ or a keyword
    985      argument supported by the constructor of that class.  The
    986      ‘transient-prefix’ class is used if the class is not specified
    987      explicitly.
    988 
    989      GROUPs add key bindings for infix and suffix commands and specify
    990      how these bindings are presented in the popup buffer.  At least one
    991      GROUP has to be specified.  See *note Binding Suffix and Infix
    992      Commands::.
    993 
    994      The BODY is optional.  If it is omitted, then ARGLIST is ignored
    995      and the function definition becomes:
    996 
    997           (lambda ()
    998             (interactive)
    999             (transient-setup 'NAME))
   1000 
   1001      If BODY is specified, then it must begin with an ‘interactive’ form
   1002      that matches ARGLIST, and it must call ‘transient-setup’.  It may,
   1003      however, call that function only when some condition is satisfied.
   1004 
   1005      All transients have a (possibly ‘nil’) value, which is exported
   1006      when suffix commands are called, so that they can consume that
   1007      value.  For some transients it might be necessary to have a sort of
   1008      secondary value, called a “scope”.  Such a scope would usually be
   1009      set in the command’s ‘interactive’ form and has to be passed to the
   1010      setup function:
   1011 
   1012           (transient-setup 'NAME nil nil :scope SCOPE)
   1013 
   1014      For example, the scope of the ‘magit-branch-configure’ transient is
   1015      the branch whose variables are being configured.
   1016 
   1017 
   1018 File: transient.info,  Node: Binding Suffix and Infix Commands,  Next: Defining Suffix and Infix Commands,  Prev: Defining Transients,  Up: Defining New Commands
   1019 
   1020 4.3 Binding Suffix and Infix Commands
   1021 =====================================
   1022 
   1023 The macro ‘transient-define-prefix’ is used to define a transient.  This
   1024 defines the actual transient prefix command (see *note Defining
   1025 Transients::) and adds the transient’s infix and suffix bindings, as
   1026 described below.
   1027 
   1028    Users and third-party packages can add additional bindings using
   1029 functions such as ‘transient-insert-suffix’ (see *note Modifying
   1030 Existing Transients::).  These functions take a “suffix specification”
   1031 as one of their arguments, which has the same form as the specifications
   1032 used in ‘transient-define-prefix’.
   1033 
   1034 * Menu:
   1035 
   1036 * Group Specifications::
   1037 * Suffix Specifications::
   1038 
   1039 
   1040 File: transient.info,  Node: Group Specifications,  Next: Suffix Specifications,  Up: Binding Suffix and Infix Commands
   1041 
   1042 4.3.1 Group Specifications
   1043 --------------------------
   1044 
   1045 The suffix and infix commands of a transient are organized in groups.
   1046 The grouping controls how the descriptions of the suffixes are outlined
   1047 visually but also makes it possible to set certain properties for a set
   1048 of suffixes.
   1049 
   1050    Several group classes exist, some of which organize suffixes in
   1051 subgroups.  In most cases the class does not have to be specified
   1052 explicitly, but see *note Group Classes::.
   1053 
   1054    Groups are specified in the call to ‘transient-define-prefix’, using
   1055 vectors.  Because groups are represented using vectors, we cannot use
   1056 square brackets to indicate an optional element and instead use curly
   1057 brackets to do the latter.
   1058 
   1059    Group specifications then have this form:
   1060 
   1061      [{LEVEL} {DESCRIPTION} {KEYWORD VALUE}... ELEMENT...]
   1062 
   1063    The LEVEL is optional and defaults to 4.  See *note Enabling and
   1064 Disabling Suffixes::.
   1065 
   1066    The DESCRIPTION is optional.  If present, it is used as the heading
   1067 of the group.
   1068 
   1069    The KEYWORD-VALUE pairs are optional.  Each keyword has to be a
   1070 keyword symbol, either ‘:class’ or a keyword argument supported by the
   1071 constructor of that class.
   1072 
   1073    • One of these keywords, ‘:description’, is equivalent to specifying
   1074      DESCRIPTION at the very beginning of the vector.  The
   1075      recommendation is to use ‘:description’ if some other keyword is
   1076      also used, for consistency, or DESCRIPTION otherwise, because it
   1077      looks better.
   1078 
   1079    • Likewise ‘:level’ is equivalent to LEVEL.
   1080 
   1081    • Other important keywords include the ‘:if...’ keywords.  These
   1082      keywords control whether the group is available in a certain
   1083      situation.
   1084 
   1085      For example, one group of the ‘magit-rebase’ transient uses ‘:if
   1086      magit-rebase-in-progress-p’, which contains the suffixes that are
   1087      useful while rebase is already in progress; and another that uses
   1088      ‘:if-not magit-rebase-in-progress-p’, which contains the suffixes
   1089      that initiate a rebase.
   1090 
   1091      These predicates can also be used on individual suffixes and are
   1092      only documented once, see *note Predicate Slots::.
   1093 
   1094    • The value of ‘:hide’, if non-‘nil’, is a predicate that controls
   1095      whether the group is hidden by default.  The key bindings for
   1096      suffixes of a hidden group should all use the same prefix key.
   1097      Pressing that prefix key should temporarily show the group and its
   1098      suffixes, which assumes that a predicate like this is used:
   1099 
   1100           (lambda ()
   1101             (eq (car transient--redisplay-key)
   1102                 ?\C-c)) ; the prefix key shared by all bindings
   1103 
   1104    • The value of ‘:setup-children’, if non-‘nil’, is a function that
   1105      takes one argument, a potentially list of children, and must return
   1106      a list of children or an empty list.  This can either be used to
   1107      somehow transform the group’s children that were defined the normal
   1108      way, or to dynamically create the children from scratch.
   1109 
   1110      The returned children must have the same form as stored in the
   1111      prefix’s ‘transient--layout’ property, but it is often more
   1112      convenient to use the same form as understood by
   1113      ‘transient-define-prefix’, described below.  If you use the latter
   1114      approach, you can use the ‘transient-parse-suffixes’ and
   1115      ‘transient-parse-suffix’ functions to transform them from the
   1116      convenient to the expected form.
   1117 
   1118      If you explicitly specify children and then transform them using
   1119      ‘:setup-children’, then the class of the group is determined as
   1120      usual, based on explicitly specified children.
   1121 
   1122      If you do not explicitly specify children and thus rely solely on
   1123      ‘:setup-children’, then you must specify the class using ‘:class’.
   1124      For backward compatibility, if you fail to do so,
   1125      ‘transient-column’ is used and a warning is displayed.  This
   1126      warning will eventually be replaced with an error.
   1127 
   1128    • The boolean ‘:pad-keys’ argument controls whether keys of all
   1129      suffixes contained in a group are right padded, effectively
   1130      aligning the descriptions.
   1131 
   1132    The ELEMENTs are either all subgroups, or all suffixes and strings.
   1133 (At least currently no group type exists that would allow mixing
   1134 subgroups with commands at the same level, though in principle there is
   1135 nothing that prevents that.)
   1136 
   1137    If the ELEMENTs are not subgroups, then they can be a mixture of
   1138 lists, which specify commands, and strings.  Strings are inserted
   1139 verbatim into the buffer.  The empty string can be used to insert gaps
   1140 between suffixes, which is particularly useful if the suffixes are
   1141 outlined as a table.
   1142 
   1143    Inside group specifications, including inside contained suffix
   1144 specifications, nothing has to be quoted and quoting anyway is invalid.
   1145 The value following a keyword, can be explicitly unquoted using ‘,’.
   1146 This feature is experimental and should be avoided.
   1147 
   1148    The form of suffix specifications is documented in the next node.
   1149 
   1150 
   1151 File: transient.info,  Node: Suffix Specifications,  Prev: Group Specifications,  Up: Binding Suffix and Infix Commands
   1152 
   1153 4.3.2 Suffix Specifications
   1154 ---------------------------
   1155 
   1156 A transient’s suffix and infix commands are bound when the transient
   1157 prefix command is defined using ‘transient-define-prefix’, see *note
   1158 Defining Transients::.  The commands are organized into groups, see
   1159 *note Group Specifications::.  Here we describe the form used to bind an
   1160 individual suffix command.
   1161 
   1162    The same form is also used when later binding additional commands
   1163 using functions such as ‘transient-insert-suffix’, see *note Modifying
   1164 Existing Transients::.
   1165 
   1166    Note that an infix is a special kind of suffix.  Depending on context
   1167 “suffixes” means “suffixes (including infixes)” or “non-infix suffixes”.
   1168 Here it means the former.
   1169 
   1170    Suffix specifications have this form:
   1171 
   1172      ([LEVEL] [KEY [DESCRIPTION]] COMMAND|ARGUMENT [KEYWORD VALUE]...)
   1173 
   1174    LEVEL, KEY and DESCRIPTION can also be specified using the KEYWORDs
   1175 ‘:level’, ‘:key’ and ‘:description’.  If the object that is associated
   1176 with COMMAND sets these properties, then they do not have to be
   1177 specified here.  You can however specify them here anyway, possibly
   1178 overriding the object’s values just for the binding inside this
   1179 transient.
   1180 
   1181    • LEVEL is the suffix level, an integer between 1 and 7.  See *note
   1182      Enabling and Disabling Suffixes::.
   1183 
   1184    • KEY is the key binding, either a vector or key description string.
   1185 
   1186    • DESCRIPTION is the description, either a string or a function that
   1187      takes zero or one arguments (the suffix object) and returns a
   1188      string.  The function should be a lambda expression to avoid
   1189      ambiguity.  In some cases a symbol that is bound as a function
   1190      would also work but to be safe you should use ‘:description’ in
   1191      that case.
   1192 
   1193    The next element is either a command or an argument.  This is the
   1194 only argument that is mandatory in all cases.
   1195 
   1196    • COMMAND should be a symbol that is bound as a function, which has
   1197      to be defined or at least autoloaded as a command by the time the
   1198      containing prefix command is invoked.
   1199 
   1200      Any command will do; it does not need to have an object associated
   1201      with it (as would be the case if ‘transient-define-suffix’ or
   1202      ‘transient-define-infix’ were used to define it).
   1203 
   1204      COMMAND can also be a ‘lambda’ expression.
   1205 
   1206      As mentioned above, the object that is associated with a command
   1207      can be used to set the default for certain values that otherwise
   1208      have to be set in the suffix specification.  Therefore if there is
   1209      no object, then you have to make sure to specify the KEY and the
   1210      DESCRIPTION.
   1211 
   1212      As a special case, if you want to add a command that might be
   1213      neither defined nor autoloaded, you can use a workaround like:
   1214 
   1215           (transient-insert-suffix 'some-prefix "k"
   1216             '("!" "Ceci n'est pas une commande" no-command
   1217               :if (lambda () (featurep 'no-library))))
   1218 
   1219      Instead of ‘featurep’ you could also use ‘require’ with a non-‘nil’
   1220      value for NOERROR.
   1221 
   1222    • The mandatory argument can also be a command-line argument, a
   1223      string.  In that case an anonymous command is defined and bound.
   1224 
   1225      Instead of a string, this can also be a list of two strings, in
   1226      which case the first string is used as the short argument (which
   1227      can also be specified using ‘:shortarg’) and the second as the long
   1228      argument (which can also be specified using ‘:argument’).
   1229 
   1230      Only the long argument is displayed in the popup buffer.  See
   1231      ‘transient-detect-key-conflicts’ for how the short argument may be
   1232      used.
   1233 
   1234      Unless the class is specified explicitly, the appropriate class is
   1235      guessed based on the long argument.  If the argument ends with ‘=’
   1236      (e.g., ‘--format=’) then ‘transient-option’ is used, otherwise
   1237      ‘transient-switch’.
   1238 
   1239    Finally, details can be specified using optional KEYWORD-VALUE pairs.
   1240 Each keyword has to be a keyword symbol, either ‘:class’ or a keyword
   1241 argument supported by the constructor of that class.  See *note Suffix
   1242 Slots::.
   1243 
   1244 
   1245 File: transient.info,  Node: Defining Suffix and Infix Commands,  Next: Using Infix Arguments,  Prev: Binding Suffix and Infix Commands,  Up: Defining New Commands
   1246 
   1247 4.4 Defining Suffix and Infix Commands
   1248 ======================================
   1249 
   1250 Note that an infix is a special kind of suffix.  Depending on context
   1251 “suffixes” means “suffixes (including infixes)” or “non-infix suffixes”.
   1252 
   1253  -- Macro: transient-define-suffix name arglist [docstring] [keyword
   1254           value]... body...
   1255      This macro defines NAME as a transient suffix command.
   1256 
   1257      ARGLIST are the arguments that the command takes.  DOCSTRING is the
   1258      documentation string and is optional.
   1259 
   1260      These arguments can optionally be followed by keyword-value pairs.
   1261      Each keyword has to be a keyword symbol, either ‘:class’ or a
   1262      keyword argument supported by the constructor of that class.  The
   1263      ‘transient-suffix’ class is used if the class is not specified
   1264      explicitly.
   1265 
   1266      The BODY must begin with an ‘interactive’ form that matches
   1267      ARGLIST.  The infix arguments are usually accessed by using
   1268      ‘transient-args’ inside ‘interactive’.
   1269 
   1270  -- Macro: transient-define-infix name arglist [docstring] [keyword
   1271           value]...
   1272      This macro defines NAME as a transient infix command.
   1273 
   1274      ARGLIST is always ignored (but mandatory never-the-less) and
   1275      reserved for future use.  DOCSTRING is the documentation string and
   1276      is optional.
   1277 
   1278      At least one key-value pair is required.  All transient infix
   1279      commands are ‘equal’ to each other (but not ‘eq’).  It is
   1280      meaningless to define an infix command, without providing at least
   1281      one keyword argument (usually ‘:argument’ or ‘:variable’, depending
   1282      on the class).  The suffix class defaults to ‘transient-switch’ and
   1283      can be set using the ‘:class’ keyword.
   1284 
   1285      The function definition is always:
   1286 
   1287           (lambda ()
   1288             (interactive)
   1289             (let ((obj (transient-suffix-object)))
   1290               (transient-infix-set obj (transient-infix-read obj)))
   1291             (transient--show))
   1292 
   1293      ‘transient-infix-read’ and ‘transient-infix-set’ are generic
   1294      functions.  Different infix commands behave differently because the
   1295      concrete methods are different for different infix command classes.
   1296      In rare cases the above command function might not be suitable,
   1297      even if you define your own infix command class.  In that case you
   1298      have to use ‘transient-define-suffix’ to define the infix command
   1299      and use ‘t’ as the value of the ‘:transient’ keyword.
   1300 
   1301  -- Macro: transient-define-argument name arglist [docstring] [keyword
   1302           value]...
   1303      This macro defines NAME as a transient infix command.
   1304 
   1305      This is an alias for ‘transient-define-infix’.  Only use this alias
   1306      to define an infix command that actually sets an infix argument.
   1307      To define an infix command that, for example, sets a variable, use
   1308      ‘transient-define-infix’ instead.
   1309 
   1310 
   1311 File: transient.info,  Node: Using Infix Arguments,  Next: Transient State,  Prev: Defining Suffix and Infix Commands,  Up: Defining New Commands
   1312 
   1313 4.5 Using Infix Arguments
   1314 =========================
   1315 
   1316 The functions and the variables described below allow suffix commands to
   1317 access the value of the transient from which they were invoked; which is
   1318 the value of its infix arguments.  These variables are set when the user
   1319 invokes a suffix command that exits the transient, but before actually
   1320 calling the command.
   1321 
   1322    When returning to the command-loop after calling the suffix command,
   1323 the arguments are reset to ‘nil’ (which causes the function to return
   1324 ‘nil’ too).
   1325 
   1326    Like for Emacs’ prefix arguments, it is advisable, but not mandatory,
   1327 to access the infix arguments inside the command’s ‘interactive’ form.
   1328 The preferred way of doing that is to call the ‘transient-args’
   1329 function, which for infix arguments serves about the same purpose as
   1330 ‘prefix-arg’ serves for prefix arguments.
   1331 
   1332  -- Function: transient-args prefix
   1333      This function returns the value of the transient prefix command
   1334      PREFIX.
   1335 
   1336      If the current command was invoked from the transient prefix
   1337      command PREFIX, then it returns the active infix arguments.  If the
   1338      current command was not invoked from PREFIX, then it returns the
   1339      set, saved or default value for PREFIX.
   1340 
   1341  -- Function: transient-arg-value arg args
   1342      This function return the value of ARG as it appears in ARGS.
   1343 
   1344      For a switch a boolean is returned.  For an option the value is
   1345      returned as a string, using the empty string for the empty value,
   1346      or ‘nil’ if the option does not appear in ARGS.
   1347 
   1348  -- Function: transient-suffixes prefix
   1349      This function returns the suffixes of the transient prefix command
   1350      PREFIX.  This is a list of objects.  This function should only be
   1351      used if you need the objects (as opposed to just their values) and
   1352      if the current command is not being invoked from PREFIX.
   1353 
   1354  -- Variable: transient-current-suffixes
   1355      The suffixes of the transient from which this suffix command was
   1356      invoked.  This is a list of objects.  Usually it is sufficient to
   1357      instead use the function ‘transient-args’, which returns a list of
   1358      values.  In complex cases it might be necessary to use this
   1359      variable instead, i.e., if you need access to information beside
   1360      the value.
   1361 
   1362  -- Variable: transient-current-prefix
   1363      The transient from which this suffix command was invoked.  The
   1364      returned value is a ‘transient-prefix’ object, which holds
   1365      information associated with the transient prefix command.
   1366 
   1367  -- Variable: transient-current-command
   1368      The transient from which this suffix command was invoked.  The
   1369      returned value is a symbol, the transient prefix command.
   1370 
   1371 
   1372 File: transient.info,  Node: Transient State,  Prev: Using Infix Arguments,  Up: Defining New Commands
   1373 
   1374 4.6 Transient State
   1375 ===================
   1376 
   1377 Invoking a transient prefix command “activates” the respective
   1378 transient, i.e., it puts a transient keymap into effect, which binds the
   1379 transient’s infix and suffix commands.
   1380 
   1381    The default behavior while a transient is active is as follows:
   1382 
   1383    • Invoking an infix command does not affect the transient state; the
   1384      transient remains active.
   1385 
   1386    • Invoking a (non-infix) suffix command “deactivates” the transient
   1387      state by removing the transient keymap and performing some
   1388      additional cleanup.
   1389 
   1390    • Invoking a command that is bound in a keymap other than the
   1391      transient keymap is disallowed and trying to do so results in a
   1392      warning.  This does not “deactivate” the transient.
   1393 
   1394    The behavior can be changed for all suffixes of a particular prefix
   1395 and/or for individual suffixes.  The values should nearly always be
   1396 booleans, but certain functions, called “pre-commands”, can also be
   1397 used.  These functions are named ‘transient--do-VERB’, and the symbol
   1398 ‘VERB’ can be used as a shorthand.
   1399 
   1400    A boolean is interpreted as answering the question "does the
   1401 transient stay active, when this command is invoked?"  ‘t’ means that
   1402 the transient stays active, while ‘nil’ means that invoking the command
   1403 exits the transient.
   1404 
   1405    Note that when the suffix is a “sub-prefix”, invoking that command
   1406 always activates that sub-prefix, causing the outer prefix to no longer
   1407 be active and displayed.  Here ‘t’ means that when you exit the inner
   1408 prefix, then the outer prefix becomes active again, while ‘nil’ means
   1409 that all outer prefixes are exited at once.
   1410 
   1411    • The behavior for non-suffixes can be set for a particular prefix,
   1412      by the prefix’s ‘transient-non-suffix’ slot to a boolean, a
   1413      suitable pre-command function, or a shorthand for such a function.
   1414      See *note Pre-commands for Non-Suffixes::.
   1415 
   1416    • The common behavior for the suffixes of a particular prefix can be
   1417      set using the prefix’s ‘transient-suffixes’ slot.
   1418 
   1419      The value specified in this slot does *not* affect infixes.
   1420      Because it affects both regular suffixes as well as sub-prefixes,
   1421      which have different needs, it is best to avoid explicitly
   1422      specifying a function.
   1423 
   1424    • The behavior of an individual suffix can be changed using its
   1425      ‘transient’ slot.  While it is usually best to use a boolean, for
   1426      this slot it can occasionally make sense to specify a function
   1427      explicitly.
   1428 
   1429      Note that this slot can be set when defining a suffix command using
   1430      ‘transient-define-suffix’ and/or in the definition of the prefix.
   1431      If set in both places, then the latter takes precedence, as usual.
   1432 
   1433    The available pre-command functions are documented in the following
   1434 sub-sections.  They are called by ‘transient--pre-command’, a function
   1435 on ‘pre-command-hook’, and the value that they return determines whether
   1436 the transient is exited.  To do so the value of one of the constants
   1437 ‘transient--exit’ or ‘transient--stay’ is used (that way we don’t have
   1438 to remember if ‘t’ means “exit” or “stay”).
   1439 
   1440    Additionally, these functions may change the value of ‘this-command’
   1441 (which explains why they have to be called using ‘pre-command-hook’),
   1442 call ‘transient-export’, ‘transient--stack-zap’ or
   1443 ‘transient--stack-push’; and set the values of ‘transient--exitp’,
   1444 ‘transient--helpp’ or ‘transient--editp’.
   1445 
   1446    For completeness sake, some notes about complications:
   1447 
   1448    • The transient-ness of certain built-in suffix commands is specified
   1449      using ‘transient-predicate-map’.  This is a special keymap, which
   1450      binds commands to pre-commands (as opposed to keys to commands) and
   1451      takes precedence over the prefix’s ‘transient-suffix’ slot, but not
   1452      the suffix’s ‘transient’ slot.
   1453 
   1454    • While a sub-prefix is active we nearly always want ‘C-g’ to take
   1455      the user back to the “super-prefix”, even when the other suffixes
   1456      don’t do that.  However, in rare cases this may not be desirable,
   1457      and that makes the following complication necessary:
   1458 
   1459      For ‘transient-suffix’ objects the ‘transient’ slot is unbound.  We
   1460      can ignore that for the most part because ‘nil’ and the slot being
   1461      unbound are treated as equivalent, and mean “do exit”.  That isn’t
   1462      actually true for suffixes that are sub-prefixes though.  For such
   1463      suffixes unbound means “do exit but allow going back”, which is the
   1464      default, while ‘nil’ means “do exit permanently”, which requires
   1465      that slot to be explicitly set to that value.
   1466 
   1467 Pre-commands for Infixes
   1468 ------------------------
   1469 
   1470 The default for infixes is ‘transient--do-stay’.  This is also the only
   1471 function that makes sense for infixes, which is why this predicate is
   1472 used even if the value of the prefix’s ‘transient-suffix’ slot is ‘t’.
   1473 In extremely rare cases, one might want to use something else, which can
   1474 be done by setting the infix’s ‘transient’ slot directly.
   1475 
   1476  -- Function: transient--do-stay
   1477      Call the command without exporting variables and stay transient.
   1478 
   1479 Pre-commands for Suffixes
   1480 -------------------------
   1481 
   1482 By default, invoking a suffix causes the transient to be exited.
   1483 
   1484    The behavior for an individual suffix command can be changed by
   1485 setting its ‘transient’ slot to a boolean (which is highly recommended),
   1486 or to one of the following pre-commands.
   1487 
   1488  -- Function: transient--do-exit
   1489      Call the command after exporting variables and exit the transient.
   1490 
   1491  -- Function: transient--do-return
   1492      Call the command after exporting variables and return to the parent
   1493      prefix.  If there is no parent prefix, then call
   1494      ‘transient--do-exit’.
   1495 
   1496  -- Function: transient--do-call
   1497      Call the command after exporting variables and stay transient.
   1498 
   1499    The following pre-commands are only suitable for sub-prefixes.  It is
   1500 not necessary to explicitly use these predicates because the correct
   1501 predicate is automatically picked based on the value of the ‘transient’
   1502 slot for the sub-prefix itself.
   1503 
   1504  -- Function: transient--do-recurse
   1505      Call the transient prefix command, preparing for return to active
   1506      transient.
   1507 
   1508      Whether we actually return to the parent transient is ultimately
   1509      under the control of each invoked suffix.  The difference between
   1510      this pre-command and ‘transient--do-stack’ is that it changes the
   1511      value of the ‘transient-suffix’ slot to ‘t’.
   1512 
   1513      If there is no parent transient, then only call this command and
   1514      skip the second step.
   1515 
   1516  -- Function: transient--do-stack
   1517      Call the transient prefix command, stacking the active transient.
   1518      Push the active transient to the transient stack.
   1519 
   1520      Unless ‘transient--do-recurse’ is explicitly used, this pre-command
   1521      is automatically used for suffixes that are prefixes themselves,
   1522      i.e., for sub-prefixes.
   1523 
   1524  -- Function: transient--do-replace
   1525      Call the transient prefix command, replacing the active transient.
   1526      Do not push the active transient to the transient stack.
   1527 
   1528      Unless ‘transient--do-recurse’ is explicitly used, this pre-command
   1529      is automatically used for suffixes that are prefixes themselves,
   1530      i.e., for sub-prefixes.
   1531 
   1532  -- Function: transient--do-suspend
   1533      Suspend the active transient, saving the transient stack.
   1534 
   1535      This is used by the command ‘transient-suspend’ and optionally also
   1536      by “external events” such as ‘handle-switch-frame’.  Such bindings
   1537      should be added to ‘transient-predicate-map’.
   1538 
   1539 Pre-commands for Non-Suffixes
   1540 -----------------------------
   1541 
   1542 By default, non-suffixes (commands that are bound in other keymaps
   1543 beside the transient keymap) cannot be invoked.  Trying to invoke such a
   1544 command results in a warning and the transient stays active.
   1545 
   1546    If you want a different behavior, then set the ‘transient-non-suffix’
   1547 slot of the transient prefix command.  The value should be a boolean,
   1548 answering the question, "is it allowed to invoke non-suffix commands?, a
   1549 pre-command function, or a shorthand for such a function.
   1550 
   1551    If the value is ‘t’, then non-suffixes can be invoked, when it is
   1552 ‘nil’ (the default) then they cannot be invoked.
   1553 
   1554    The only other recommended value is ‘leave’.  If that is used, then
   1555 non-suffixes can be invoked, but if one is invoked, then that exits the
   1556 transient.
   1557 
   1558  -- Function: transient--do-warn
   1559      Call ‘transient-undefined’ and stay transient.
   1560 
   1561  -- Function: transient--do-stay
   1562      Call the command without exporting variables and stay transient.
   1563 
   1564  -- Function: transient--do-leave
   1565      Call the command without exporting variables and exit the
   1566      transient.
   1567 
   1568 Special Pre-Commands
   1569 --------------------
   1570 
   1571  -- Function: transient--do-quit-one
   1572      If active, quit help or edit mode, else exit the active transient.
   1573 
   1574      This is used when the user pressed ‘C-g’.
   1575 
   1576  -- Function: transient--do-quit-all
   1577      Exit all transients without saving the transient stack.
   1578 
   1579      This is used when the user pressed ‘C-q’.
   1580 
   1581  -- Function: transient--do-suspend
   1582      Suspend the active transient, saving the transient stack.
   1583 
   1584      This is used when the user pressed ‘C-z’.
   1585 
   1586 
   1587 File: transient.info,  Node: Classes and Methods,  Next: FAQ,  Prev: Defining New Commands,  Up: Top
   1588 
   1589 5 Classes and Methods
   1590 *********************
   1591 
   1592 Transient uses classes and generic functions to make it possible to
   1593 define new types of suffix commands that are similar to existing types,
   1594 but behave differently in some aspects.  It does the same for groups and
   1595 prefix commands, though at least for prefix commands that *currently*
   1596 appears to be less important.
   1597 
   1598    Every prefix, infix and suffix command is associated with an object,
   1599 which holds information that controls certain aspects of its behavior.
   1600 This happens in two ways.
   1601 
   1602    • Associating a command with a certain class gives the command a
   1603      type.  This makes it possible to use generic functions to do
   1604      certain things that have to be done differently depending on what
   1605      type of command it acts on.
   1606 
   1607      That in turn makes it possible for third-parties to add new types
   1608      without having to convince the maintainer of Transient that that
   1609      new type is important enough to justify adding a special case to a
   1610      dozen or so functions.
   1611 
   1612    • Associating a command with an object makes it possible to easily
   1613      store information that is specific to that particular command.
   1614 
   1615      Two commands may have the same type, but obviously their key
   1616      bindings and descriptions still have to be different, for example.
   1617 
   1618      The values of some slots are functions.  The ‘reader’ slot for
   1619      example holds a function that is used to read a new value for an
   1620      infix command.  The values of such slots are regular functions.
   1621 
   1622      Generic functions are used when a function should do something
   1623      different based on the type of the command, i.e., when all commands
   1624      of a certain type should behave the same way but different from the
   1625      behavior for other types.  Object slots that hold a regular
   1626      function as value are used when the task that they perform is
   1627      likely to differ even between different commands of the same type.
   1628 
   1629 * Menu:
   1630 
   1631 * Group Classes::
   1632 * Group Methods::
   1633 * Prefix Classes::
   1634 * Suffix Classes::
   1635 * Suffix Methods::
   1636 * Prefix Slots::
   1637 * Suffix Slots::
   1638 * Predicate Slots::
   1639 
   1640 
   1641 File: transient.info,  Node: Group Classes,  Next: Group Methods,  Up: Classes and Methods
   1642 
   1643 5.1 Group Classes
   1644 =================
   1645 
   1646 The type of a group can be specified using the ‘:class’ property at the
   1647 beginning of the class specification, e.g., ‘[:class transient-columns
   1648 ...]’ in a call to ‘transient-define-prefix’.
   1649 
   1650    • The abstract ‘transient-child’ class is the base class of both
   1651      ‘transient-group’ (and therefore all groups) as well as of
   1652      ‘transient-suffix’ (and therefore all suffix and infix commands).
   1653 
   1654      This class exists because the elements (or “children”) of certain
   1655      groups can be other groups instead of suffix and infix commands.
   1656 
   1657    • The abstract ‘transient-group’ class is the superclass of all other
   1658      group classes.
   1659 
   1660    • The ‘transient-column’ class is the simplest group.
   1661 
   1662      This is the default “flat” group.  If the class is not specified
   1663      explicitly and the first element is not a vector (i.e., not a
   1664      group), then this class is used.
   1665 
   1666      This class displays each element on a separate line.
   1667 
   1668    • The ‘transient-row’ class displays all elements on a single line.
   1669 
   1670    • The ‘transient-columns’ class displays commands organized in
   1671      columns.
   1672 
   1673      Direct elements have to be groups whose elements have to be
   1674      commands or strings.  Each subgroup represents a column.  This
   1675      class takes care of inserting the subgroups’ elements.
   1676 
   1677      This is the default “nested” group.  If the class is not specified
   1678      explicitly and the first element is a vector (i.e., a group), then
   1679      this class is used.
   1680 
   1681    • The ‘transient-subgroups’ class wraps other groups.
   1682 
   1683      Direct elements have to be groups whose elements have to be
   1684      commands or strings.  This group inserts an empty line between
   1685      subgroups.  The subgroups themselves are responsible for displaying
   1686      their elements.
   1687 
   1688 
   1689 File: transient.info,  Node: Group Methods,  Next: Prefix Classes,  Prev: Group Classes,  Up: Classes and Methods
   1690 
   1691 5.2 Group Methods
   1692 =================
   1693 
   1694  -- Function: transient-setup-children group children
   1695      This generic function can be used to setup the children or a group.
   1696 
   1697      The default implementation usually just returns the children
   1698      unchanged, but if the ‘setup-children’ slot of GROUP is non-‘nil’,
   1699      then it calls that function with CHILDREN as the only argument and
   1700      returns the value.
   1701 
   1702      The children are given as a (potentially empty) list consisting of
   1703      either group or suffix specifications.  These functions can make
   1704      arbitrary changes to the children including constructing new
   1705      children from scratch.
   1706 
   1707  -- Function: transient--insert-group group
   1708      This generic function formats the group and its elements and
   1709      inserts the result into the current buffer, which is a temporary
   1710      buffer.  The contents of that buffer are later inserted into the
   1711      popup buffer.
   1712 
   1713      Functions that are called by this function may need to operate in
   1714      the buffer from which the transient was called.  To do so they can
   1715      temporarily make the ‘transient--source-buffer’ the current buffer.
   1716 
   1717 
   1718 File: transient.info,  Node: Prefix Classes,  Next: Suffix Classes,  Prev: Group Methods,  Up: Classes and Methods
   1719 
   1720 5.3 Prefix Classes
   1721 ==================
   1722 
   1723 Currently the ‘transient-prefix’ class is being used for all prefix
   1724 commands and there is only a single generic function that can be
   1725 specialized based on the class of a prefix command.
   1726 
   1727  -- Function: transient--history-init obj
   1728      This generic function is called while setting up the transient and
   1729      is responsible for initializing the ‘history’ slot.  This is the
   1730      transient-wide history; many individual infixes also have a history
   1731      of their own.
   1732 
   1733      The default (and currently only) method extracts the value from the
   1734      global variable ‘transient-history’.
   1735 
   1736    A transient prefix command’s object is stored in the
   1737 ‘transient--prefix’ property of the command symbol.  While a transient
   1738 is active, a clone of that object is stored in the variable
   1739 ‘transient--prefix’.  A clone is used because some changes that are made
   1740 to the active transient’s object should not affect later invocations.
   1741 
   1742 
   1743 File: transient.info,  Node: Suffix Classes,  Next: Suffix Methods,  Prev: Prefix Classes,  Up: Classes and Methods
   1744 
   1745 5.4 Suffix Classes
   1746 ==================
   1747 
   1748    • All suffix and infix classes derive from ‘transient-suffix’, which
   1749      in turn derives from ‘transient-child’, from which
   1750      ‘transient-group’ also derives (see *note Group Classes::).
   1751 
   1752    • All infix classes derive from the abstract ‘transient-infix’ class,
   1753      which in turn derives from the ‘transient-suffix’ class.
   1754 
   1755      Infixes are a special type of suffixes.  The primary difference is
   1756      that infixes always use the ‘transient--do-stay’ pre-command, while
   1757      non-infix suffixes use a variety of pre-commands (see *note
   1758      Transient State::).  Doing that is most easily achieved by using
   1759      this class, though theoretically it would be possible to define an
   1760      infix class that does not do so.  If you do that then you get to
   1761      implement many methods.
   1762 
   1763      Also, infixes and non-infix suffixes are usually defined using
   1764      different macros (see *note Defining Suffix and Infix Commands::).
   1765 
   1766    • Classes used for infix commands that represent arguments should be
   1767      derived from the abstract ‘transient-argument’ class.
   1768 
   1769    • The ‘transient-switch’ class (or a derived class) is used for infix
   1770      arguments that represent command-line switches (arguments that do
   1771      not take a value).
   1772 
   1773    • The ‘transient-option’ class (or a derived class) is used for infix
   1774      arguments that represent command-line options (arguments that do
   1775      take a value).
   1776 
   1777    • The ‘transient-switches’ class can be used for a set of mutually
   1778      exclusive command-line switches.
   1779 
   1780    • The ‘transient-files’ class can be used for a ‘--’ argument that
   1781      indicates that all remaining arguments are files.
   1782 
   1783    • Classes used for infix commands that represent variables should
   1784      derived from the abstract ‘transient-variable’ class.
   1785 
   1786    • The ‘transient-information’ class is special in that suffixes that
   1787      use this class are not associated with a command and thus also not
   1788      with any key binding.  Such suffixes are only used to display
   1789      arbitrary information, and that anywhere a suffix can appear.
   1790      Display-only suffix specifications take this form:
   1791 
   1792           ([LEVEL] :info DESCRIPTION [KEYWORD VALUE]...)
   1793 
   1794      The ‘:info’ keyword argument replaces the ‘:description’ keyword
   1795      used for other suffix classes.  Other keyword arguments that you
   1796      might want to set, include ‘:face’, predicate keywords (such as
   1797      ‘:if’), and ‘:format’.  By default the value of ‘:format’ includes
   1798      ‘%k’, which for this class is replaced with the empty string or
   1799      spaces, if keys are being padded in the containing group.
   1800 
   1801    Magit defines additional classes, which can serve as examples for the
   1802 fancy things you can do without modifying Transient.  Some of these
   1803 classes will likely get generalized and added to Transient.  For now
   1804 they are very much subject to change and not documented.
   1805 
   1806 
   1807 File: transient.info,  Node: Suffix Methods,  Next: Prefix Slots,  Prev: Suffix Classes,  Up: Classes and Methods
   1808 
   1809 5.5 Suffix Methods
   1810 ==================
   1811 
   1812 To get information about the methods implementing these generic
   1813 functions use ‘describe-function’.
   1814 
   1815 * Menu:
   1816 
   1817 * Suffix Value Methods::
   1818 * Suffix Format Methods::
   1819 
   1820 
   1821 File: transient.info,  Node: Suffix Value Methods,  Next: Suffix Format Methods,  Up: Suffix Methods
   1822 
   1823 5.5.1 Suffix Value Methods
   1824 --------------------------
   1825 
   1826  -- Function: transient-init-value obj
   1827      This generic function sets the initial value of the object OBJ.
   1828 
   1829      This function is called for all suffix commands, but unless a
   1830      concrete method is implemented this falls through to the default
   1831      implementation, which is a noop.  In other words this usually only
   1832      does something for infix commands, but note that this is not
   1833      implemented for the abstract class ‘transient-infix’, so if your
   1834      class derives from that directly, then you must implement a method.
   1835 
   1836  -- Function: transient-infix-read obj
   1837      This generic function determines the new value of the infix object
   1838      OBJ.
   1839 
   1840      This function merely determines the value; ‘transient-infix-set’ is
   1841      used to actually store the new value in the object.
   1842 
   1843      For most infix classes this is done by reading a value from the
   1844      user using the reader specified by the ‘reader’ slot (using the
   1845      ‘transient-infix-value’ method described below).
   1846 
   1847      For some infix classes the value is changed without reading
   1848      anything in the minibuffer, i.e., the mere act of invoking the
   1849      infix command determines what the new value should be, based on the
   1850      previous value.
   1851 
   1852  -- Function: transient-prompt obj
   1853      This generic function returns the prompt to be used to read infix
   1854      object OBJ’s value.
   1855 
   1856  -- Function: transient-infix-set obj value
   1857      This generic function sets the value of infix object OBJ to VALUE.
   1858 
   1859  -- Function: transient-infix-value obj
   1860      This generic function returns the value of the suffix object OBJ.
   1861 
   1862      This function is called by ‘transient-args’ (which see), meaning
   1863      this function is how the value of a transient is determined so that
   1864      the invoked suffix command can use it.
   1865 
   1866      Currently most values are strings, but that is not set in stone.
   1867      ‘nil’ is not a value, it means “no value”.
   1868 
   1869      Usually only infixes have a value, but see the method for
   1870      ‘transient-suffix’.
   1871 
   1872  -- Function: transient-init-scope obj
   1873      This generic function sets the scope of the suffix object OBJ.
   1874 
   1875      The scope is actually a property of the transient prefix, not of
   1876      individual suffixes.  However it is possible to invoke a suffix
   1877      command directly instead of from a transient.  In that case, if the
   1878      suffix expects a scope, then it has to determine that itself and
   1879      store it in its ‘scope’ slot.
   1880 
   1881      This function is called for all suffix commands, but unless a
   1882      concrete method is implemented this falls through to the default
   1883      implementation, which is a noop.
   1884 
   1885 
   1886 File: transient.info,  Node: Suffix Format Methods,  Prev: Suffix Value Methods,  Up: Suffix Methods
   1887 
   1888 5.5.2 Suffix Format Methods
   1889 ---------------------------
   1890 
   1891  -- Function: transient-format obj
   1892      This generic function formats and returns OBJ for display.
   1893 
   1894      When this function is called, then the current buffer is some
   1895      temporary buffer.  If you need the buffer from which the prefix
   1896      command was invoked to be current, then do so by temporarily making
   1897      ‘transient--source-buffer’ current.
   1898 
   1899  -- Function: transient-format-key obj
   1900      This generic function formats OBJ’s ‘key’ for display and returns
   1901      the result.
   1902 
   1903  -- Function: transient-format-description obj
   1904      This generic function formats OBJ’s ‘description’ for display and
   1905      returns the result.
   1906 
   1907  -- Function: transient-format-value obj
   1908      This generic function formats OBJ’s value for display and returns
   1909      the result.
   1910 
   1911  -- Function: transient-show-help obj
   1912      Show help for the prefix, infix or suffix command represented by
   1913      OBJ.
   1914 
   1915      For prefixes, show the info manual, if that is specified using the
   1916      ‘info-manual’ slot.  Otherwise, show the manpage if that is
   1917      specified using the ‘man-page’ slot.  Otherwise, show the command’s
   1918      documentation string.
   1919 
   1920      For suffixes, show the command’s documentation string.
   1921 
   1922      For infixes, show the manpage if that is specified.  Otherwise show
   1923      the command’s documentation string.
   1924 
   1925 
   1926 File: transient.info,  Node: Prefix Slots,  Next: Suffix Slots,  Prev: Suffix Methods,  Up: Classes and Methods
   1927 
   1928 5.6 Prefix Slots
   1929 ================
   1930 
   1931    • ‘show-help’, ‘man-page’ or ‘info-manual’ can be used to specify the
   1932      documentation for the prefix and its suffixes.  The command
   1933      ‘transient-help’ uses the method ‘transient-show-help’ (which see)
   1934      to lookup and use these values.
   1935 
   1936    • ‘history-key’ If multiple prefix commands should share a single
   1937      value, then this slot has to be set to the same value for all of
   1938      them.  You probably don’t want that.
   1939 
   1940    • ‘transient-suffix’ and ‘transient-non-suffix’ play a part when
   1941      determining whether the currently active transient prefix command
   1942      remains active/transient when a suffix or arbitrary non-suffix
   1943      command is invoked.  See *note Transient State::.
   1944 
   1945    • ‘refresh-suffixes’ Normally suffix objects and keymaps are only
   1946      setup once, when the prefix is invoked.  Setting this to ‘t’,
   1947      causes them to be recreated after every command.  This is useful
   1948      when using ‘:if...’ predicates, and those need to be rerun for some
   1949      reason.  Doing this is somewhat costly, and there is a risk of
   1950      losing state, so this is disabled by default and still considered
   1951      experimental.
   1952 
   1953    • ‘incompatible’ A list of lists.  Each sub-list specifies a set of
   1954      mutually exclusive arguments.  Enabling one of these arguments
   1955      causes the others to be disabled.  An argument may appear in
   1956      multiple sub-lists.  Arguments must me given in the same form as
   1957      used in the ‘argument’ or ‘argument-format’ slot of the respective
   1958      suffix objects, usually something like ‘--switch’ or ‘--option=%s’.
   1959      For options and ‘transient-switches’ suffixes it is also possible
   1960      to match against a specific value, as returned by
   1961      ‘transient-infix-value’, for example, ‘--option=one’.
   1962 
   1963    • ‘scope’ For some transients it might be necessary to have a sort of
   1964      secondary value, called a “scope”.  See ‘transient-define-prefix’.
   1965 
   1966 Internal Prefix Slots
   1967 ---------------------
   1968 
   1969 These slots are mostly intended for internal use.  They should not be
   1970 set in calls to ‘transient-define-prefix’.
   1971 
   1972    • ‘prototype’ When a transient prefix command is invoked, then a
   1973      clone of that object is stored in the global variable
   1974      ‘transient--prefix’ and the prototype is stored in the clone’s
   1975      ‘prototype’ slot.
   1976 
   1977    • ‘command’ The command, a symbol.  Each transient prefix command
   1978      consists of a command, which is stored in a symbol’s function slot
   1979      and an object, which is stored in the ‘transient--prefix’ property
   1980      of the same symbol.
   1981 
   1982    • ‘level’ The level of the prefix commands.  The suffix commands
   1983      whose layer is equal or lower are displayed.  See *note Enabling
   1984      and Disabling Suffixes::.
   1985 
   1986    • ‘value’ The likely outdated value of the prefix.  Instead of
   1987      accessing this slot directly you should use the function
   1988      ‘transient-get-value’, which is guaranteed to return the up-to-date
   1989      value.
   1990 
   1991    • ‘history’ and ‘history-pos’ are used to keep track of historic
   1992      values.  Unless you implement your own ‘transient-infix-read’
   1993      method you should not have to deal with these slots.
   1994 
   1995 
   1996 File: transient.info,  Node: Suffix Slots,  Next: Predicate Slots,  Prev: Prefix Slots,  Up: Classes and Methods
   1997 
   1998 5.7 Suffix Slots
   1999 ================
   2000 
   2001 Here we document most of the slots that are only available for suffix
   2002 objects.  Some slots are shared by suffix and group objects, they are
   2003 documented in *note Predicate Slots::.
   2004 
   2005    Also see *note Suffix Classes::.
   2006 
   2007 Slots of ‘transient-suffix’
   2008 ---------------------------
   2009 
   2010    • ‘key’ The key, a key vector or a key description string.
   2011 
   2012    • ‘command’ The command, a symbol.
   2013 
   2014    • ‘transient’ Whether to stay transient.  See *note Transient
   2015      State::.
   2016 
   2017    • ‘format’ The format used to display the suffix in the popup buffer.
   2018      It must contain the following %-placeholders:
   2019 
   2020         • ‘%k’ For the key.
   2021         • ‘%d’ For the description.
   2022         • ‘%v’ For the infix value.  Non-infix suffixes don’t have a
   2023           value.
   2024 
   2025    • ‘description’ The description, either a string or a function, which
   2026      is called with zero or one argument (the suffix object), and
   2027      returns a string.
   2028 
   2029    • ‘face’ Face used for the description.  In simple cases it is easier
   2030      to use this instead of using a function as ‘description’ and adding
   2031      the styling there.  ‘face’ is appended using
   2032      ‘add-face-text-property’.
   2033 
   2034    • ‘show-help’ A function used to display help for the suffix.  If
   2035      unspecified, the prefix controls how help is displayed for its
   2036      suffixes.
   2037 
   2038 Slots of ‘transient-infix’
   2039 --------------------------
   2040 
   2041 Some of these slots are only meaningful for some of the subclasses.
   2042 They are defined here anyway to allow sharing certain methods.
   2043 
   2044    • ‘argument’ The long argument, e.g., ‘--verbose’.
   2045 
   2046    • ‘shortarg’ The short argument, e.g., ‘-v’.
   2047 
   2048    • ‘value’ The value.  Should not be accessed directly.
   2049 
   2050    • ‘init-value’ Function that is responsible for setting the object’s
   2051      value.  If bound, then this is called with the object as the only
   2052      argument.  Usually this is not bound, in which case the object’s
   2053      primary ‘transient-init-value’ method is called instead.
   2054 
   2055    • ‘unsavable’ Whether the value of the suffix is not saved as part of
   2056      the prefixes.
   2057 
   2058    • ‘multi-value’ For options, whether the option can have multiple
   2059      values.  If this is non-‘nil’, then the values are read using
   2060      ‘completing-read-multiple’ by default and if you specify your own
   2061      reader, then it should read the values using that function or
   2062      similar.
   2063 
   2064      Supported non-‘nil’ values are:
   2065 
   2066         • Use ‘rest’ for an option that can have multiple values.  This
   2067           is useful e.g., for an ‘--’ argument that indicates that all
   2068           remaining arguments are files (such as ‘git log -- file1
   2069           file2’).
   2070 
   2071           In the list returned by ‘transient-args’ such an option and
   2072           its values are represented by a single list of the form
   2073           ‘(ARGUMENT . VALUES)’.
   2074 
   2075         • Use ‘repeat’ for an option that can be specified multiple
   2076           times.
   2077 
   2078           In the list returned by ‘transient-args’ each instance of the
   2079           option and its value appears separately in the usual from, for
   2080           example: ‘("--another-argument" "--option=first"
   2081           "--option=second")’.
   2082 
   2083      In both cases the option’s values have to be specified in the
   2084      default value of a prefix using the same format as returned by
   2085      ‘transient-args’, e.g., ‘("--other" "--o=1" "--o=2" ("--" "f1"
   2086      "f2"))’.
   2087 
   2088    • ‘always-read’ For options, whether to read a value on every
   2089      invocation.  If this is ‘nil’, then options that have a value are
   2090      simply unset and have to be invoked a second time to set a new
   2091      value.
   2092 
   2093    • ‘allow-empty’ For options, whether the empty string is a valid
   2094      value.
   2095 
   2096    • ‘history-key’ The key used to store the history.  This defaults to
   2097      the command name.  This is useful when multiple infixes should
   2098      share the same history because their values are of the same kind.
   2099 
   2100    • ‘reader’ The function used to read the value of an infix.  Not used
   2101      for switches.  The function takes three arguments, PROMPT,
   2102      INITIAL-INPUT and HISTORY, and must return a string.
   2103 
   2104    • ‘prompt’ The prompt used when reading the value, either a string or
   2105      a function that takes the object as the only argument and which
   2106      returns a prompt string.
   2107 
   2108    • ‘choices’ A list of valid values, or a function that returns such a
   2109      list.  The latter is not implemented for ‘transient-switches’,
   2110      because I couldn’t think of a use-case.  How exactly the choices
   2111      are used varies depending on the class of the suffix.
   2112 
   2113 Slots of ‘transient-variable’
   2114 -----------------------------
   2115 
   2116    • ‘variable’ The variable.
   2117 
   2118 Slots of ‘transient-switches’
   2119 -----------------------------
   2120 
   2121    • ‘argument-format’ The display format.  Must contain ‘%s’, one of
   2122      the ‘choices’ is substituted for that.  E.g., ‘--%s-order’.
   2123 
   2124    • ‘argument-regexp’ The regexp used to match any one of the switches.
   2125      E.g., ‘\\(--\\(topo\\|author-date\\|date\\)-order\\)’.
   2126 
   2127 
   2128 File: transient.info,  Node: Predicate Slots,  Prev: Suffix Slots,  Up: Classes and Methods
   2129 
   2130 5.8 Predicate Slots
   2131 ===================
   2132 
   2133 Suffix and group objects share some predicate slots that control whether
   2134 a group or suffix should be available depending on some state.  Only one
   2135 of these slots can be used at the same time.  It is undefined what
   2136 happens if you use more than one.
   2137 
   2138    • ‘if’ Enable if predicate returns non-‘nil’.
   2139    • ‘if-not’ Enable if predicate returns ‘nil’.
   2140    • ‘if-non-nil’ Enable if variable’s value is non-‘nil’.
   2141    • ‘if-nil’ Enable if variable’s value is ‘nil’.
   2142    • ‘if-mode’ Enable if major-mode matches value.
   2143    • ‘if-not-mode’ Enable if major-mode does not match value.
   2144    • ‘if-derived’ Enable if major-mode derives from value.
   2145    • ‘if-not-derived’ Enable if major-mode does not derive from value.
   2146 
   2147    By default these predicates run when the prefix command is invoked,
   2148 but this can be changes, using the ‘refresh-suffixes’ prefix slot.  See
   2149 *note Prefix Slots::.
   2150 
   2151    One more slot is shared between group and suffix classes, ‘level’.
   2152 Like the slots documented above, it is a predicate, but it is used for a
   2153 different purpose.  The value has to be an integer between 1 and 7.
   2154 ‘level’ controls whether a suffix or a group should be available
   2155 depending on user preference.  See *note Enabling and Disabling
   2156 Suffixes::.
   2157 
   2158 
   2159 File: transient.info,  Node: FAQ,  Next: Keystroke Index,  Prev: Classes and Methods,  Up: Top
   2160 
   2161 Appendix A FAQ
   2162 **************
   2163 
   2164 A.1 Can I control how the popup buffer is displayed?
   2165 ====================================================
   2166 
   2167 Yes, see ‘transient-display-buffer-action’ in *note Configuration::.
   2168 
   2169 A.2 How can I copy text from the popup buffer?
   2170 ==============================================
   2171 
   2172 To be able to mark text in Transient’s popup buffer using the mouse, you
   2173 have to add the below binding.  Note that for technical reasons, the
   2174 region won’t be visualized, while doing so.  After you have quit the
   2175 transient popup, you will be able to yank it in another buffer.
   2176 
   2177      (keymap-set transient-predicate-map
   2178                  "<mouse-set-region>"
   2179                  #'transient--do-stay)
   2180 
   2181 A.3 How can I autoload prefix and suffix commands?
   2182 ==================================================
   2183 
   2184 If your package only supports Emacs 30, just prefix the definition with
   2185 ‘;;;###autoload’.  If your package supports released versions of Emacs,
   2186 you unfortunately have to use a long form autoload comment as described
   2187 in *note (elisp)Autoload::.
   2188 
   2189      ;;;###autoload (autoload 'magit-dispatch "magit" nil t)
   2190      (transient-define-prefix magit-dispatch ()
   2191        ...)
   2192 
   2193 A.4 How does Transient compare to prefix keys and universal arguments?
   2194 ======================================================================
   2195 
   2196 See
   2197 <https://github.com/magit/transient/wiki/Comparison-with-prefix-keys-and-universal-arguments>.
   2198 
   2199 A.5 How does Transient compare to Magit-Popup and Hydra?
   2200 ========================================================
   2201 
   2202 See
   2203 <https://github.com/magit/transient/wiki/Comparison-with-other-packages>.
   2204 
   2205 A.6 Why did some of the key bindings change?
   2206 ============================================
   2207 
   2208 You may have noticed that the bindings for some of the common commands
   2209 do *not* have the prefix ‘C-x’ and that furthermore some of these
   2210 commands are grayed out while others are not.  That unfortunately is a
   2211 bit confusing if the section of common commands is not shown
   2212 permanently, making the following explanation necessary.
   2213 
   2214    The purpose of usually hiding that section but showing it after the
   2215 user pressed the respective prefix key is to conserve space and not
   2216 overwhelm users with too much noise, while allowing the user to quickly
   2217 list common bindings on demand.
   2218 
   2219    That however should not keep us from using the best possible key
   2220 bindings.  The bindings that do use a prefix do so to avoid wasting too
   2221 many non-prefix bindings, keeping them available for use in individual
   2222 transients.  The bindings that do not use a prefix and that are *not*
   2223 grayed out are very important bindings that are *always* available, even
   2224 when invoking the “common command key prefix” or *any other*
   2225 transient-specific prefix.  The non-prefix keys that *are* grayed out
   2226 however, are not available when any incomplete prefix key sequence is
   2227 active.  They do not use the “common command key prefix” because it is
   2228 likely that users want to invoke them several times in a row and e.g.,
   2229 ‘M-p M-p M-p’ is much more convenient than ‘C-x M-p C-x M-p C-x M-p’.
   2230 
   2231    You may also have noticed that the “Set” command is bound to ‘C-x s’,
   2232 while Magit-Popup used to bind ‘C-c C-c’ instead.  I have seen several
   2233 users praise the latter binding (sic), so I did not change it
   2234 willy-nilly.  The reason that I changed it is that using different
   2235 prefix keys for different common commands, would have made the temporary
   2236 display of the common commands even more confusing, i.e., after pressing
   2237 ‘C-c’ all the bindings that begin with the ‘C-x’ prefix would be grayed
   2238 out.
   2239 
   2240    Using a single prefix for common commands key means that all other
   2241 potential prefix keys can be used for transient-specific commands
   2242 *without* the section of common commands also popping up.  ‘C-c’ in
   2243 particular is a prefix that I want to (and already do) use for Magit,
   2244 and also using that for a common command would prevent me from doing so.
   2245 
   2246    (Also see the next question.)
   2247 
   2248 A.7 Why does ‘q’ not quit popups anymore?
   2249 =========================================
   2250 
   2251 I agree that ‘q’ is a good binding for commands that quit something.
   2252 This includes quitting whatever transient is currently active, but it
   2253 also includes quitting whatever it is that some specific transient is
   2254 controlling.  The transient ‘magit-blame’ for example binds ‘q’ to the
   2255 command that turns ‘magit-blame-mode’ off.
   2256 
   2257    So I had to decide if ‘q’ should quit the active transient (like
   2258 Magit-Popup used to) or whether ‘C-g’ should do that instead, so that
   2259 ‘q’ could be bound in individual transient to whatever commands make
   2260 sense for them.  Because all other letters are already reserved for use
   2261 by individual transients, I have decided to no longer make an exception
   2262 for ‘q’.
   2263 
   2264    If you want to get ‘q’’s old binding back then you can do so.  Doing
   2265 that is a bit more complicated than changing a single key binding, so I
   2266 have implemented a function, ‘transient-bind-q-to-quit’ that makes the
   2267 necessary changes.  See its documentation string for more information.
   2268 
   2269 
   2270 File: transient.info,  Node: Keystroke Index,  Next: Command and Function Index,  Prev: FAQ,  Up: Top
   2271 
   2272 Appendix B Keystroke Index
   2273 **************************
   2274 
   2275 
   2276 * Menu:
   2277 
   2278 * C-g:                                   Aborting and Resuming Transients.
   2279                                                                (line 27)
   2280 * C-g <1>:                               Aborting and Resuming Transients.
   2281                                                                (line 27)
   2282 * C-h:                                   Getting Help for Suffix Commands.
   2283                                                                (line 11)
   2284 * C-M-n:                                 Using History.        (line 18)
   2285 * C-M-p:                                 Using History.        (line 13)
   2286 * C-q:                                   Aborting and Resuming Transients.
   2287                                                                (line 36)
   2288 * C-x a:                                 Enabling and Disabling Suffixes.
   2289                                                                (line 68)
   2290 * C-x C-k:                               Saving Values.        (line 29)
   2291 * C-x C-s:                               Saving Values.        (line 25)
   2292 * C-x l:                                 Enabling and Disabling Suffixes.
   2293                                                                (line 43)
   2294 * C-x n:                                 Using History.        (line 18)
   2295 * C-x p:                                 Using History.        (line 13)
   2296 * C-x s:                                 Saving Values.        (line 21)
   2297 * C-x t:                                 Common Suffix Commands.
   2298                                                                (line 18)
   2299 * C-z:                                   Aborting and Resuming Transients.
   2300                                                                (line 41)
   2301 
   2302 
   2303 File: transient.info,  Node: Command and Function Index,  Next: Variable Index,  Prev: Keystroke Index,  Up: Top
   2304 
   2305 Appendix C Command and Function Index
   2306 *************************************
   2307 
   2308 
   2309 * Menu:
   2310 
   2311 * transient--do-call:                    Transient State.     (line 125)
   2312 * transient--do-exit:                    Transient State.     (line 117)
   2313 * transient--do-leave:                   Transient State.     (line 193)
   2314 * transient--do-quit-all:                Transient State.     (line 205)
   2315 * transient--do-quit-one:                Transient State.     (line 200)
   2316 * transient--do-recurse:                 Transient State.     (line 133)
   2317 * transient--do-replace:                 Transient State.     (line 153)
   2318 * transient--do-return:                  Transient State.     (line 120)
   2319 * transient--do-stack:                   Transient State.     (line 145)
   2320 * transient--do-stay:                    Transient State.     (line 105)
   2321 * transient--do-stay <1>:                Transient State.     (line 190)
   2322 * transient--do-suspend:                 Transient State.     (line 161)
   2323 * transient--do-suspend <1>:             Transient State.     (line 210)
   2324 * transient--do-warn:                    Transient State.     (line 187)
   2325 * transient--history-init:               Prefix Classes.      (line  10)
   2326 * transient--insert-group:               Group Methods.       (line  19)
   2327 * transient-append-suffix:               Modifying Existing Transients.
   2328                                                               (line  51)
   2329 * transient-arg-value:                   Using Infix Arguments.
   2330                                                               (line  31)
   2331 * transient-args:                        Using Infix Arguments.
   2332                                                               (line  22)
   2333 * transient-define-argument:             Defining Suffix and Infix Commands.
   2334                                                               (line  57)
   2335 * transient-define-infix:                Defining Suffix and Infix Commands.
   2336                                                               (line  26)
   2337 * transient-define-prefix:               Defining Transients. (line  13)
   2338 * transient-define-suffix:               Defining Suffix and Infix Commands.
   2339                                                               (line   9)
   2340 * transient-format:                      Suffix Format Methods.
   2341                                                               (line   6)
   2342 * transient-format-description:          Suffix Format Methods.
   2343                                                               (line  18)
   2344 * transient-format-key:                  Suffix Format Methods.
   2345                                                               (line  14)
   2346 * transient-format-value:                Suffix Format Methods.
   2347                                                               (line  22)
   2348 * transient-get-suffix:                  Modifying Existing Transients.
   2349                                                               (line  73)
   2350 * transient-help:                        Getting Help for Suffix Commands.
   2351                                                               (line  11)
   2352 * transient-history-next:                Using History.       (line  18)
   2353 * transient-history-prev:                Using History.       (line  13)
   2354 * transient-infix-read:                  Suffix Value Methods.
   2355                                                               (line  16)
   2356 * transient-infix-set:                   Suffix Value Methods.
   2357                                                               (line  36)
   2358 * transient-infix-value:                 Suffix Value Methods.
   2359                                                               (line  39)
   2360 * transient-init-scope:                  Suffix Value Methods.
   2361                                                               (line  52)
   2362 * transient-init-value:                  Suffix Value Methods.
   2363                                                               (line   6)
   2364 * transient-insert-suffix:               Modifying Existing Transients.
   2365                                                               (line  49)
   2366 * transient-prompt:                      Suffix Value Methods.
   2367                                                               (line  32)
   2368 * transient-quit-all:                    Aborting and Resuming Transients.
   2369                                                               (line  36)
   2370 * transient-quit-one:                    Aborting and Resuming Transients.
   2371                                                               (line  27)
   2372 * transient-quit-seq:                    Aborting and Resuming Transients.
   2373                                                               (line  27)
   2374 * transient-remove-suffix:               Modifying Existing Transients.
   2375                                                               (line  70)
   2376 * transient-replace-suffix:              Modifying Existing Transients.
   2377                                                               (line  66)
   2378 * transient-reset:                       Saving Values.       (line  29)
   2379 * transient-resume:                      Aborting and Resuming Transients.
   2380                                                               (line  53)
   2381 * transient-save:                        Saving Values.       (line  25)
   2382 * transient-scroll-down:                 Other Commands.      (line  17)
   2383 * transient-scroll-up:                   Other Commands.      (line  12)
   2384 * transient-set:                         Saving Values.       (line  21)
   2385 * transient-set-level:                   Enabling and Disabling Suffixes.
   2386                                                               (line  43)
   2387 * transient-setup-children:              Group Methods.       (line   6)
   2388 * transient-show-help:                   Suffix Format Methods.
   2389                                                               (line  26)
   2390 * transient-suffix-put:                  Modifying Existing Transients.
   2391                                                               (line  77)
   2392 * transient-suffixes:                    Using Infix Arguments.
   2393                                                               (line  38)
   2394 * transient-suspend:                     Aborting and Resuming Transients.
   2395                                                               (line  41)
   2396 * transient-toggle-common:               Common Suffix Commands.
   2397                                                               (line  18)
   2398 * transient-toggle-level-limit:          Enabling and Disabling Suffixes.
   2399                                                               (line  68)
   2400 
   2401 
   2402 File: transient.info,  Node: Variable Index,  Next: Concept Index,  Prev: Command and Function Index,  Up: Top
   2403 
   2404 Appendix D Variable Index
   2405 *************************
   2406 
   2407 
   2408 * Menu:
   2409 
   2410 * transient-align-variable-pitch:        Configuration.       (line 185)
   2411 * transient-current-command:             Using Infix Arguments.
   2412                                                               (line  57)
   2413 * transient-current-prefix:              Using Infix Arguments.
   2414                                                               (line  52)
   2415 * transient-current-suffixes:            Using Infix Arguments.
   2416                                                               (line  44)
   2417 * transient-default-level:               Enabling and Disabling Suffixes.
   2418                                                               (line  33)
   2419 * transient-detect-key-conflicts:        Configuration.       (line 210)
   2420 * transient-display-buffer-action:       Configuration.       (line  51)
   2421 * transient-enable-popup-navigation:     Configuration.       (line  36)
   2422 * transient-force-fixed-pitch:           Configuration.       (line 198)
   2423 * transient-force-single-column:         Configuration.       (line  93)
   2424 * transient-hide-during-minibuffer-read: Configuration.       (line 181)
   2425 * transient-highlight-higher-levels:     Configuration.       (line 223)
   2426 * transient-highlight-mismatched-keys:   Configuration.       (line 135)
   2427 * transient-history-file:                Using History.       (line  33)
   2428 * transient-history-limit:               Using History.       (line  37)
   2429 * transient-levels-file:                 Enabling and Disabling Suffixes.
   2430                                                               (line  38)
   2431 * transient-mode-line-format:            Configuration.       (line 102)
   2432 * transient-read-with-initial-input:     Configuration.       (line 174)
   2433 * transient-semantic-coloring:           Configuration.       (line 126)
   2434 * transient-show-common-commands:        Common Suffix Commands.
   2435                                                               (line  23)
   2436 * transient-show-popup:                  Configuration.       (line  15)
   2437 * transient-substitute-key-function:     Configuration.       (line 153)
   2438 * transient-values-file:                 Saving Values.       (line  31)
   2439 
   2440 
   2441 File: transient.info,  Node: Concept Index,  Next: GNU General Public License,  Prev: Variable Index,  Up: Top
   2442 
   2443 Appendix E Concept Index
   2444 ************************
   2445 
   2446 
   2447 * Menu:
   2448 
   2449 * aborting transients:                   Aborting and Resuming Transients.
   2450                                                                (line  6)
   2451 * classes and methods:                   Classes and Methods.  (line  6)
   2452 * command dispatchers:                   Technical Introduction.
   2453                                                                (line 39)
   2454 * common suffix commands:                Common Suffix Commands.
   2455                                                                (line  6)
   2456 * defining infix commands:               Defining Suffix and Infix Commands.
   2457                                                                (line  6)
   2458 * defining suffix commands:              Defining Suffix and Infix Commands.
   2459                                                                (line  6)
   2460 * disabling suffixes:                    Enabling and Disabling Suffixes.
   2461                                                                (line  6)
   2462 * enabling suffixes:                     Enabling and Disabling Suffixes.
   2463                                                                (line  6)
   2464 * getting help:                          Getting Help for Suffix Commands.
   2465                                                                (line  6)
   2466 * group specifications:                  Group Specifications. (line  6)
   2467 * invoking transients:                   Invoking Transients.  (line  6)
   2468 * levels:                                Enabling and Disabling Suffixes.
   2469                                                                (line 10)
   2470 * modifying existing transients:         Modifying Existing Transients.
   2471                                                                (line  6)
   2472 * quit transient:                        Aborting and Resuming Transients.
   2473                                                                (line  6)
   2474 * resuming transients:                   Aborting and Resuming Transients.
   2475                                                                (line  6)
   2476 * saving values of arguments:            Saving Values.        (line  6)
   2477 * scope of a transient:                  Defining Transients.  (line 43)
   2478 * suffix specifications:                 Suffix Specifications.
   2479                                                                (line  6)
   2480 * transient state:                       Transient State.      (line  6)
   2481 * transient-level:                       Enabling and Disabling Suffixes.
   2482                                                                (line 15)
   2483 * value history:                         Using History.        (line  6)
   2484 
   2485 
   2486 File: transient.info,  Node: GNU General Public License,  Prev: Concept Index,  Up: Top
   2487 
   2488 Appendix F GNU General Public License
   2489 *************************************
   2490 
   2491                         Version 3, 29 June 2007
   2492 
   2493      Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
   2494 
   2495      Everyone is permitted to copy and distribute verbatim copies of this
   2496      license document, but changing it is not allowed.
   2497 
   2498 Preamble
   2499 ========
   2500 
   2501 The GNU General Public License is a free, copyleft license for software
   2502 and other kinds of works.
   2503 
   2504    The licenses for most software and other practical works are designed
   2505 to take away your freedom to share and change the works.  By contrast,
   2506 the GNU General Public License is intended to guarantee your freedom to
   2507 share and change all versions of a program—to make sure it remains free
   2508 software for all its users.  We, the Free Software Foundation, use the
   2509 GNU General Public License for most of our software; it applies also to
   2510 any other work released this way by its authors.  You can apply it to
   2511 your programs, too.
   2512 
   2513    When we speak of free software, we are referring to freedom, not
   2514 price.  Our General Public Licenses are designed to make sure that you
   2515 have the freedom to distribute copies of free software (and charge for
   2516 them if you wish), that you receive source code or can get it if you
   2517 want it, that you can change the software or use pieces of it in new
   2518 free programs, and that you know you can do these things.
   2519 
   2520    To protect your rights, we need to prevent others from denying you
   2521 these rights or asking you to surrender the rights.  Therefore, you have
   2522 certain responsibilities if you distribute copies of the software, or if
   2523 you modify it: responsibilities to respect the freedom of others.
   2524 
   2525    For example, if you distribute copies of such a program, whether
   2526 gratis or for a fee, you must pass on to the recipients the same
   2527 freedoms that you received.  You must make sure that they, too, receive
   2528 or can get the source code.  And you must show them these terms so they
   2529 know their rights.
   2530 
   2531    Developers that use the GNU GPL protect your rights with two steps:
   2532 (1) assert copyright on the software, and (2) offer you this License
   2533 giving you legal permission to copy, distribute and/or modify it.
   2534 
   2535    For the developers’ and authors’ protection, the GPL clearly explains
   2536 that there is no warranty for this free software.  For both users’ and
   2537 authors’ sake, the GPL requires that modified versions be marked as
   2538 changed, so that their problems will not be attributed erroneously to
   2539 authors of previous versions.
   2540 
   2541    Some devices are designed to deny users access to install or run
   2542 modified versions of the software inside them, although the manufacturer
   2543 can do so.  This is fundamentally incompatible with the aim of
   2544 protecting users’ freedom to change the software.  The systematic
   2545 pattern of such abuse occurs in the area of products for individuals to
   2546 use, which is precisely where it is most unacceptable.  Therefore, we
   2547 have designed this version of the GPL to prohibit the practice for those
   2548 products.  If such problems arise substantially in other domains, we
   2549 stand ready to extend this provision to those domains in future versions
   2550 of the GPL, as needed to protect the freedom of users.
   2551 
   2552    Finally, every program is threatened constantly by software patents.
   2553 States should not allow patents to restrict development and use of
   2554 software on general-purpose computers, but in those that do, we wish to
   2555 avoid the special danger that patents applied to a free program could
   2556 make it effectively proprietary.  To prevent this, the GPL assures that
   2557 patents cannot be used to render the program non-free.
   2558 
   2559    The precise terms and conditions for copying, distribution and
   2560 modification follow.
   2561 
   2562 TERMS AND CONDITIONS
   2563 ====================
   2564 
   2565   0. Definitions.
   2566 
   2567      “This License” refers to version 3 of the GNU General Public
   2568      License.
   2569 
   2570      “Copyright” also means copyright-like laws that apply to other
   2571      kinds of works, such as semiconductor masks.
   2572 
   2573      “The Program” refers to any copyrightable work licensed under this
   2574      License.  Each licensee is addressed as “you”.  “Licensees” and
   2575      “recipients” may be individuals or organizations.
   2576 
   2577      To “modify” a work means to copy from or adapt all or part of the
   2578      work in a fashion requiring copyright permission, other than the
   2579      making of an exact copy.  The resulting work is called a “modified
   2580      version” of the earlier work or a work “based on” the earlier work.
   2581 
   2582      A “covered work” means either the unmodified Program or a work
   2583      based on the Program.
   2584 
   2585      To “propagate” a work means to do anything with it that, without
   2586      permission, would make you directly or secondarily liable for
   2587      infringement under applicable copyright law, except executing it on
   2588      a computer or modifying a private copy.  Propagation includes
   2589      copying, distribution (with or without modification), making
   2590      available to the public, and in some countries other activities as
   2591      well.
   2592 
   2593      To “convey” a work means any kind of propagation that enables other
   2594      parties to make or receive copies.  Mere interaction with a user
   2595      through a computer network, with no transfer of a copy, is not
   2596      conveying.
   2597 
   2598      An interactive user interface displays “Appropriate Legal Notices”
   2599      to the extent that it includes a convenient and prominently visible
   2600      feature that (1) displays an appropriate copyright notice, and (2)
   2601      tells the user that there is no warranty for the work (except to
   2602      the extent that warranties are provided), that licensees may convey
   2603      the work under this License, and how to view a copy of this
   2604      License.  If the interface presents a list of user commands or
   2605      options, such as a menu, a prominent item in the list meets this
   2606      criterion.
   2607 
   2608   1. Source Code.
   2609 
   2610      The “source code” for a work means the preferred form of the work
   2611      for making modifications to it.  “Object code” means any non-source
   2612      form of a work.
   2613 
   2614      A “Standard Interface” means an interface that either is an
   2615      official standard defined by a recognized standards body, or, in
   2616      the case of interfaces specified for a particular programming
   2617      language, one that is widely used among developers working in that
   2618      language.
   2619 
   2620      The “System Libraries” of an executable work include anything,
   2621      other than the work as a whole, that (a) is included in the normal
   2622      form of packaging a Major Component, but which is not part of that
   2623      Major Component, and (b) serves only to enable use of the work with
   2624      that Major Component, or to implement a Standard Interface for
   2625      which an implementation is available to the public in source code
   2626      form.  A “Major Component”, in this context, means a major
   2627      essential component (kernel, window system, and so on) of the
   2628      specific operating system (if any) on which the executable work
   2629      runs, or a compiler used to produce the work, or an object code
   2630      interpreter used to run it.
   2631 
   2632      The “Corresponding Source” for a work in object code form means all
   2633      the source code needed to generate, install, and (for an executable
   2634      work) run the object code and to modify the work, including scripts
   2635      to control those activities.  However, it does not include the
   2636      work’s System Libraries, or general-purpose tools or generally
   2637      available free programs which are used unmodified in performing
   2638      those activities but which are not part of the work.  For example,
   2639      Corresponding Source includes interface definition files associated
   2640      with source files for the work, and the source code for shared
   2641      libraries and dynamically linked subprograms that the work is
   2642      specifically designed to require, such as by intimate data
   2643      communication or control flow between those subprograms and other
   2644      parts of the work.
   2645 
   2646      The Corresponding Source need not include anything that users can
   2647      regenerate automatically from other parts of the Corresponding
   2648      Source.
   2649 
   2650      The Corresponding Source for a work in source code form is that
   2651      same work.
   2652 
   2653   2. Basic Permissions.
   2654 
   2655      All rights granted under this License are granted for the term of
   2656      copyright on the Program, and are irrevocable provided the stated
   2657      conditions are met.  This License explicitly affirms your unlimited
   2658      permission to run the unmodified Program.  The output from running
   2659      a covered work is covered by this License only if the output, given
   2660      its content, constitutes a covered work.  This License acknowledges
   2661      your rights of fair use or other equivalent, as provided by
   2662      copyright law.
   2663 
   2664      You may make, run and propagate covered works that you do not
   2665      convey, without conditions so long as your license otherwise
   2666      remains in force.  You may convey covered works to others for the
   2667      sole purpose of having them make modifications exclusively for you,
   2668      or provide you with facilities for running those works, provided
   2669      that you comply with the terms of this License in conveying all
   2670      material for which you do not control copyright.  Those thus making
   2671      or running the covered works for you must do so exclusively on your
   2672      behalf, under your direction and control, on terms that prohibit
   2673      them from making any copies of your copyrighted material outside
   2674      their relationship with you.
   2675 
   2676      Conveying under any other circumstances is permitted solely under
   2677      the conditions stated below.  Sublicensing is not allowed; section
   2678      10 makes it unnecessary.
   2679 
   2680   3. Protecting Users’ Legal Rights From Anti-Circumvention Law.
   2681 
   2682      No covered work shall be deemed part of an effective technological
   2683      measure under any applicable law fulfilling obligations under
   2684      article 11 of the WIPO copyright treaty adopted on 20 December
   2685      1996, or similar laws prohibiting or restricting circumvention of
   2686      such measures.
   2687 
   2688      When you convey a covered work, you waive any legal power to forbid
   2689      circumvention of technological measures to the extent such
   2690      circumvention is effected by exercising rights under this License
   2691      with respect to the covered work, and you disclaim any intention to
   2692      limit operation or modification of the work as a means of
   2693      enforcing, against the work’s users, your or third parties’ legal
   2694      rights to forbid circumvention of technological measures.
   2695 
   2696   4. Conveying Verbatim Copies.
   2697 
   2698      You may convey verbatim copies of the Program’s source code as you
   2699      receive it, in any medium, provided that you conspicuously and
   2700      appropriately publish on each copy an appropriate copyright notice;
   2701      keep intact all notices stating that this License and any
   2702      non-permissive terms added in accord with section 7 apply to the
   2703      code; keep intact all notices of the absence of any warranty; and
   2704      give all recipients a copy of this License along with the Program.
   2705 
   2706      You may charge any price or no price for each copy that you convey,
   2707      and you may offer support or warranty protection for a fee.
   2708 
   2709   5. Conveying Modified Source Versions.
   2710 
   2711      You may convey a work based on the Program, or the modifications to
   2712      produce it from the Program, in the form of source code under the
   2713      terms of section 4, provided that you also meet all of these
   2714      conditions:
   2715 
   2716        a. The work must carry prominent notices stating that you
   2717           modified it, and giving a relevant date.
   2718 
   2719        b. The work must carry prominent notices stating that it is
   2720           released under this License and any conditions added under
   2721           section 7.  This requirement modifies the requirement in
   2722           section 4 to “keep intact all notices”.
   2723 
   2724        c. You must license the entire work, as a whole, under this
   2725           License to anyone who comes into possession of a copy.  This
   2726           License will therefore apply, along with any applicable
   2727           section 7 additional terms, to the whole of the work, and all
   2728           its parts, regardless of how they are packaged.  This License
   2729           gives no permission to license the work in any other way, but
   2730           it does not invalidate such permission if you have separately
   2731           received it.
   2732 
   2733        d. If the work has interactive user interfaces, each must display
   2734           Appropriate Legal Notices; however, if the Program has
   2735           interactive interfaces that do not display Appropriate Legal
   2736           Notices, your work need not make them do so.
   2737 
   2738      A compilation of a covered work with other separate and independent
   2739      works, which are not by their nature extensions of the covered
   2740      work, and which are not combined with it such as to form a larger
   2741      program, in or on a volume of a storage or distribution medium, is
   2742      called an “aggregate” if the compilation and its resulting
   2743      copyright are not used to limit the access or legal rights of the
   2744      compilation’s users beyond what the individual works permit.
   2745      Inclusion of a covered work in an aggregate does not cause this
   2746      License to apply to the other parts of the aggregate.
   2747 
   2748   6. Conveying Non-Source Forms.
   2749 
   2750      You may convey a covered work in object code form under the terms
   2751      of sections 4 and 5, provided that you also convey the
   2752      machine-readable Corresponding Source under the terms of this
   2753      License, in one of these ways:
   2754 
   2755        a. Convey the object code in, or embodied in, a physical product
   2756           (including a physical distribution medium), accompanied by the
   2757           Corresponding Source fixed on a durable physical medium
   2758           customarily used for software interchange.
   2759 
   2760        b. Convey the object code in, or embodied in, a physical product
   2761           (including a physical distribution medium), accompanied by a
   2762           written offer, valid for at least three years and valid for as
   2763           long as you offer spare parts or customer support for that
   2764           product model, to give anyone who possesses the object code
   2765           either (1) a copy of the Corresponding Source for all the
   2766           software in the product that is covered by this License, on a
   2767           durable physical medium customarily used for software
   2768           interchange, for a price no more than your reasonable cost of
   2769           physically performing this conveying of source, or (2) access
   2770           to copy the Corresponding Source from a network server at no
   2771           charge.
   2772 
   2773        c. Convey individual copies of the object code with a copy of the
   2774           written offer to provide the Corresponding Source.  This
   2775           alternative is allowed only occasionally and noncommercially,
   2776           and only if you received the object code with such an offer,
   2777           in accord with subsection 6b.
   2778 
   2779        d. Convey the object code by offering access from a designated
   2780           place (gratis or for a charge), and offer equivalent access to
   2781           the Corresponding Source in the same way through the same
   2782           place at no further charge.  You need not require recipients
   2783           to copy the Corresponding Source along with the object code.
   2784           If the place to copy the object code is a network server, the
   2785           Corresponding Source may be on a different server (operated by
   2786           you or a third party) that supports equivalent copying
   2787           facilities, provided you maintain clear directions next to the
   2788           object code saying where to find the Corresponding Source.
   2789           Regardless of what server hosts the Corresponding Source, you
   2790           remain obligated to ensure that it is available for as long as
   2791           needed to satisfy these requirements.
   2792 
   2793        e. Convey the object code using peer-to-peer transmission,
   2794           provided you inform other peers where the object code and
   2795           Corresponding Source of the work are being offered to the
   2796           general public at no charge under subsection 6d.
   2797 
   2798      A separable portion of the object code, whose source code is
   2799      excluded from the Corresponding Source as a System Library, need
   2800      not be included in conveying the object code work.
   2801 
   2802      A “User Product” is either (1) a “consumer product”, which means
   2803      any tangible personal property which is normally used for personal,
   2804      family, or household purposes, or (2) anything designed or sold for
   2805      incorporation into a dwelling.  In determining whether a product is
   2806      a consumer product, doubtful cases shall be resolved in favor of
   2807      coverage.  For a particular product received by a particular user,
   2808      “normally used” refers to a typical or common use of that class of
   2809      product, regardless of the status of the particular user or of the
   2810      way in which the particular user actually uses, or expects or is
   2811      expected to use, the product.  A product is a consumer product
   2812      regardless of whether the product has substantial commercial,
   2813      industrial or non-consumer uses, unless such uses represent the
   2814      only significant mode of use of the product.
   2815 
   2816      “Installation Information” for a User Product means any methods,
   2817      procedures, authorization keys, or other information required to
   2818      install and execute modified versions of a covered work in that
   2819      User Product from a modified version of its Corresponding Source.
   2820      The information must suffice to ensure that the continued
   2821      functioning of the modified object code is in no case prevented or
   2822      interfered with solely because modification has been made.
   2823 
   2824      If you convey an object code work under this section in, or with,
   2825      or specifically for use in, a User Product, and the conveying
   2826      occurs as part of a transaction in which the right of possession
   2827      and use of the User Product is transferred to the recipient in
   2828      perpetuity or for a fixed term (regardless of how the transaction
   2829      is characterized), the Corresponding Source conveyed under this
   2830      section must be accompanied by the Installation Information.  But
   2831      this requirement does not apply if neither you nor any third party
   2832      retains the ability to install modified object code on the User
   2833      Product (for example, the work has been installed in ROM).
   2834 
   2835      The requirement to provide Installation Information does not
   2836      include a requirement to continue to provide support service,
   2837      warranty, or updates for a work that has been modified or installed
   2838      by the recipient, or for the User Product in which it has been
   2839      modified or installed.  Access to a network may be denied when the
   2840      modification itself materially and adversely affects the operation
   2841      of the network or violates the rules and protocols for
   2842      communication across the network.
   2843 
   2844      Corresponding Source conveyed, and Installation Information
   2845      provided, in accord with this section must be in a format that is
   2846      publicly documented (and with an implementation available to the
   2847      public in source code form), and must require no special password
   2848      or key for unpacking, reading or copying.
   2849 
   2850   7. Additional Terms.
   2851 
   2852      “Additional permissions” are terms that supplement the terms of
   2853      this License by making exceptions from one or more of its
   2854      conditions.  Additional permissions that are applicable to the
   2855      entire Program shall be treated as though they were included in
   2856      this License, to the extent that they are valid under applicable
   2857      law.  If additional permissions apply only to part of the Program,
   2858      that part may be used separately under those permissions, but the
   2859      entire Program remains governed by this License without regard to
   2860      the additional permissions.
   2861 
   2862      When you convey a copy of a covered work, you may at your option
   2863      remove any additional permissions from that copy, or from any part
   2864      of it.  (Additional permissions may be written to require their own
   2865      removal in certain cases when you modify the work.)  You may place
   2866      additional permissions on material, added by you to a covered work,
   2867      for which you have or can give appropriate copyright permission.
   2868 
   2869      Notwithstanding any other provision of this License, for material
   2870      you add to a covered work, you may (if authorized by the copyright
   2871      holders of that material) supplement the terms of this License with
   2872      terms:
   2873 
   2874        a. Disclaiming warranty or limiting liability differently from
   2875           the terms of sections 15 and 16 of this License; or
   2876 
   2877        b. Requiring preservation of specified reasonable legal notices
   2878           or author attributions in that material or in the Appropriate
   2879           Legal Notices displayed by works containing it; or
   2880 
   2881        c. Prohibiting misrepresentation of the origin of that material,
   2882           or requiring that modified versions of such material be marked
   2883           in reasonable ways as different from the original version; or
   2884 
   2885        d. Limiting the use for publicity purposes of names of licensors
   2886           or authors of the material; or
   2887 
   2888        e. Declining to grant rights under trademark law for use of some
   2889           trade names, trademarks, or service marks; or
   2890 
   2891        f. Requiring indemnification of licensors and authors of that
   2892           material by anyone who conveys the material (or modified
   2893           versions of it) with contractual assumptions of liability to
   2894           the recipient, for any liability that these contractual
   2895           assumptions directly impose on those licensors and authors.
   2896 
   2897      All other non-permissive additional terms are considered “further
   2898      restrictions” within the meaning of section 10.  If the Program as
   2899      you received it, or any part of it, contains a notice stating that
   2900      it is governed by this License along with a term that is a further
   2901      restriction, you may remove that term.  If a license document
   2902      contains a further restriction but permits relicensing or conveying
   2903      under this License, you may add to a covered work material governed
   2904      by the terms of that license document, provided that the further
   2905      restriction does not survive such relicensing or conveying.
   2906 
   2907      If you add terms to a covered work in accord with this section, you
   2908      must place, in the relevant source files, a statement of the
   2909      additional terms that apply to those files, or a notice indicating
   2910      where to find the applicable terms.
   2911 
   2912      Additional terms, permissive or non-permissive, may be stated in
   2913      the form of a separately written license, or stated as exceptions;
   2914      the above requirements apply either way.
   2915 
   2916   8. Termination.
   2917 
   2918      You may not propagate or modify a covered work except as expressly
   2919      provided under this License.  Any attempt otherwise to propagate or
   2920      modify it is void, and will automatically terminate your rights
   2921      under this License (including any patent licenses granted under the
   2922      third paragraph of section 11).
   2923 
   2924      However, if you cease all violation of this License, then your
   2925      license from a particular copyright holder is reinstated (a)
   2926      provisionally, unless and until the copyright holder explicitly and
   2927      finally terminates your license, and (b) permanently, if the
   2928      copyright holder fails to notify you of the violation by some
   2929      reasonable means prior to 60 days after the cessation.
   2930 
   2931      Moreover, your license from a particular copyright holder is
   2932      reinstated permanently if the copyright holder notifies you of the
   2933      violation by some reasonable means, this is the first time you have
   2934      received notice of violation of this License (for any work) from
   2935      that copyright holder, and you cure the violation prior to 30 days
   2936      after your receipt of the notice.
   2937 
   2938      Termination of your rights under this section does not terminate
   2939      the licenses of parties who have received copies or rights from you
   2940      under this License.  If your rights have been terminated and not
   2941      permanently reinstated, you do not qualify to receive new licenses
   2942      for the same material under section 10.
   2943 
   2944   9. Acceptance Not Required for Having Copies.
   2945 
   2946      You are not required to accept this License in order to receive or
   2947      run a copy of the Program.  Ancillary propagation of a covered work
   2948      occurring solely as a consequence of using peer-to-peer
   2949      transmission to receive a copy likewise does not require
   2950      acceptance.  However, nothing other than this License grants you
   2951      permission to propagate or modify any covered work.  These actions
   2952      infringe copyright if you do not accept this License.  Therefore,
   2953      by modifying or propagating a covered work, you indicate your
   2954      acceptance of this License to do so.
   2955 
   2956   10. Automatic Licensing of Downstream Recipients.
   2957 
   2958      Each time you convey a covered work, the recipient automatically
   2959      receives a license from the original licensors, to run, modify and
   2960      propagate that work, subject to this License.  You are not
   2961      responsible for enforcing compliance by third parties with this
   2962      License.
   2963 
   2964      An “entity transaction” is a transaction transferring control of an
   2965      organization, or substantially all assets of one, or subdividing an
   2966      organization, or merging organizations.  If propagation of a
   2967      covered work results from an entity transaction, each party to that
   2968      transaction who receives a copy of the work also receives whatever
   2969      licenses to the work the party’s predecessor in interest had or
   2970      could give under the previous paragraph, plus a right to possession
   2971      of the Corresponding Source of the work from the predecessor in
   2972      interest, if the predecessor has it or can get it with reasonable
   2973      efforts.
   2974 
   2975      You may not impose any further restrictions on the exercise of the
   2976      rights granted or affirmed under this License.  For example, you
   2977      may not impose a license fee, royalty, or other charge for exercise
   2978      of rights granted under this License, and you may not initiate
   2979      litigation (including a cross-claim or counterclaim in a lawsuit)
   2980      alleging that any patent claim is infringed by making, using,
   2981      selling, offering for sale, or importing the Program or any portion
   2982      of it.
   2983 
   2984   11. Patents.
   2985 
   2986      A “contributor” is a copyright holder who authorizes use under this
   2987      License of the Program or a work on which the Program is based.
   2988      The work thus licensed is called the contributor’s “contributor
   2989      version”.
   2990 
   2991      A contributor’s “essential patent claims” are all patent claims
   2992      owned or controlled by the contributor, whether already acquired or
   2993      hereafter acquired, that would be infringed by some manner,
   2994      permitted by this License, of making, using, or selling its
   2995      contributor version, but do not include claims that would be
   2996      infringed only as a consequence of further modification of the
   2997      contributor version.  For purposes of this definition, “control”
   2998      includes the right to grant patent sublicenses in a manner
   2999      consistent with the requirements of this License.
   3000 
   3001      Each contributor grants you a non-exclusive, worldwide,
   3002      royalty-free patent license under the contributor’s essential
   3003      patent claims, to make, use, sell, offer for sale, import and
   3004      otherwise run, modify and propagate the contents of its contributor
   3005      version.
   3006 
   3007      In the following three paragraphs, a “patent license” is any
   3008      express agreement or commitment, however denominated, not to
   3009      enforce a patent (such as an express permission to practice a
   3010      patent or covenant not to sue for patent infringement).  To “grant”
   3011      such a patent license to a party means to make such an agreement or
   3012      commitment not to enforce a patent against the party.
   3013 
   3014      If you convey a covered work, knowingly relying on a patent
   3015      license, and the Corresponding Source of the work is not available
   3016      for anyone to copy, free of charge and under the terms of this
   3017      License, through a publicly available network server or other
   3018      readily accessible means, then you must either (1) cause the
   3019      Corresponding Source to be so available, or (2) arrange to deprive
   3020      yourself of the benefit of the patent license for this particular
   3021      work, or (3) arrange, in a manner consistent with the requirements
   3022      of this License, to extend the patent license to downstream
   3023      recipients.  “Knowingly relying” means you have actual knowledge
   3024      that, but for the patent license, your conveying the covered work
   3025      in a country, or your recipient’s use of the covered work in a
   3026      country, would infringe one or more identifiable patents in that
   3027      country that you have reason to believe are valid.
   3028 
   3029      If, pursuant to or in connection with a single transaction or
   3030      arrangement, you convey, or propagate by procuring conveyance of, a
   3031      covered work, and grant a patent license to some of the parties
   3032      receiving the covered work authorizing them to use, propagate,
   3033      modify or convey a specific copy of the covered work, then the
   3034      patent license you grant is automatically extended to all
   3035      recipients of the covered work and works based on it.
   3036 
   3037      A patent license is “discriminatory” if it does not include within
   3038      the scope of its coverage, prohibits the exercise of, or is
   3039      conditioned on the non-exercise of one or more of the rights that
   3040      are specifically granted under this License.  You may not convey a
   3041      covered work if you are a party to an arrangement with a third
   3042      party that is in the business of distributing software, under which
   3043      you make payment to the third party based on the extent of your
   3044      activity of conveying the work, and under which the third party
   3045      grants, to any of the parties who would receive the covered work
   3046      from you, a discriminatory patent license (a) in connection with
   3047      copies of the covered work conveyed by you (or copies made from
   3048      those copies), or (b) primarily for and in connection with specific
   3049      products or compilations that contain the covered work, unless you
   3050      entered into that arrangement, or that patent license was granted,
   3051      prior to 28 March 2007.
   3052 
   3053      Nothing in this License shall be construed as excluding or limiting
   3054      any implied license or other defenses to infringement that may
   3055      otherwise be available to you under applicable patent law.
   3056 
   3057   12. No Surrender of Others’ Freedom.
   3058 
   3059      If conditions are imposed on you (whether by court order, agreement
   3060      or otherwise) that contradict the conditions of this License, they
   3061      do not excuse you from the conditions of this License.  If you
   3062      cannot convey a covered work so as to satisfy simultaneously your
   3063      obligations under this License and any other pertinent obligations,
   3064      then as a consequence you may not convey it at all.  For example,
   3065      if you agree to terms that obligate you to collect a royalty for
   3066      further conveying from those to whom you convey the Program, the
   3067      only way you could satisfy both those terms and this License would
   3068      be to refrain entirely from conveying the Program.
   3069 
   3070   13. Use with the GNU Affero General Public License.
   3071 
   3072      Notwithstanding any other provision of this License, you have
   3073      permission to link or combine any covered work with a work licensed
   3074      under version 3 of the GNU Affero General Public License into a
   3075      single combined work, and to convey the resulting work.  The terms
   3076      of this License will continue to apply to the part which is the
   3077      covered work, but the special requirements of the GNU Affero
   3078      General Public License, section 13, concerning interaction through
   3079      a network will apply to the combination as such.
   3080 
   3081   14. Revised Versions of this License.
   3082 
   3083      The Free Software Foundation may publish revised and/or new
   3084      versions of the GNU General Public License from time to time.  Such
   3085      new versions will be similar in spirit to the present version, but
   3086      may differ in detail to address new problems or concerns.
   3087 
   3088      Each version is given a distinguishing version number.  If the
   3089      Program specifies that a certain numbered version of the GNU
   3090      General Public License “or any later version” applies to it, you
   3091      have the option of following the terms and conditions either of
   3092      that numbered version or of any later version published by the Free
   3093      Software Foundation.  If the Program does not specify a version
   3094      number of the GNU General Public License, you may choose any
   3095      version ever published by the Free Software Foundation.
   3096 
   3097      If the Program specifies that a proxy can decide which future
   3098      versions of the GNU General Public License can be used, that
   3099      proxy’s public statement of acceptance of a version permanently
   3100      authorizes you to choose that version for the Program.
   3101 
   3102      Later license versions may give you additional or different
   3103      permissions.  However, no additional obligations are imposed on any
   3104      author or copyright holder as a result of your choosing to follow a
   3105      later version.
   3106 
   3107   15. Disclaimer of Warranty.
   3108 
   3109      THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   3110      APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
   3111      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS”
   3112      WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
   3113      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
   3114      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE
   3115      RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
   3116      SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
   3117      NECESSARY SERVICING, REPAIR OR CORRECTION.
   3118 
   3119   16. Limitation of Liability.
   3120 
   3121      IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
   3122      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
   3123      AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
   3124      DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
   3125      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
   3126      THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
   3127      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   3128      PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
   3129      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
   3130      THE POSSIBILITY OF SUCH DAMAGES.
   3131 
   3132   17. Interpretation of Sections 15 and 16.
   3133 
   3134      If the disclaimer of warranty and limitation of liability provided
   3135      above cannot be given local legal effect according to their terms,
   3136      reviewing courts shall apply local law that most closely
   3137      approximates an absolute waiver of all civil liability in
   3138      connection with the Program, unless a warranty or assumption of
   3139      liability accompanies a copy of the Program in return for a fee.
   3140 
   3141 END OF TERMS AND CONDITIONS
   3142 ===========================
   3143 
   3144 How to Apply These Terms to Your New Programs
   3145 =============================================
   3146 
   3147 If you develop a new program, and you want it to be of the greatest
   3148 possible use to the public, the best way to achieve this is to make it
   3149 free software which everyone can redistribute and change under these
   3150 terms.
   3151 
   3152    To do so, attach the following notices to the program.  It is safest
   3153 to attach them to the start of each source file to most effectively
   3154 state the exclusion of warranty; and each file should have at least the
   3155 “copyright” line and a pointer to where the full notice is found.
   3156 
   3157      ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
   3158      Copyright (C) YEAR NAME OF AUTHOR
   3159 
   3160      This program is free software: you can redistribute it and/or modify
   3161      it under the terms of the GNU General Public License as published by
   3162      the Free Software Foundation, either version 3 of the License, or (at
   3163      your option) any later version.
   3164 
   3165      This program is distributed in the hope that it will be useful, but
   3166      WITHOUT ANY WARRANTY; without even the implied warranty of
   3167      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   3168      General Public License for more details.
   3169 
   3170      You should have received a copy of the GNU General Public License
   3171      along with this program.  If not, see <https://www.gnu.org/licenses/>.
   3172 
   3173    Also add information on how to contact you by electronic and paper
   3174 mail.
   3175 
   3176    If the program does terminal interaction, make it output a short
   3177 notice like this when it starts in an interactive mode:
   3178 
   3179      PROGRAM Copyright (C) YEAR NAME OF AUTHOR
   3180      This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’.
   3181      This is free software, and you are welcome to redistribute it
   3182      under certain conditions; type ‘show c’ for details.
   3183 
   3184    The hypothetical commands ‘show w’ and ‘show c’ should show the
   3185 appropriate parts of the General Public License.  Of course, your
   3186 program’s commands might be different; for a GUI interface, you would
   3187 use an “about box”.
   3188 
   3189    You should also get your employer (if you work as a programmer) or
   3190 school, if any, to sign a “copyright disclaimer” for the program, if
   3191 necessary.  For more information on this, and how to apply and follow
   3192 the GNU GPL, see <https://www.gnu.org/licenses/>.
   3193 
   3194    The GNU General Public License does not permit incorporating your
   3195 program into proprietary programs.  If your program is a subroutine
   3196 library, you may consider it more useful to permit linking proprietary
   3197 applications with the library.  If this is what you want to do, use the
   3198 GNU Lesser General Public License instead of this License.  But first,
   3199 please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
   3200 
   3201 
   3202 
   3203 Tag Table:
   3204 Node: Top763
   3205 Node: Introduction2976
   3206 Ref: Some things that Transient can do3504
   3207 Ref: Complexity in CLI programs3857
   3208 Ref: Using Transient for composing interactive commands4458
   3209 Node: Usage6700
   3210 Node: Invoking Transients7068
   3211 Node: Aborting and Resuming Transients8147
   3212 Node: Common Suffix Commands10768
   3213 Node: Saving Values12604
   3214 Ref: Saving Values-Footnote-113975
   3215 Node: Using History14168
   3216 Node: Getting Help for Suffix Commands15742
   3217 Node: Enabling and Disabling Suffixes17120
   3218 Node: Other Commands20408
   3219 Node: Configuration21384
   3220 Ref: Essential Options21664
   3221 Ref: Accessibility Options25325
   3222 Ref: Auxiliary Options25648
   3223 Ref: Developer Options30611
   3224 Node: Modifying Existing Transients31859
   3225 Node: Defining New Commands36051
   3226 Node: Technical Introduction36414
   3227 Node: Defining Transients42115
   3228 Node: Binding Suffix and Infix Commands44582
   3229 Node: Group Specifications45440
   3230 Node: Suffix Specifications50542
   3231 Node: Defining Suffix and Infix Commands54755
   3232 Node: Using Infix Arguments57803
   3233 Node: Transient State60637
   3234 Ref: Pre-commands for Infixes65452
   3235 Ref: Pre-commands for Suffixes65972
   3236 Ref: Pre-commands for Non-Suffixes68426
   3237 Ref: Special Pre-Commands69562
   3238 Node: Classes and Methods70070
   3239 Node: Group Classes72254
   3240 Node: Group Methods74181
   3241 Node: Prefix Classes75434
   3242 Node: Suffix Classes76525
   3243 Node: Suffix Methods79612
   3244 Node: Suffix Value Methods79933
   3245 Node: Suffix Format Methods82691
   3246 Node: Prefix Slots84170
   3247 Ref: Internal Prefix Slots86305
   3248 Node: Suffix Slots87562
   3249 Ref: Slots of transient-suffix87930
   3250 Ref: Slots of transient-infix89067
   3251 Ref: Slots of transient-variable92363
   3252 Ref: Slots of transient-switches92465
   3253 Node: Predicate Slots92828
   3254 Node: FAQ94263
   3255 Ref: Can I control how the popup buffer is displayed?94392
   3256 Ref: How can I copy text from the popup buffer?94573
   3257 Ref: How can I autoload prefix and suffix commands?95067
   3258 Ref: How does Transient compare to prefix keys and universal arguments?95541
   3259 Ref: How does Transient compare to Magit-Popup and Hydra?95784
   3260 Ref: Why did some of the key bindings change?95978
   3261 Ref: Why does q not quit popups anymore?98331
   3262 Node: Keystroke Index99434
   3263 Node: Command and Function Index101299
   3264 Node: Variable Index107891
   3265 Node: Concept Index110164
   3266 Node: GNU General Public License112900
   3267 
   3268 End Tag Table
   3269 
   3270 
   3271 Local Variables:
   3272 coding: utf-8
   3273 End: