Recent changes to documentation

WikiPage documentation modified by Tim-Erwin

Tim-Erwin — Sat, 08 Oct 2011 23:04:07 -0000

--- v3 
+++ v4 
@@ -16,10 +16,10 @@
 -----
 ~~~~~~~~~~~~
 pylnk parse c:\dir\shortcut
-pylnk parse c:\dir\shortcut path,hot_key
+pylnk parse c:\dir\shortcut path hot_key
 ~~~~~~~~~~~~
 
-The parse command reads a shortcut file, parses it and prints all information to std out. If a comma separated list of properties is given, those properties will be printed out, each on one line in the order they are given.
+The parse command reads a shortcut file, parses it and prints all information to std out. If a space separated list of properties is given, those properties will be printed out, each on one line in the order they are given.

WikiPage documentation modified by Tim-Erwin

Tim-Erwin — Sat, 08 Oct 2011 22:41:20 -0000

--- v2 
+++ v3 
@@ -1,5 +1,30 @@
-Usage
-=====
+Commandline Usage
+=================
+
+There are two commands: create and parse which are the first argument.
+
+create
+------
+~~~~~~~~~~~~
+pylnk create c:\dir\file.txt shortcut
+~~~~~~~~~~~~
+
+This command creates a shortcut for a file.
+
+
+parse
+-----
+~~~~~~~~~~~~
+pylnk parse c:\dir\shortcut
+pylnk parse c:\dir\shortcut path,hot_key
+~~~~~~~~~~~~
+
+The parse command reads a shortcut file, parses it and prints all information to std out. If a comma separated list of properties is given, those properties will be printed out, each on one line in the order they are given.
+
+
+
+Programming Interface
+=====================
 
 Parse an existing LNK
 ---------------------

WikiPage documentation modified by Tim-Erwin

Tim-Erwin — Sat, 08 Oct 2011 21:10:46 -0000

--- v1 
+++ v2 
@@ -1,7 +1,47 @@
-
-
+Usage
+=====
+
+Parse an existing LNK
+---------------------
+~~~~~~~~~~~~
+:::python
+import pylnk
+link = pylnk.parse("C:\\path\\to\\shortcut to file.lnk")
+print link.description
+print link.path
+~~~~~~~~~~~~
+
+The parse function creates a Lnk object from an existing LNK file. Currently, only LNKs with paths that start with a drive letter are supported.
+
+Create a LNK for a file
+-----------------------
+~~~~~~~~~~~~
+:::python
+import pylnk
+link = pylnk.for_file("C:\\path\\to\\some file")
+link.hot_key = "CONTROL+ALT+F"
+link.save("C:\\path\\to\\shortcut to some file")
+~~~~~~~~~~~~
+
+*for_file()* takes as first argument the target file to create a shortcut for. As second, optional, argument you can specify the shortcut name and then omit it in the *save()* method.
+
+Create an empty LNK
+-------------------
+~~~~~~~~~~~~
+:::python
+import pylnk
+link = pylnk.create("C:\\path\\to\\crafted shortcut")
+...
+# populate Lnk object here
+...
+link.save()
+~~~~~~~~~~~~
+If you know how, you can create a shortcut file from scratch with *create()*. You can leave out the file name there and specify it when saving instead. Creating LNKs from scratch unfortunately needs some knowledge about their internals.
+
+
+
 About the .lnk format
----------------------
+=====================
 * The definitive source about the .lnk format is of course the [official specification](http://download.microsoft.com/download/a/e/6/ae6e4142-aa58-45c6-8dcf-a657e5900cd3/%5BMS-SHLLINK%5D.pdf).
 * However, it does not specify the most important part of .lnk files. There are two great [blog](http://blog.0x01000000.org/2010/08/10/lnk-parsing-youre-doing-it-wrong-i/) [posts](http://blog.0x01000000.org/2010/08/13/lnk-parsing-youre-doing-it-wrong-ii/) that explain that part in detail.
 * Also Jesse Hager has reverse engineered the format (before it was published by Microsoft). He made is [findings available](http://code.google.com/p/8bits/downloads/detail?name=The_Windows_Shortcut_File_Format.pdf) including an example of a shortcut file.

WikiPage documentation modified by Tim-Erwin

Tim-Erwin — Sat, 08 Oct 2011 20:26:08 -0000

About the .lnk format --------------------- * The definitive source about the .lnk format is of course the [official specification](http://download.microsoft.com/download/a/e/6/ae6e4142-aa58-45c6-8dcf-a657e5900cd3/%5BMS-SHLLINK%5D.pdf). * However, it does not specify the most important part of .lnk files. There are two great [blog](http://blog.0x01000000.org/2010/08/10/lnk-parsing-youre-doing-it-wrong-i/) [posts](http://blog.0x01000000.org/2010/08/13/lnk-parsing-youre-doing-it-wrong-ii/) that explain that part in detail. * Also Jesse Hager has reverse engineered the format (before it was published by Microsoft). He made is [findings available](http://code.google.com/p/8bits/downloads/detail?name=The_Windows_Shortcut_File_Format.pdf) including an example of a shortcut file.