star-phor-input

File format for describing photoreactor configurations
git clone https://www.edstar.cnrs.fr/git/star-phor-input.git
Log | Files | Refs | README | LICENSE

sphin-lint.1.scd (2165B)

      1 sphin-lint(1) "UNIX"
      2 
      3 ; Copyright (C) 2024-2026 Centre National de la Recherche Scientifique
      4 ; Copyright (C) 2024-2026 Clermont Auvergne INP
      5 ; Copyright (C) 2024-2026 INSA Lyon
      6 ; Copyright (C) 2024-2026 Institut Mines Télécom Albi-Carmaux
      7 ; Copyright (C) 2024-2026 Institut National Polytechnique de Toulouse
      8 ; Copyright (C) 2024-2026 |Méso|Star> (contact@meso-star.com)
      9 ; Copyright (C) 2024-2026 PhotonLyX (info@photonlyx.com)
     10 ; Copyright (C) 2024-2026 Université de Lorraine
     11 ; Copyright (C) 2024-2026 Université Paul Sabatier
     12 ; Copyright (C) 2024-2026 Université Toulouse - Jean Jaurès
     13 ; 
     14 ; This program is free software: you can redistribute it and/or modify
     15 ; it under the terms of the GNU General Public License as published by
     16 ; the Free Software Foundation, either version 3 of the License, or
     17 ; (at your option) any later version.
     18 ; 
     19 ; This program is distributed in the hope that it will be useful,
     20 ; but WITHOUT ANY WARRANTY; without even the implied warranty of
     21 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     22 ; GNU General Public License for more details.
     23 ; 
     24 ; You should have received a copy of the GNU General Public License
     25 ; along with this program. If not, see <http://www.gnu.org/licenses/>.
     26 
     27 # NAME
     28 
     29 sphin-lint - tool for analysing a photoreactive configuration
     30 
     31 # SYNOPSIS
     32 
     33 *sphin-lint* [*-hv*]
     34 
     35 # DESCRIPTION
     36 
     37 *sphin-lint* is an utility that verifies the numerical consistency of a given
     38 _star-phor-input_(5) file.
     39 
     40 The options are as follows:
     41 
     42 *-h*
     43 	Display short help and exit.
     44 
     45 *-v*
     46 	Make sphin-lint verbose. Multiple *-v* options increase the verbosity.
     47 	The maximum is 3.
     48 
     49 # EXAMPLES
     50 
     51 Load and check a photoreactive system description from a local file:
     52 
     53 ```
     54 sphin-lint photoreactive_description_file.txt
     55 ```
     56 
     57 Load and check photoreactive system description from the standard input:
     58 
     59 ```
     60 cat photoreactive_description_file.txt | sphin-lint
     61 ```
     62 
     63 # ERRORS
     64 
     65 The sphin-lint utility exits 0 on success, and >0 if an error occurs.
     66 
     67 # SEE ALSO
     68 
     69 _sphin_(3), _star-phor-input_(5)
     70 
     71 # HISTORY
     72 
     73 *sphin-lint* has been developed thanks to the funding of the ECOCHEM project
     74 (ProjetIA-22-PESP-0006) belonging to the *PEPR SPLEEN*.