star-ty

Generate content for online publication
git clone git://git.meso-star.com/star-ty.git
Log | Files | Refs | README | LICENSE

sty-list.1 (2594B)


      1 .\" Copyright (C) 2017-2026 |Méso|Star> (contact@meso-star.com)
      2 .\"
      3 .\" This file is part Star-Typesetting.
      4 .\"
      5 .\" Star-Typesetting is free software: you can redistribute it and/or modify
      6 .\" it under the terms of the GNU General Public License as published by
      7 .\" the Free Software Foundation, either version 3 of the License, or
      8 .\" (at your option) any later version.
      9 .\"
     10 .\" Star-Typesetting is distributed in the hope that it will be useful,
     11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     13 .\" GNU General Public License for more details.
     14 .\"
     15 .\" You should have received a copy of the GNU General Public License
     16 .\" along with Star-Typesetting. If not, see <http://www.gnu.org/licenses/>.
     17 .Dd September 24, 2025
     18 .Dt STY-LIST 1
     19 .Os
     20 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     21 .Sh NAME
     22 .Nm sty-list
     23 .Nd list the resources in a working directory for star-typesetting
     24 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     25 .Sh SYNOPSIS
     26 .Nm
     27 .Ar resource
     28 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     29 .Sh DESCRIPTION
     30 .Nm
     31 is a tool used internally by
     32 .Xr star-typesetting 7
     33 to list the resources it depends on to generate online content.
     34 It must be run from the root of the star-typesetting working directory.
     35 It is not intended to be invoked manually, but it can nevertheless be
     36 used to query the files and directories used by
     37 .Xr star-typesetting 7 .
     38 .Pp
     39 The only argument of
     40 .Nm
     41 is the resource type to query.
     42 The available resources are as follows:
     43 .Bl -tag -width Ds
     44 .It Cm hook
     45 List of hooks, i.e. shell scripts to be executed by section before
     46 their content can be generated.
     47 .It Cm html
     48 List of HTML files to generate from Markdown files or shell scripts
     49 stored in each section.
     50 .It Cm shell
     51 List the shell scripts relevant to
     52 .Xr star-typesetting 7 ,
     53 i.e. the
     54 shell script in the
     55 .Pa scripts
     56 directory at the root of the working tree
     57 and those in each section used to generate dynamic content.
     58 .It Cm shtml
     59 List of shell scripts that dynamically generate HTML content.
     60 This is actually a subset of the scripts returned by
     61 .Nm
     62 when executed whith the
     63 .Cm shell
     64 argument.
     65 .It Cm subdir
     66 List the relevant subdirectories of the sections, i.e. the directories
     67 in the sections that belong to the content to be published.
     68 .El
     69 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     70 .Sh EXIT STATUS
     71 .Ex -std
     72 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     73 .Sh SEE ALSO
     74 .Xr star-typesetting 7