package ps

Import Path
	github.com/carapace-sh/carapace/third_party/github.com/mitchellh/go-ps (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	  d process.go
		ps provides an API for finding and listing processes in a platform-agnostic
		way.
		
		NOTE: If you're reading these docs online via GoDocs or some other system,
		you might only see the Unix docs. This project makes heavy use of
		platform-specific implementations. We recommend reading the source if you
		are interested.

	    process_linux.go
	    process_unix.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Process (interface)
		Process is the generic interface that is implemented on every platform
		and provides common operations for processes.

		Methods (total 3)
			( Process) Executable() string
				Executable name running this process. This is not a path to the
				executable.

			( Process) PPid() int
				PPid is the parent process ID for this process.

			( Process) Pid() int
				Pid is the process ID for this process.

		Implemented By (at least one exported)
			*UnixProcess
		As Outputs Of (at least 2)
			func FindProcess(pid int) (Process, error)
			func Processes() ([]Process, error)

	 type UnixProcess (struct)
		UnixProcess is an implementation of Process that contains Unix-specific
		fields and information.

		Methods (total 4)
			(*UnixProcess) Executable() string
			(*UnixProcess) PPid() int
			(*UnixProcess) Pid() int
			(*UnixProcess) Refresh() error
				Refresh reloads all the data associated with this process.

		Implements (at least one exported)
			*UnixProcess : Process


Package-Level Functions (total 2)

	 func FindProcess(pid int) (Process, error)
		FindProcess looks up a single process by pid.
		
		Process will be nil and error will be nil if a matching process is
		not found.

	 func Processes() ([]Process, error)
		Processes returns all processes.
		
		This of course will be a point-in-time snapshot of when this method was
		called. Some operating systems don't provide snapshot capability of the
		process table, in which case the process table returned might contain
		ephemeral entities that happened to be running when this was called.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.