sh
stable
  • Usage
  • Reference
    • Special Kwargs
    • Architecture Overview
    • API
  • Contrib Commands
  • Using Sudo
  • Tutorials
  • FAQ
sh
  • Reference
  • Edit on GitHub

Reference

  • Special Kwargs
    • Controlling Output
      • _out
      • _err
      • _err_to_out
      • _encoding
      • _decode_errors
      • _tee
      • _truncate_exc
    • Execution
      • _fg
      • _bg
      • _bg_exc
      • _async
      • _env
      • _timeout
      • _timeout_signal
      • _cwd
      • _ok_code
      • _new_session
      • _uid
      • _preexec_fn
      • _pass_fds
      • _close_fds
    • Communication
      • _in
      • _piped
      • _iter
      • _iter_noblock
      • _with
      • _done
    • TTYs
      • _tty_in
      • _tty_out
      • _unify_ttys
      • _tty_size
    • Performance & Optimization
      • _in_bufsize
      • _out_bufsize
      • _err_bufsize
      • _internal_bufsize
      • _no_out
      • _no_err
      • _no_pipe
    • Program Arguments
      • _long_sep
      • _long_prefix
      • _arg_preprocess
    • Misc
      • _log_msg
  • Architecture Overview
    • Launch
      • Child
      • Parent
    • Running
      • Buffers
    • Exit
      • STDIN Thread Shutdown
      • STDOUT/ERR Thread Shutdown
      • Exit Code Processing
      • Done Callback
  • API
    • Command Class
      • Command
        • Command.bake()
    • RunningCommand Class
      • RunningCommand.wait()
      • RunningCommand.process
      • RunningCommand.stdout
      • RunningCommand.stderr
      • RunningCommand.exit_code
      • RunningCommand.pid
      • RunningCommand.sid
      • RunningCommand.pgid
      • RunningCommand.ctty
      • RunningCommand.signal()
      • RunningCommand.signal_group()
      • RunningCommand.terminate()
      • RunningCommand.kill()
      • RunningCommand.kill_group()
      • RunningCommand.is_alive()
    • OProc Class
      • OProc.wait()
      • OProc.stdout
      • OProc.stderr
      • OProc.exit_code
      • OProc.pid
      • OProc.sid
      • OProc.pgid
      • OProc.ctty
      • OProc.signal()
      • OProc.signal_group()
      • OProc.terminate()
      • OProc.kill()
      • OProc.kill_group()
    • Exceptions
      • ErrorReturnCode
        • ErrorReturnCode
          • ErrorReturnCode.full_cmd
          • ErrorReturnCode.stdout
          • ErrorReturnCode.stderr
          • ErrorReturnCode.exit_code
      • SignalException
      • TimeoutException
      • CommandNotFound
    • Helper Functions
      • which()
      • pushd()
Previous Next

© Copyright 2023, Andrew Moffat. Revision 08d76030.

Built with Sphinx using a theme provided by Read the Docs.