How to use the command xauth (with examples)

The xauth command is used to edit and display the authorization information used in connecting to the X server. It provides various options to manage and manipulate authorization entries for X displays.

Use case 1: Start interactive mode with a specific authority file

Code:

xauth -f path/to/file

Motivation: You want to start an interactive mode with a specific authority file instead of the default ~/.Xauthority.

Explanation:

• -f path/to/file: Specifies the authority file to use.

Example output: None.

Use case 2: Display information about the authority file

Code:

xauth info

Motivation: You need to check the information about the authority file currently being used.

Explanation: None.

Example output:

Authority file:       /home/user/.Xauthority
File new:             no
File locked:          no
Number of entries:    2
Changes honored:      yes
Changes made:         no
Current input:        "unix:0"

Use case 3: Display authorization entries for all the displays

Code:

xauth list

Motivation: You want to view all the authorization entries for all the displays.

Explanation: None.

Example output:

localhost/unix:0  MIT-MAGIC-COOKIE-1  abcdef1234567890
remotehost/unix:0  MIT-MAGIC-COOKIE-1  0987654321abcdef

Use case 4: Add an authorization for a specific display

Code:

xauth add display_name protocol_name key

Motivation: You want to add an authorization entry for a specific display.

Explanation:

• display_name: Specifies the display for which the authorization should be added.
• protocol_name: Specifies the authorization protocol to use.
• key: Specifies the authorization key.

Example output: None.

Use case 5: Remove the authorization for a specific display

Code:

xauth remove display_name

Motivation: You need to remove the authorization entry for a specific display.

Explanation:

• display_name: Specifies the display for which the authorization should be removed.

Example output: None.

Use case 6: Print the authorization entry for the current display to stdout

Code:

xauth extract - $DISPLAY

Motivation: You want to print the authorization entry for the current display to stdout.

Explanation:

• extract - $DISPLAY: Specifies to extract the authorization for the current display ($DISPLAY) and print it to stdout.

Example output:

localhost/unix:0  MIT-MAGIC-COOKIE-1  abcdef1234567890

Use case 7: Merge the authorization entries from a specific file into the authorization database

Code:

cat path/to/file | xauth merge -

Motivation: You want to merge the authorization entries from a specific file into the authorization database.

Explanation:

• cat path/to/file: Reads the contents of the specified file.
• |: Pipes the contents of the file to xauth.
• merge -: Merges the authorization entries from the standard input (-) into the authorization database.

Example output: None.

Use case 8: Display help

Code:

xauth --help

Motivation: You need help with using the xauth command.

Explanation: None.

Example output: Help documentation for the xauth command.