src/winln/winln.1

   1 .TH WINLN 1 "2 Apr 2013" "winln 1.3 (cygutils)" "Cygutils"
   2 .SH NAME
   3 winln \- create a Windows symbolic link
   4 .SH SYNOPSIS
   5 .B winln
   6 .RB [\-\fBsvfdFA\fP]
   7 .RB \fITARGET\fP\ \fILINKNAME\fP
   8 .br
   9 .B winln
  10 .RB [\-\fBsvfdFA\fP]
  11 .RB \fITARGET\fP
  12 .br
  13 .B winln
  14 .RB [\-\fBsvfdFA\fP]
  15 .RB \fITARGET...\fP\ \fIDIRECTORY\fP
  16 .br
  17 .B winln
  18 .RB [\-\fBsvfdFA\fP]
  19 .RB \-t\ \fIDIRECTORY\fP\ \fITARGET...\fP
  20 .br
  21 .SH DESCRIPTION
  22 .B winln
  23 is a drop-in replacement for ln(1), the difference being that
  24 .B winln
  25 creates Windows symbolic links instead of Cygwin ones.
  26 Note that Windows has two kinds of symbolic links: file
  27 links and directory links.
  28 .B winln
  29 automatically chooses the correct type of link when the target exists,
  30 but if the target does not exist, you may want to explicitly specify
  31 the kind of link to create.  Links to non-existent targets default to
  32 file links.
  33 .SH OPTIONS
  34
  35 .TP
  36 \fB\-s\fP, \fB\-\-symbolic\fP
  37 Create a symbolic (as opposed to hard) link.
  38 For compatibility with ln(1),
  39 creating hard links is the default.
  40
  41 .TP
  42 \fB\-v\fP, \fB\-\-verbose\fP
  43 Print to standard output the names of links created.
  44
  45 .TP
  46 \fB\-f\fP, \fB\-\-force\fP
  47 Replace existing destination file.
  48
  49 .TP
  50 \fB\-d\fP, \fB\-\-directory\fP
  51 Create a directory symbolic link.
  52
  53 .TP
  54 \fB\-F\fP, \fB\-\-file\fP
  55 Create a file symbolic link.
  56
  57 .TP
  58 \fB\-A\fP, \fB\-\-auto\fP
  59 Automatically determine the type of symbolic
  60 link to create.
  61 If the target exists and is a directory, create a
  62 directory symbolic link.
  63 Otherwise, create a file symbolic link.
  64
  65 .TP
  66 \fB\-t\fP, \fB\-\-target-directory\fP
  67 Treat DIRECTORY as the directory in which to create
  68 links based on the remaining arguments.
  69
  70 .TP
  71 \fB\-T\fP, \fB\-\-no-target-directory\fP
  72 Treat LINKNAME as a normal file always.
  73
  74 .TP
  75 \fB\-h\fP, \fB\-\-help\fP
  76 Show brief help message.
  77
  78 .TP
  79 \fB\-\-version\fP
  80 Display version information
  81
  82 .SH NOT\ IMPLEMENTED
  83 .B winln
  84 does not implement the following
  85 command line arguments from GNU ln(1):
  86 .br
  87 \fB-b\fP, \fB--backup\fP,
  88 \fB-i\fP, \fB--interactive\fP,
  89 \fB-L\fP, \fB--logical\fP,
  90 \fB-n\fP, \fB--no-dereference\fP,
  91 \fB-P\fP, \fB--physical\fP
  92
  93 .SH COPYRIGHT
  94 Copyright (C) 2011-2013 Daniel Colascione
  95 .PP
  96 \fBwinln\fP is free software: you can redistribute it and/or modify
  97 it under the terms of the GNU General Public License as published by
  98 the Free Software Foundation, either version 3 of the License, or
  99 (at your option) any later version.
 100 .PP
 101 \fBwinln\fP is distributed in the hope that it will be useful,
 102 but WITHOUT ANY WARRANTY; without even the implied warranty of
 103 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 104 GNU General Public License for more details.
 105 .PP
 106 You should have received a copy of the GNU General Public License
 107 along with this program.  If not, see
 108 .BR <http://www.gnu.org/licenses/>
 109 .PP
 110 See the COPYING file for full license information.
 111 .SH AUTHOR
 112 Daniel Colascione <dancol@dancol.org>