syclink 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +2 -0
  3. data/.rspec +1 -0
  4. data/Gemfile +2 -0
  5. data/Gemfile.lock +33 -0
  6. data/LICENSE +21 -0
  7. data/README.md +191 -0
  8. data/README.rdoc +9 -0
  9. data/Rakefile +5 -0
  10. data/bin/syclink +290 -0
  11. data/doc/Gemfile.html +109 -0
  12. data/doc/Gemfile_lock.html +147 -0
  13. data/doc/LICENSE.html +129 -0
  14. data/doc/Object.html +188 -0
  15. data/doc/README_md.html +322 -0
  16. data/doc/README_rdoc.html +171 -0
  17. data/doc/SycLink/Designer.html +560 -0
  18. data/doc/SycLink/Exporter.html +149 -0
  19. data/doc/SycLink/Formatter.html +416 -0
  20. data/doc/SycLink/Infrastructure.html +297 -0
  21. data/doc/SycLink/Link.html +296 -0
  22. data/doc/SycLink/Website.html +428 -0
  23. data/doc/SycLink.html +127 -0
  24. data/doc/created.rid +31 -0
  25. data/doc/css/fonts.css +167 -0
  26. data/doc/css/rdoc.css +590 -0
  27. data/doc/fonts/Lato-Light.ttf +0 -0
  28. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  29. data/doc/fonts/Lato-Regular.ttf +0 -0
  30. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  31. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  32. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  33. data/doc/images/add.png +0 -0
  34. data/doc/images/arrow_up.png +0 -0
  35. data/doc/images/brick.png +0 -0
  36. data/doc/images/brick_link.png +0 -0
  37. data/doc/images/bug.png +0 -0
  38. data/doc/images/bullet_black.png +0 -0
  39. data/doc/images/bullet_toggle_minus.png +0 -0
  40. data/doc/images/bullet_toggle_plus.png +0 -0
  41. data/doc/images/date.png +0 -0
  42. data/doc/images/delete.png +0 -0
  43. data/doc/images/find.png +0 -0
  44. data/doc/images/loadingAnimation.gif +0 -0
  45. data/doc/images/macFFBgHack.png +0 -0
  46. data/doc/images/package.png +0 -0
  47. data/doc/images/page_green.png +0 -0
  48. data/doc/images/page_white_text.png +0 -0
  49. data/doc/images/page_white_width.png +0 -0
  50. data/doc/images/plugin.png +0 -0
  51. data/doc/images/ruby.png +0 -0
  52. data/doc/images/tag_blue.png +0 -0
  53. data/doc/images/tag_green.png +0 -0
  54. data/doc/images/transparent.png +0 -0
  55. data/doc/images/wrench.png +0 -0
  56. data/doc/images/wrench_orange.png +0 -0
  57. data/doc/images/zoom.png +0 -0
  58. data/doc/index.html +131 -0
  59. data/doc/js/darkfish.js +161 -0
  60. data/doc/js/jquery.js +4 -0
  61. data/doc/js/navigation.js +142 -0
  62. data/doc/js/navigation.js.gz +0 -0
  63. data/doc/js/search.js +109 -0
  64. data/doc/js/search_index.js +1 -0
  65. data/doc/js/search_index.js.gz +0 -0
  66. data/doc/js/searcher.js +228 -0
  67. data/doc/js/searcher.js.gz +0 -0
  68. data/doc/links_csv.html +113 -0
  69. data/doc/setup_md.html +192 -0
  70. data/doc/syclink_gemspec.html +133 -0
  71. data/doc/syclink_rdoc.html +154 -0
  72. data/doc/table_of_contents.html +336 -0
  73. data/doc/templates/example_html.html +399 -0
  74. data/doc/templates/links.html +116 -0
  75. data/doc/templates/stylesheets/style_css.html +170 -0
  76. data/doc/templates/stylesheets/style_css_map.html +111 -0
  77. data/doc/templates/stylesheets/style_css_scss.html +198 -0
  78. data/doc/templates/syc-link_html.html +235 -0
  79. data/lib/syclink/designer.rb +97 -0
  80. data/lib/syclink/designer_example.rb +9 -0
  81. data/lib/syclink/exporter.rb +17 -0
  82. data/lib/syclink/formatter.rb +70 -0
  83. data/lib/syclink/infrastructure.rb +44 -0
  84. data/lib/syclink/link.rb +62 -0
  85. data/lib/syclink/version.rb +7 -0
  86. data/lib/syclink/website.rb +62 -0
  87. data/lib/syclink/website_example.rb +68 -0
  88. data/lib/syclink.rb +7 -0
  89. data/setup.md +92 -0
  90. data/spec/syclink/designer_spec.rb +100 -0
  91. data/spec/syclink/link_spec.rb +47 -0
  92. data/spec/syclink/website_spec.rb +75 -0
  93. data/syclink.gemspec +23 -0
  94. data/syclink.rdoc +39 -0
  95. data/templates/links +4 -0
  96. data/templates/stylesheets/style.css +55 -0
  97. data/templates/stylesheets/style.css.map +7 -0
  98. data/templates/stylesheets/style.css.scss +76 -0
  99. data/templates/syc-link.html +123 -0
  100. data/templates/syclink.html.erb +63 -0
  101. metadata +193 -0
