star-ty

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

sty-list.1 (2539B)


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