pft-ls - Man Page

List objects in your PFT site

Synopsis

pft ls class [options]

Description

List objects.

The general usage provides a class of objects to lists. For instance

    pft ls tags

Will list all the tags from all pages and entries.

Classes

Many classes are supported. Here follows a list with a short description. For better details see pft(1).

pages

List all regular pages in ROOT/content/pages.

This class supports the --pretty argument.

blog

List all blog pages in ROOT/content/blog. This includes daily entries and monthly entries

This class supports the --pretty argument.

tags

Scan through all entries and list all used tags.

tagpages

List all tag pages, that is pages describing tags.

This class supports the --pretty argument.

Options

--help | -h

Show this help.

--locate

Show paths and titles, namely quick alias for:

    --pretty='%t:%p'
--pretty=fmt

Print properties of the listed nodes according to the specified format. The format supports a custom percent notation similar in spirit to printf(2).

Note that some of placeholders will be expanded with empty strings when the corresponding object property is void. For example, pages don't have a date). If this is the case the placeholder gets expanded with an empty string.

The output is encoding depending on the locale.

%t

Title

%p

Path (might be void if the node is virtual)

%g

Comma separated list of tags (possibly void)

%a

Author (possibly void)

%s

Slug (or name, if the node is virtual)

%D

Date in yyyy-mm-dd format (possibly void)

%y

Year (possibly void)

%m

Month (possibly void)

%d

Day (possibly void)

%o

Comma separated value of option=value pairs (possibly void)

See Also

pft(1)

Referenced By

pft(1).

2024-07-18 perl v5.40.0 User Contributed Perl Documentation