coreutils: readlink invocation

1 
1 12.6 ‘readlink’: Print value of a symlink or canonical file name
1 ================================================================
1 
1 ‘readlink’ may work in one of two supported modes:
1 
1 ‘Readlink mode’
1 
1      ‘readlink’ outputs the value of the given symbolic links.  If
1      ‘readlink’ is invoked with an argument other than the name of a
1      symbolic link, it produces no output and exits with a nonzero exit
1      code.
1 
1 ‘Canonicalize mode’
1 
1      ‘readlink’ outputs the absolute name of the given files which
1      contain no ‘.’, ‘..’ components nor any repeated separators (‘/’)
1      or symbolic links.  Note the ‘realpath’ command is the preferred
1      command to use for canonicalization.  ⇒realpath invocation.
1 
1      readlink [OPTION]... FILE...
1 
1    By default, ‘readlink’ operates in readlink mode.
1 
11    The program accepts the following options.  Also see ⇒Common
 options.
1 
1 ‘-f’
1 ‘--canonicalize’
1      Activate canonicalize mode.  If any component of the file name
1      except the last one is missing or unavailable, ‘readlink’ produces
1      no output and exits with a nonzero exit code.  A trailing slash is
1      ignored.
1 
1 ‘-e’
1 ‘--canonicalize-existing’
1      Activate canonicalize mode.  If any component is missing or
1      unavailable, ‘readlink’ produces no output and exits with a nonzero
1      exit code.  A trailing slash requires that the name resolve to a
1      directory.
1 
1 ‘-m’
1 ‘--canonicalize-missing’
1      Activate canonicalize mode.  If any component is missing or
1      unavailable, ‘readlink’ treats it as a directory.
1 
1 ‘-n’
1 ‘--no-newline’
1      Do not print the output delimiter, when a single FILE is specified.
1      Print a warning if specified along with multiple FILEs.
1 
1 ‘-s’
1 ‘-q’
1 ‘--silent’
1 ‘--quiet’
1      Suppress most error messages.  On by default.
1 
1 ‘-v’
1 ‘--verbose’
1      Report error messages.
1 
1 ‘-z’
1 ‘--zero’
1      Output a zero byte (ASCII NUL) at the end of each line, rather than
1      a newline.  This option enables other programs to parse the output
1      even when that output would contain data with embedded newlines.
1 
1    The ‘readlink’ utility first appeared in OpenBSD 2.1.
1 
1    The ‘realpath’ command without options, operates like ‘readlink’ in
1 canonicalize mode.
1 
1    An exit status of zero indicates success, and a nonzero value
1 indicates failure.
1