Forrest logo
tool overview
On this page you find all important commands for the CLI tool xauth. If the command you are looking for is missing please ask our AI.

xauth

xauth is a command line tool used in Unix-like operating systems to manipulate X Window System authorization information. It manages the cookies used for authenticating connections to X servers. The tool stores and retrieves the cookies in an "authority file" which is typically located at ~/.Xauthority.

With xauth, users can add, remove, or edit authorization records, allowing or denying access to X servers. It is commonly used for granting permissions to remote clients to access the local X server. The command-line options of xauth enable various operations like listing all existing records, adding new entries, deleting specific ones, and merging authority files.

xauth uses the MIT-MAGIC-COOKIE-1 token-based authentication mechanism. Upon successful authentication, a client receives a cookie that must match with the server's cookie to establish a trusted connection. By default, xauth generates random cookies for each new connection, enhancing security.

Overall, xauth provides users with the flexibility to manage X Window System authorization effectively, ensuring secure and controlled access to X servers.

List of commands for xauth:

  • xauth:tldr:02740 xauth: Display authorization entries for all the displays.
    $ xauth list
    try on your machine
    explain this command
  • xauth:tldr:04b97 xauth: Remove the authorization for a specific display.
    $ xauth remove ${display_name}
    try on your machine
    explain this command
  • xauth:tldr:9f27c xauth: Display information about the authority file.
    $ xauth info
    try on your machine
    explain this command
  • xauth:tldr:c2ea9 xauth: Start interactive mode with a specific authority file (defaults to `~/.Xauthority`).
    $ xauth -f ${filename}
    try on your machine
    explain this command
  • xauth:tldr:da165 xauth: Display help.
    $ xauth --help
    try on your machine
    explain this command
  • xauth:tldr:fc960 xauth: Add an authorization for a specific display.
    $ xauth add ${display_name} ${protocol_name} ${key}
    try on your machine
    explain this command
tool overview