src/readshortcut/readshortcut.1

   1 .TH "READSHORTCUT" 1 "4 September 2003" "readshortcut 1.00 (cygutils)" "Cygutils"
   2 .SH NAME
   3 readshortcut \- read data from a windows shortcut (.lnk) file
   4 .\"{{{  Synopsis
   5 .SH SYNOPSIS
   6 .B readshortcut
   7 .RB [OPTION]*
   8 .RB "SHORTCUT"
   9 .BR
  10 .\"}}}
  11 .SH DESCRIPTION
  12 .B readshortcut
  13 is a command-line tool for reading Windows shortcut files (also known as
  14 OLE links). The most practical use is to resolve the target that a shortcut
  15 points to.  It can be easily run from a script or batch file for non-interactive
  16 use.
  17
  18 .SH OPTIONS
  19
  20 .TP
  21 \fB\-h\fR, \fB\-\-help\fR
  22 Output detailed usage information and exit.
  23
  24 .TP
  25 \fB\-\-usage\fR
  26 Output basic usage information and exit.
  27
  28 .TP
  29 \fB\-v\fR, \fB\-\-version\fR
  30 Display the program version and exit.
  31
  32 .TP
  33 \fB\-\-license\fR
  34 Display the license agreement and exit.
  35
  36 .TP
  37 \fB\-f\fR, \fB\-\-fields\fR
  38 Show field names (Target, Working Directory, Arguments, Show Command, Icon Library, Icon Library Offset, Description).
  39
  40 .TP
  41 \fB\-u\fR, \fB\-\-unix\fR
  42 Use Unix path format for display (default).
  43
  44 .TP
  45 \fB\-w\fR, \fB\-\-windows\fR
  46 Use Windows path format for display.
  47
  48 .TP
  49 \fB\-t\fR, \fB\-\-target\fR
  50 Display shortcut target (default).
  51
  52 .TP
  53 \fB\-g\fR, \fB\-\-working\fR
  54 Display shortcut working directory.
  55
  56 .TP
  57 \fB\-r\fR, \fB\-\-args\fR
  58 Display shortcut arguments
  59
  60 .TP
  61 \fB\-s\fR, \fB\-\-showcmd\fR
  62 Display shortcut "show" command value (Normal, Minimized, or Maximized).
  63
  64 .TP
  65 \fB\-i\fR, \fB\-\-icon\fR
  66 Display icon library location.
  67
  68 .TP
  69 \fB\-j\fR, \fB\-\-offset\fR
  70 Display icon library offset.
  71
  72 .TP
  73 \fB\-d\fR, \fB\-\-desc\fR
  74 Display shortcut description.
  75
  76 .TP
  77 \fB\-a\fR, \fB\-\-all\fR
  78 Display all information.
  79
  80 .SH NOTES
  81 The filename (shortcut) argument may be unix (POSIX) format or Windows (C:\\) format.
  82 .PP
  83 Information extracted from the shortcut is always displayed in the following order: Target, Working Directory, Arguments, Show Command, Icon Library, Icon Library Offset, Description.  Each element appears on a separate line.
  84
  85 .SH BUGS
  86 There may be problems if the SHORTCUT argument is longer than 256 characters
  87
  88 .SH COPYRIGHT
  89 Copyright (C) 2003 Rob Siklos
  90 .PP
  91 \fBreadshortcut\fP is free software; you can redistribute it and/or modify
  92 it under the terms of the GNU General Public License as published by
  93 the Free Software Foundation; either version 2, or (at your option) any
  94 later version.
  95 .PP
  96 \fBreadshortcut\fP is distributed in the hope that it will be useful, but
  97 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  98 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  99 more details.
 100 .PP
 101 You should have received a copy of the GNU General Public License;
 102 see the file COPYING. If not, write to the
 103 Free Software Foundation,
 104 59 Temple Place,
 105 Suite 330, Boston, MA  02111-1307, USA.
 106
 107 .SH AUTHOR
 108 Rob Siklos, (r o b 3 @ s i k l o s . c a), Toronto, Canada
 109
 110 .SH "SEE ALSO"
 111 .BR mkshortcut (1)
 112 .BR readlink (1)