.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "STRUT 1p"
.TH STRUT 1p "2012-04-23" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
strut \- command line interface (using Socialtext::Resting) to the 
Socialtext REST services
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   strut help
\&
\&   strut configure
\&   
\&   strut list_workspaces
\&   strut list_pages <workspace>
\&
\&   strut get_page <workspace> <pagename>
\&   strut set_page <workspace> <pagename> <filename>
\&
\&   strut list_tags <workspace> <pagename>
\&   strut put_tag <workspace> <pagename> <tag>
\&   strut set_tags <workspace> <pagename> <tags>
\&
\&   strut list_tagged_pages <workspace> <tag>
\&
\&   strut list_attachments <workspace> <pagename>
\&   strut get_attachment <workspace> <pagename> <attachment>
\&   strut add_attachment <workspace> <pagename> <filename>
\&
\&   strut show_breadcrumbs <workspace>
\&   strut show_backlinks <workspace> <pagename>
\&   strut show_frontlinks <workspace> <pagename>
\&
\&   All list operations can further be controlled with the following operations:
\&   \-\-query (search term for within the results)
\&   \-\-filter (filter the titles of the results)
\&   \-\-order (only accepts \*(Aqnewest\*(Aq right now)
\&   \-\-count (restrict number of returned results)
\&   \-\-accept (for your accept headers \- text/html, text/plain, application/json)
\&
\&   Example:
\&     strut \-\-query=searchterm \-\-filter=titlefilter \-\-order=newest \-\-count=number list_pages myworkspace
.Ve
.SH "COMMANDS"
.IX Header "COMMANDS"
The following commands are supported
.SS "help"
.IX Subsection "help"
Standard man page for this program
.SS "configure"
.IX Subsection "configure"
Configure strut with username, password, and server information.  See
the \s-1CONFIGURATION\s0 section below for a discussion of your configuration
options.
.SS "show_breadcrumbs"
.IX Subsection "show_breadcrumbs"
Get the breadcrumbs for the current user in this workspace.
.SS "list_workspaces"
.IX Subsection "list_workspaces"
Give a list of all workspaces on the server
.SS "list_workspace_tags <workspace>"
.IX Subsection "list_workspace_tags <workspace>"
List the tags for a workspace.
.SS "list_pages <workspace>"
.IX Subsection "list_pages <workspace>"
Give a list of all pages in the given workspace.  If no workspace
is given you will be prompted to pick from available workspaces.
.SS "list_tagged_pages <workspace>"
.IX Subsection "list_tagged_pages <workspace>"
Give a list of all pages in the given workspace with the given tag.
.SS "get_page <workspace> <page_name>"
.IX Subsection "get_page <workspace> <page_name>"
Retrieve the contents of the specified page.  If no
workspace or page are given the user will be prompted
to select from the available workspaces/pages.
.SS "set_page <workspace> <page_name> <filename>"
.IX Subsection "set_page <workspace> <page_name> <filename>"
Save the specified page on the system.
.SS "add_attachment <workspace> <page_name> <filename>"
.IX Subsection "add_attachment <workspace> <page_name> <filename>"
Add the attachment to the specified page on the system.
.SS "list_attachments <workspace> <page_name>"
.IX Subsection "list_attachments <workspace> <page_name>"
List all attachments on the specified page.
.SS "list_pagetags <workspace> <page_name>"
.IX Subsection "list_pagetags <workspace> <page_name>"
List all tags on the specified page.
.SS "show_backlinks <workspace> <page_name>"
.IX Subsection "show_backlinks <workspace> <page_name>"
Show backlinks to the specified page name.
.SS "show_frontlinks <workspace> <page_name>"
.IX Subsection "show_frontlinks <workspace> <page_name>"
Show frontlinks to the specified page name.
.SS "put_tag <workspace> <page_name> <tag>"
.IX Subsection "put_tag <workspace> <page_name> <tag>"
Add the specified tag to the specified page name.
.SS "set_tags <workspace> <page_name> <tags>"
.IX Subsection "set_tags <workspace> <page_name> <tags>"
Set the tags for the specified page name.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
In order to run correctly, strut needs to have a username, 
password, and server name.  This can be configured in one 
of several ways:
.SS "Command line:"
.IX Subsection "Command line:"
.Vb 1
\&    strut \-\-username <username> \-\-password <password> \-\-server <server>
.Ve
.SS "Environment variables:"
.IX Subsection "Environment variables:"
.Vb 3
\&    STRUT_USERNAME
\&    STRUT_PASSWORD
\&    STRUT_SERVER
.Ve
.SS "Configuration file:"
.IX Subsection "Configuration file:"
.Vb 1
\&    ~/.app/strut.conf
.Ve
.PP
If strut can't determine your username/password/server, it will
call the 'configure' subcommand to create a configuration file for
you.
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 2
\&    <chris.dent@socialtext.com>
\&    <kirsten.jones@socialtext.com>
.Ve