BashShell class

Provides a number of helper functions when dcli needs to interact with the Bash shell.

Mixed in types

Constructors

BashShell.withPid(int? pid)
Attached to a bash shell with the given pid.

Properties

hashCode int
The hash code for this object.
no setterinherited
hasStartScript bool
True if this shell supports a start script or configuration file. e.g. a script that is run by the shell or a configuration file that is read when the shell starts.
no setteroverride
isCompletionInstalled bool
no setteroverride
isCompletionSupported bool
no setteroverride
isPrivilegedProcess bool
True if the processes real uid is root.
no setterinherited
isPrivilegedUser bool
True if the processes effictive uid is root.
no setterinherited
isSudo bool
Returns true if we are currently running under sudo.
no setterinherited
loggedInUser String
returns the username of the logged in user.
no setterinherited
loggedInUsersHome String
Attempts to retrive the logged in user's home directory.
no setterinherited
name String
The name of the shell e.g. bash
no setteroverride
pathToStartScript String
Returns the path to the shell's start script or config file e.g /home/
no setteroverride
pid int?
The pid of the current shell
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
startScriptName String
Returns the name of the shell's startup script or configuration file e.g. .bashrc
no setteroverride

Methods

addToPATH(String path) bool
Adds the given path to the bash path if it isn't already on teh path.
override
checkInstallPreconditions() String?
at this point no posix system has any preconditions.
inherited
install({bool installDart = false}) bool
Install dart/dcli
inherited
installTabCompletion({bool quiet = false}) → void
If the shell supports tab completion then install it. If quiet is true then suppress any console output except for errors.
override
matchByName(String name) bool
Returns true if the shells name matches the passed name. The comparison is case insensitive.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
privilegesRequiredMessage(String app) String
The message used during installation if it needs to be run with sudo.
inherited
releasePrivileges() → void
revert uid and gid to original user's id's
inherited
toString() String
A string representation of this object.
inherited
withPrivileges(RunPrivileged privilegedCallback) → void
Run privilegedCallback with root UID and gid
inherited

Operators

operator ==(covariant Shell other) bool
The equality operator.
inherited

Constants

shellName → const String
Name of the shell