Changeset 164


Ignore:
Timestamp:
Jan 18, 2018, 8:42:03 AM (3 years ago)
Author:
g7moreau
Message:
  • Begin documentation
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/project-meta/project-meta

    r163 r164  
    5757
    5858sub cmd_help {
    59    print <<END;
    60 NAME
    61    $0 - action on project metadata
    62 
    63 SYNOPSIS
    64    $0 [-verbose] check
     59   print <<'END';
     60project-meta - opendata project metafile manager
     61
     62 project-meta [-verbose] check
     63 project-meta make-link
     64 project-meta make-author
     65 project-meta make-licence
     66 project-meta make-copyright
     67 project-meta make-licence
     68 project-meta list-licence
    6569END
    6670   }
     
    261265   closedir $dh;
    262266   }
     267
     268################################################################
     269# documentation
     270################################################################
     271
     272__END__
     273
     274=head1 NAME
     275
     276project-meta - opendata project metafile manager
     277
     278
     279=head1 USAGE
     280
     281 project-meta [-verbose] check
     282 project-meta make-link
     283 project-meta make-author
     284 project-meta make-licence
     285 project-meta make-copyright
     286 project-meta make-licence
     287 project-meta list-licence
     288
     289=head1 DESCRIPTION
     290
     291=head1 COMMANDS
     292
     293Some command are defined in the source code but are not documented here.
     294Theses could be not well defined, not finished, not well tested...
     295You can read the source code and use them at your own risk
     296(like for all the Klask code).
     297
     298=head2 make-licence
     299
     300 project-meta make-licence
     301
     302Copy the licence file from the project-meta licence database at the current folder with the file name: LICENCE.txt.
     303
     304The licence is defined in the PROJECT-META.yml specification under the key C<public-dap/data-licence>.
     305The list of possible licence is given with the command L<list-licence>.
     306
     307=head2 list-licence
     308
     309 project-meta list-licence
     310
     311Give the list of all the open data licence supported by the project-meta licence database.
     312
     313=head1 AUTHOR
     314
     315Written by Gabriel Moreau, Grenoble - France
     316
     317=head1 SPECIAL THANKS
     318
     319The list of people below did not directly contribute to project-meta's source code
     320but provided me with some data, returned bugs
     321or helped me in another small task like having new ideas ...
     322Maybe I forgot your contribution in recent years,
     323please forgive me in advance and send me an e-mail to correct this.
     324
     325Joel Sommeria, Julien Chauchat, Cyrille Bonamy.
     326
     327
     328=head1 LICENSE AND COPYRIGHT
     329
     330Licence GNU GPL version 2 or later and Perl equivalent
     331
     332Copyright (C) 2005-2018 Gabriel Moreau <Gabriel.Moreau(A)univ-grenoble-alpes.fr>.
Note: See TracChangeset for help on using the changeset viewer.