Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add detailed tag usage

  • Loading branch information...
commit e917f462e18ad2979a0a5cb5a0fd81be678582ba 1 parent 78c7274
Nicole Reid authored
Showing with 49 additions and 0 deletions.
  1. +49 −0 README.markdown
View
49 README.markdown
@@ -21,3 +21,52 @@ Create a plugin file within your Jekyll project's ```_plugins``` directory:
# _plugins/jekyll-beastiepress.rb
require "jekyll-beastiepress"
+
+Usage
+-----
+
+### man
+Syntax:
+
+ {% man [section] command ['release'] ['link text'] ['title text'] %}
+
+Examples:
+
+ {% man 8 lpc "FreeBSD 8.1-RELEASE" "the manpage" "Section 8 of the lpc manpage" %}
+ {% man 8 lpc "FreeBSD 8.1-RELEASE" %}
+ {% man lpc %}
+
+Output:
+
+ <a href='http://www.freebsd.org/cgi/man.cgi?query=lpc&sektion=8&manpath=FreeBSD 8.1-RELEASE' title='Section 8 of the lpc manpage'>the manpage</a>
+ <a href='http://www.freebsd.org/cgi/man.cgi?query=lpc&sektion=8&manpath=FreeBSD 8.1-RELEASE' title='man lpc(8) from FreeBSD 8.1-RELEASE'>lpc(8)</a>
+ <a href='http://www.freebsd.org/cgi/man.cgi?query=lpc&sektion=&manpath=' title='man lpc'>lpc</a>
+
+### port
+Syntax
+
+ {% port portname ['link text'] ['title text'] %}
+
+Example:
+
+ {% port www/subsonic "A link to www/subsonic on Freshports" "Subsonic" %}
+
+Output:
+
+ <a href='http://freshports.org/www/subsonic' title='A link to www/subsonic on Freshports'>Subsonic</a>
+
+### pr
+Syntax:
+
+ {% pr [category/]prnumber ['link text'] ['title text'] %}
+
+Example:
+
+ {% pr ports/151677 'the fix' 'Filename handling fix for cuetools.sh' %}
+ {% pr ports/151677 %}
+
+Output:
+
+ <a href='http://freshports.org/www/subsonic' title='Filename handling fix for cuetools.sh'>the fix</a>
+ <a href='http://www.freebsd.org/cgi/query-pr.cgi?pr=ports/151677' title='Problem Report ports/151677'>ports/151677</a>
+
Please sign in to comment.
Something went wrong with that request. Please try again.