data/doc/README_md.html ADDED
@@ -0,0 +1,322 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>README - RDoc Documentation</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "./";
11
+ </script>
12
+
13
+ <script src="./js/jquery.js"></script>
14
+ <script src="./js/darkfish.js"></script>
15
+
16
+ <link href="./css/fonts.css" rel="stylesheet">
17
+ <link href="./css/rdoc.css" rel="stylesheet">
18
+
19
+
20
+
21
+ <body id="top" role="document" class="file">
22
+ <nav role="navigation">
23
+ <div id="project-navigation">
24
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
25
+ <h2>
26
+ <a href="./index.html" rel="home">Home</a>
27
+ </h2>
28
+
29
+ <div id="table-of-contents-navigation">
30
+ <a href="./table_of_contents.html#pages">Pages</a>
31
+ <a href="./table_of_contents.html#classes">Classes</a>
32
+ <a href="./table_of_contents.html#methods">Methods</a>
33
+ </div>
34
+ </div>
35
+
36
+ <div id="search-section" role="search" class="project-section initially-hidden">
37
+ <form action="#" method="get" accept-charset="utf-8">
38
+ <div id="search-field-wrapper">
39
+ <input id="search-field" role="combobox" aria-label="Search"
40
+ aria-autocomplete="list" aria-controls="search-results"
41
+ type="text" name="search" placeholder="Search" spellcheck="false"
42
+ title="Type to search, Up and Down to navigate, Enter to load">
43
+ </div>
44
+
45
+ <ul id="search-results" aria-label="Search Results"
46
+ aria-busy="false" aria-expanded="false"
47
+ aria-atomic="false" class="initially-hidden"></ul>
48
+ </form>
49
+ </div>
50
+
51
+ </div>
52
+
53
+
54
+ <div class="nav-section">
55
+ <h3>Table of Contents</h3>
56
+
57
+ <ul class="link-list" role="directory">
58
+ <li><a href="#label-syclink">syclink</a>
59
+ <li><a href="#label-Installation">Installation</a>
60
+ <li><a href="#label-Command+Line+Interface">Command Line Interface</a>
61
+ <li><a href="#label-Templates">Templates</a>
62
+ <li><a href="#label-Command+Line">Command Line</a>
63
+ <li><a href="#label-Commands">Commands</a>
64
+ <li><a href="#label-Create+a+website">Create a website</a>
65
+ <li><a href="#label-Add+a+link">Add a link</a>
66
+ <li><a href="#label-Update+a+link">Update a link</a>
67
+ <li><a href="#label-Remove+a+Link">Remove a Link</a>
68
+ <li><a href="#label-List+links">List links</a>
69
+ <li><a href="#label-Find+links">Find links</a>
70
+ <li><a href="#label-List+websites">List websites</a>
71
+ <li><a href="#label-Remove+websites">Remove websites</a>
72
+ <li><a href="#label-Make+a+html+representation+of+the+website">Make a html representation of the website</a>
73
+ <li><a href="#label-Workflow">Workflow</a>
74
+ </ul>
75
+ </div>
76
+
77
+
78
+ <div id="project-metadata">
79
+ <div id="fileindex-section" class="nav-section">
80
+ <h3>Pages</h3>
81
+
82
+ <ul class="link-list">
83
+
84
+ <li><a href="./Gemfile.html">Gemfile</a>
85
+
86
+ <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
87
+
88
+ <li><a href="./LICENSE.html">LICENSE</a>
89
+
90
+ <li><a href="./README_md.html">README</a>
91
+
92
+ <li><a href="./README_rdoc.html">README</a>
93
+
94
+ <li><a href="./links_csv.html">links.csv</a>
95
+
96
+ <li><a href="./setup_md.html">setup</a>
97
+
98
+ <li><a href="./syclink_gemspec.html">syclink.gemspec</a>
99
+
100
+ <li><a href="./syclink_rdoc.html">syclink</a>
101
+
102
+ <li><a href="./templates/example_html.html">example.html</a>
103
+
104
+ <li><a href="./templates/links.html">links</a>
105
+
106
+ <li><a href="./templates/stylesheets/style_css.html">style.css</a>
107
+
108
+ <li><a href="./templates/stylesheets/style_css_map.html">style.css.map</a>
109
+
110
+ <li><a href="./templates/stylesheets/style_css_scss.html">style.css.scss</a>
111
+
112
+ <li><a href="./templates/syc-link_html.html">syc-link.html</a>
113
+
114
+ </ul>
115
+ </div>
116
+
117
+ </div>
118
+ </nav>
119
+
120
+ <main role="main" aria-label="Page README.md">
121
+
122
+ <h1 id="label-syclink">syclink<span><a href="#label-syclink">&para;</a> <a href="#top">&uarr;</a></span></h1>
123
+
124
+ <p><em>syclink</em> is a comand line application to create a website with a
125
+ link collection. <em>syclink</em> allows to add, update and delete links.</p>
126
+
127
+ <h1 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h1>
128
+
129
+ <p>The application is installed with <em>RubyGems</em></p>
130
+
131
+ <pre>$ gem install syclink</pre>
132
+
133
+ <h1 id="label-Command+Line+Interface">Command Line Interface<span><a href="#label-Command+Line+Interface">&para;</a> <a href="#top">&uarr;</a></span></h1>
134
+
135
+ <p><em>syclink</em> comes with a default website template and a CSS file. This
136
+ can be adjusted to your convenience.</p>
137
+
138
+ <h2 id="label-Templates">Templates<span><a href="#label-Templates">&para;</a> <a href="#top">&uarr;</a></span></h2>
139
+
140
+ <p>The templates are located in ~/.syc/syclink/templates and can be adjusted
141
+ or completely replaced.</p>
142
+
143
+ <h2 id="label-Command+Line">Command Line<span><a href="#label-Command+Line">&para;</a> <a href="#top">&uarr;</a></span></h2>
144
+
145
+ <p>Following list comprises the commands available</p>
146
+
147
+ <p><em>Website commands</em> * website show - show all websites or search for
148
+ websites * website remove - Remove website * website create - Create a HTML
149
+ representation of the website</p>
150
+
151
+ <p><em>Link commands</em> * add - Add a link * file - Add links from a file *
152
+ update - Update a link * delete - Delete a link * list - List all links
153
+ with an optional filter * find - Find links based on a search string</p>
154
+
155
+ <h1 id="label-Commands">Commands<span><a href="#label-Commands">&para;</a> <a href="#top">&uarr;</a></span></h1>
156
+
157
+ <p>Following the commands and how to use them is explained based on examples.</p>
158
+
159
+ <h2 id="label-Create+a+website">Create a website<span><a href="#label-Create+a+website">&para;</a> <a href="#top">&uarr;</a></span></h2>
160
+
161
+ <p>A website is send to syclink with the global <code>-w</code> flag. If the
162
+ website does not exist yet the user is asked whether to create it and
163
+ whether to set it as the default website. This is done with commands that
164
+ require a website to operate on.</p>
165
+
166
+ <pre>$ syclink -w my-new-website add &quot;http://example.com&quot;</pre>
167
+
168
+ <p>Before the command <code>add</code> is executed the website is created. In
169
+ this case a website called &#39;my-new-website&#39; is created in the
170
+ default directory at `~/.syc/syclink/websites/my-new-website.website</p>
171
+
172
+ <p>Commands that require a website are <code>add</code>, <code>update</code>,
173
+ <code>delete</code>, <code>list</code>, <code>find</code> and <code>website
174
+ create</code>.</p>
175
+
176
+ <p>If no website is specified the default website is used.</p>
177
+
178
+ <h2 id="label-Add+a+link">Add a link<span><a href="#label-Add+a+link">&para;</a> <a href="#top">&uarr;</a></span></h2>
179
+
180
+ <p>A link may have a title, a description and a tag. Title, description and
181
+ tag are optional but a link obviously has to be provided. If no title is
182
+ given the link is used as the title.</p>
183
+
184
+ <pre>$ syclink add --title &quot;Test page&quot; --tag TEST \
185
+ --description &#39;For testing purposes&#39; http://example.com</pre>
186
+
187
+ <p>It is also possible to add links from a file</p>
188
+
189
+ <pre>$ syclink file file-with-links</pre>
190
+
191
+ <h2 id="label-Update+a+link">Update a link<span><a href="#label-Update+a+link">&para;</a> <a href="#top">&uarr;</a></span></h2>
192
+
193
+ <p>To update a link the URL has to be specified. If more than one link has the
194
+ same URL only the first link is updated.</p>
195
+
196
+ <pre>$ syclink update --title &quot;Example&quot; http://example.com</pre>
197
+
198
+ <h2 id="label-Remove+a+Link">Remove a Link<span><a href="#label-Remove+a+Link">&para;</a> <a href="#top">&uarr;</a></span></h2>
199
+
200
+ <p>To remove one or more links the URLs have to be provided.</p>
201
+
202
+ <pre>$ syclink delete http://example.com,http://challenge.com</pre>
203
+
204
+ <h2 id="label-List+links">List links<span><a href="#label-List+links">&para;</a> <a href="#top">&uarr;</a></span></h2>
205
+
206
+ <p>Links can be selected based on a filter. If no filter is given all links
207
+ are listed. It is possible to specify the columns to print. Possible
208
+ columns are <code>url</code>, <code>name</code>, <code>description</code>
209
+ and <code>tag</code>.</p>
210
+
211
+ <pre>$ syclink list --tag TEST --columns &#39;url,description&#39;
212
+
213
+ url | description
214
+ -------------------+---------------------
215
+ http://example.com | For testing purposes</pre>
216
+
217
+ <h2 id="label-Find+links">Find links<span><a href="#label-Find+links">&para;</a> <a href="#top">&uarr;</a></span></h2>
218
+
219
+ <p>It is also possible to search for links based on a search string. The find
220
+ command searches all attributes of the links and is searching for the
221
+ occurance of the search string within the attributes. So the search is not
222
+ list only exact matches.</p>
223
+
224
+ <pre>$ syclink find --columns &#39;url,tag&#39; &#39;example&#39;
225
+
226
+ url | tag
227
+ -------------------+-----
228
+ http://example.com | TEST</pre>
229
+
230
+ <h2 id="label-List+websites">List websites<span><a href="#label-List+websites">&para;</a> <a href="#top">&uarr;</a></span></h2>
231
+
232
+ <p>The websites are saved to <code>~/.syc/syclink/websites/</code> and the
233
+ html representations are saved to <code>~/.syc/syclink/html/</code>. When
234
+ listing websites both <em>webstites</em> and <em>html</em> files are
235
+ listed.</p>
236
+
237
+ <p>The following command will list all websites</p>
238
+
239
+ <pre>$ syclink website list</pre>
240
+
241
+ <p>To list websites based on a search string the search string has to be send
242
+ to the list command</p>
243
+
244
+ <pre>$ syclink website list &quot;example&quot;</pre>
245
+
246
+ <p>If the <code>--exact</code> switch is given the command is only listing
247
+ exact matches of the search string</p>
248
+
249
+ <pre>$ syclink website list -e &quot;http://example.com&quot;</pre>
250
+
251
+ <h2 id="label-Remove+websites">Remove websites<span><a href="#label-Remove+websites">&para;</a> <a href="#top">&uarr;</a></span></h2>
252
+
253
+ <p>Websites and their html representations can be deleted based on a filter
254
+ string. To delete all websites and respective html representation the
255
+ filter string &#39;*&#39; can be provided</p>
256
+
257
+ <pre>$ syclink website remove &quot;*&quot;
258
+
259
+ About to delete:
260
+
261
+ Websites
262
+ --------
263
+ /home/user/.syc/syclink/website/example.website
264
+
265
+ HTML-Files
266
+ ----------
267
+ /home/user/.syc/syclink/html/example.html
268
+
269
+ Delete websites and corresponding html files (y/n)?</pre>
270
+
271
+ <p>Other exmamples of filter strings are <code>*mple</code> which will find
272
+ <code>example</code> as well as <code>ex*</code>.</p>
273
+
274
+ <h2 id="label-Make+a+html+representation+of+the+website">Make a html representation of the website<span><a href="#label-Make+a+html+representation+of+the+website">&para;</a> <a href="#top">&uarr;</a></span></h2>
275
+
276
+ <p>The ultimate command is <code>website create</code> which will create the
277
+ html representation of the website.</p>
278
+
279
+ <p>The html file is created based on an erb file located in
280
+ <code>~/.syc/syclink/templates/syclink.html.erb</code>. This can be
281
+ adjusted to your convenience. The methods that can be used can be looked up
282
+ in <code>lib/syctask/website.rb</code>.</p>
283
+
284
+ <p>The html file will search for a css file in the directory
285
+ <code>stylesheets</code> which is relative to the html file. The stylesheet
286
+ is named <code>styles.css</code>. It is possible to change it or replace it
287
+ entirely. If the stylesheet&#39;s name is changed this also has to be done
288
+ in <code>~/.syc/syclink/templates/syclink.html.erb</code>.</p>
289
+
290
+ <p>There is also a <em>scss</em> file which needs to be compiled to
291
+ <em>css</em> with <em>sass</em> like so</p>
292
+
293
+ <pre>$ sass ~/.syc/syclink/html/stylesheets/styles.css.scss:\
294
+ ~/.syc/syclink/html/stylesheets/styles.css</pre>
295
+
296
+ <p>Warning: If the <em>css</em> file has been changed all changes will be
297
+ overridden by <em>sass</em>.</p>
298
+
299
+ <h1 id="label-Workflow">Workflow<span><a href="#label-Workflow">&para;</a> <a href="#top">&uarr;</a></span></h1>
300
+
301
+ <p>To create a website the steps are as follows</p>
302
+ <ul><li>
303
+ <p>add links to a website</p>
304
+ </li><li>
305
+ <p>create the html representation</p>
306
+ </li></ul>
307
+
308
+ <p>Following is showing the above sequence in commands</p>
309
+
310
+ <pre>$ syclink -w example add &quot;http://example.com&quot; --tag EXAMPLE
311
+ $ syclink add &quot;http://github.com&quot; --tag DEVELOPMENT
312
+ $ syclink website create</pre>
313
+ </main>
314
+
315
+
316
+
317
+ <footer id="validator-badges" role="contentinfo">
318
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
319
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
320
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
321
+ </footer>
322
+
data/doc/README_rdoc.html ADDED
@@ -0,0 +1,171 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>README - RDoc Documentation</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "./";
11
+ </script>
12
+
13
+ <script src="./js/jquery.js"></script>
14
+ <script src="./js/darkfish.js"></script>
15
+
16
+ <link href="./css/fonts.css" rel="stylesheet">
17
+ <link href="./css/rdoc.css" rel="stylesheet">
18
+
19
+
20
+
21
+ <body id="top" role="document" class="file">
22
+ <nav role="navigation">
23
+ <div id="project-navigation">
24
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
25
+ <h2>
26
+ <a href="./index.html" rel="home">Home</a>
27
+ </h2>
28
+
29
+ <div id="table-of-contents-navigation">
30
+ <a href="./table_of_contents.html#pages">Pages</a>
31
+ <a href="./table_of_contents.html#classes">Classes</a>
32
+ <a href="./table_of_contents.html#methods">Methods</a>
33
+ </div>
34
+ </div>
35
+
36
+ <div id="search-section" role="search" class="project-section initially-hidden">
37
+ <form action="#" method="get" accept-charset="utf-8">
38
+ <div id="search-field-wrapper">
39
+ <input id="search-field" role="combobox" aria-label="Search"
40
+ aria-autocomplete="list" aria-controls="search-results"
41
+ type="text" name="search" placeholder="Search" spellcheck="false"
42
+ title="Type to search, Up and Down to navigate, Enter to load">
43
+ </div>
44
+
45
+ <ul id="search-results" aria-label="Search Results"
46
+ aria-busy="false" aria-expanded="false"
47
+ aria-atomic="false" class="initially-hidden"></ul>
48
+ </form>
49
+ </div>
50
+
51
+ </div>
52
+
53
+
54
+ <div class="nav-section">
55
+ <h3>Table of Contents</h3>
56
+
57
+ <ul class="link-list" role="directory">
58
+ <li><a href="#label-syclink">syclink</a>
59
+ <li><a href="#label-syclink">syclink</a>
60
+ </ul>
61
+ </div>
62
+
63
+
64
+ <div id="project-metadata">
65
+ <div id="fileindex-section" class="nav-section">
66
+ <h3>Pages</h3>
67
+
68
+ <ul class="link-list">
69
+
70
+ <li><a href="./Gemfile.html">Gemfile</a>
71
+
72
+ <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
73
+
74
+ <li><a href="./LICENSE.html">LICENSE</a>
75
+
76
+ <li><a href="./README_md.html">README</a>
77
+
78
+ <li><a href="./README_rdoc.html">README</a>
79
+
80
+ <li><a href="./links_csv.html">links.csv</a>
81
+
82
+ <li><a href="./setup_md.html">setup</a>
83
+
84
+ <li><a href="./syclink_gemspec.html">syclink.gemspec</a>
85
+
86
+ <li><a href="./syclink_rdoc.html">syclink</a>
87
+
88
+ <li><a href="./templates/example_html.html">example.html</a>
89
+
90
+ <li><a href="./templates/links.html">links</a>
91
+
92
+ <li><a href="./templates/stylesheets/style_css.html">style.css</a>
93
+
94
+ <li><a href="./templates/stylesheets/style_css_map.html">style.css.map</a>
95
+
96
+ <li><a href="./templates/stylesheets/style_css_scss.html">style.css.scss</a>
97
+
98
+ <li><a href="./templates/syc-link_html.html">syc-link.html</a>
99
+
100
+ </ul>
101
+ </div>
102
+
103
+ </div>
104
+ </nav>
105
+
106
+ <main role="main" aria-label="Page README.rdoc">
107
+
108
+ <h1 id="label-syclink">syclink<span><a href="#label-syclink">&para;</a> <a href="#top">&uarr;</a></span></h1>
109
+
110
+ <p>syclink can be used to create link list and turn them into an html
111
+ representation.</p>
112
+
113
+ <p>Detailed information about the usage can be found at <a
114
+ href="README.md">README.md</a></p>
115
+
116
+ <h1 id="label-syclink">syclink<span><a href="#label-syclink">&para;</a> <a href="#top">&uarr;</a></span></h1>
117
+
118
+ <p>NAME</p>
119
+
120
+ <pre>syclink - Create a link list and display it as an html page</pre>
121
+
122
+ <p>SYNOPSIS</p>
123
+
124
+ <pre>syclink [global options] command [command options] [arguments...]</pre>
125
+
126
+ <p>VERSION</p>
127
+
128
+ <pre>0.0.1</pre>
129
+
130
+ <p>GLOBAL OPTIONS</p>
131
+
132
+ <pre>--help - Show this message
133
+ --version - Display the program version
134
+ -w, --website=WEBSITE - Website to operate on (default: none)</pre>
135
+
136
+ <p>COMMANDS</p>
137
+
138
+ <pre>add - Add a link to the website
139
+ delete - Remove one or more links
140
+ file - Add links from a file to the website
141
+ find - Find a link
142
+ help - Shows a list of commands or help for one command
143
+ list - List and optionally filter links
144
+ update - Update a link
145
+ website - Operate on websites</pre>
146
+
147
+ <p>NAME</p>
148
+
149
+ <pre>website - Operate on websites</pre>
150
+
151
+ <p>SYNOPSIS</p>
152
+
153
+ <pre>syclink [global options] website [create]
154
+ syclink [global options] website remove WEBSITE_PATTERN
155
+ syclink [global options] website show [-e|--exact] WEBSITE</pre>
156
+
157
+ <p>COMMANDS</p>
158
+
159
+ <pre>create - Create html representation of website (default)
160
+ remove - Remove one or more websites
161
+ show - Show all websites or search for websites</pre>
162
+ </main>
163
+
164
+
165
+
166
+ <footer id="validator-badges" role="contentinfo">
167
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
168
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
169
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
170
+ </footer>
171
+