---
name: "xfm.install"
section: "1x"
platform: "linux"
package: "xfm"
version: "1.4.3-2"
release: "Debian 3.0 (Woody)"
platforms: ["linux"]
url: "https://new.carta.tech/xfm.install"
---

# xfm.install(1x)

install default xfm configuration in user's home directory

## NAME

xfm.install - install default xfm configuration in user's home directory

## SYNOPSIS

**xfm.install** \[**-n**\]

## DESCRIPTION

**xfm.install** is a Bourne shell script that copies the default configuration files that ship as part of **xfm** into the user's *$HOME/.xfm* directory.  If this directory is already present, the user is prompted to overwwrite it, unless the script is invoked with the noninteractive (**-n**) option, in which case the script will change nothing and exit with an error.

## OPTIONS

- **-n**

  run non-interactively, aborting if configuration directory already present

## OPERANDS

None.

## STDIN

If *$HOME/.xfm* already exists and **xfm.install** is not given the **-n** option, the user will be prompted to overwrite the directory, and the user's answer will be read from standard input.

## INPUT FILES

**xfm.install** copies configuration files from the */usr/X11R6/lib/X11/xfm/dot.xfm* directory.

## ENVIRONMENT VARIABLES

The following environment variables affect the execution of **xfm.install:**

- *HOME*

  The pathname of the user's home directory.

## ASYNCRHONOUS EVENTS

Default.

## STDOUT

**xfm.install** reports all error and diagnostic messages to standard output, including a message indicating success.

## STDERR

Not used; however, the commands and utilities used by **xfm.install** may issue diagnostics to standard error.

## OUTPUT FILES

The input files described above are copied to *$HOME/.xfm*.

## EXTENDED DESCRIPTION

None.

## EXIT STATUS

**xfm.install** exits with status 1 if any problems are encountered.

## CONSEQUENCES OF ERRORS

The user's *$HOME/.xfm* directory is not atomically replaced, thus it is possible for the user's **xfm** configuration data to be lost.

## APPLICATION USAGE

**xfm.install** is called internally by **xfm** if no *$HOME/.xfm* directory is found.

## EXAMPLES

None.

## FUTURE DIRECTIONS

None.

## AUTHORS

Simon Marlow and Albert Graef.

## SEE ALSO

[**xfm**(1)](/xfm/1.md)