ftsautoma - registers, deletes, and displays auto-start programs
- Organization of this page
Format
- Registering:
ftsautoma -file | dir -N user-name file-name | directory-name end-of-transmission-start-program-option option-parameter
- Deleting:
ftsautoma -file | dir -D user-name file-name | directory-name
- Displaying:
ftsautoma -file | dir -L [user-name [file-name | directory-name] ] [-m format-file-name | -v] [-f auto-start-program-information-directory-name]
Function
The ftsautoma command registers, deletes, or displays auto-start programs.
Arguments
-file | dir
Specifies the type of key:
-
-file: Uses a file name as the key.
-
-dir: Uses a directory name as the key.
-N user-name file-name | directory-name ((1 to 256-byte character string))
Registers a new auto-start program with the specified file name (or directory name) as the key value.
The user name must be a user registered in the /etc/passwd file or the default user (default).
A file name must be the full path or the file name. A directory name must be the full path.
At least one of -AS and -AF must also be specified.
To register auto-start program information, you need superuser permissions.
-D user-name file-name | directory-name
Deletes the auto-start program identified by the specified user name and file name (or directory name).
To delete auto-start program information, you need superuser permissions.
-L [user-name [file-name | directory-name] ]
Displays registration information for the auto-start program identified by the specified user name and file name (or directory name).
If you omit the file name and directory name, the command displays registration information for all auto-start programs for the specified user name.
If you omit all of user name, file name, and directory name, the command displays registration information for all auto-start programs.
-m format-file-name ((1 to 256-byte character string))
Displays the auto-start program registration information in the format that is set up in the specified format file.
For details about the format file, see E. Format Files Used for Output of Definition Information.
If a relative path is specified for the format file name, the command assumes the directory relative to the command execution directory.
This argument and -v are mutually exclusive.
Example of display when the default format file is specified:
If -m and -v are both omitted, the command displays information in the format that is set up in the default format file.
For details about the default format file, see E. Format Files Used for Output of Definition Information.
-v
Displays auto-start program registration information in list format.
This argument and -m are mutually exclusive.
Example of display:
If the list format is used, the length of each item is limited as shown in the table below.
Item name |
Maximum number of characters displayed |
---|---|
User name |
15 characters |
File name or Directory name |
15 characters |
Auto-start program at normal end |
23 characters (32 characters when LANG=C is specified) |
Auto-start program at abnormal end |
23 characters (32 characters when LANG=C is specified) |
If -m and -v are both omitted, the command displays information in the format that is set up in the default format file.
For details about the default format file, see E. Format Files Used for Output of Definition Information.
-f auto-start-program-information-directory-name ((1 to 256-byte character string))
Changes the directory from which the auto-start program information is loaded to the specified directory.
If you specify a relative path for the auto-start program information directory name, the command assumes the directory relative to the command execution directory.
directory-name end-of-transmission-start-program-option option-parameter
The table below lists and describes the end-of-transmission start program options. For details about the transmission option parameters, see 3.3.1 Registering auto-start programs.
Option name |
Transmission option parameter |
Value |
---|---|---|
-AS |
Name of the program to start when transmission ends normally |
((0 to 256 bytes)) |
-AF |
Name of the program to start when transmission ends abnormally |
((0 to 256 bytes)) |
Return values
0 |
Normal termination |
61 |
Abnormal termination during registration |
63 |
Abnormal termination during deletion |
64 |
Abnormal termination during display |
91 |
Abnormal termination due to a syntax error in a command parameter |
Note
A space character contained in a program name specified in -AS or -AF has a special meaning to the shell. In such a case, you must escape the space characters.
Example: Specifying 1 in the option when the program name is /home/user1/sample:
"/home/user1/sample 1"