update man and Readme

This commit is contained in:
creme 2019-09-06 16:54:44 +02:00
parent e2ec43a0fe
commit 8c4116c838
No known key found for this signature in database
GPG Key ID: C147C3B7FBDF08D0
3 changed files with 26 additions and 5 deletions

View File

@ -1,4 +1,4 @@
# `envs` - user script envs-launcher # `envs` - manage users_info.json entrys and user-submitted scripts
forked from [tilde](https://tildegit.org/team/tilde-launcher) forked from [tilde](https://tildegit.org/team/tilde-launcher)
@ -29,3 +29,5 @@ approved scripts are placed in /envs/bin and listed with `envs list`
submissions use sendmail to notify an admin. submissions use sendmail to notify an admin.
admins can use `sudo envs approve` and `sudo envs revoke <script_name>`. admins can use `sudo envs approve` and `sudo envs revoke <script_name>`.
users can also manage youre `users_info.json` entrys from the `~/.envs`-file.

2
envs
View File

@ -1,6 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# envs - manage users_info.json entrys and user-submitted scripts and apps # envs - manage users_info.json entrys and user-submitted scripts
# forked from tilde.team # forked from tilde.team
# Copyright 2018-2019, Ben Harris <ben@tilde.team> # Copyright 2018-2019, Ben Harris <ben@tilde.team>

25
envs.1
View File

@ -1,6 +1,7 @@
.TH envs 1 "9 June 2019" "v0.0.1" .TH envs 1 "06 September 2019" "v0.0.4"
.SH NAME .SH NAME
envs \- user script wrapper and submission tool envs \- wrapper for user-submitted scripts and users_info.json entrys
supports user settings, submission and admin approval
.SH SYNOPSIS .SH SYNOPSIS
.B envs [options] (scriptname) .B envs [options] (scriptname)
.P .P
@ -12,6 +13,8 @@ the wrapper feature.
users can submit any script in their ~/bin directory users can submit any script in their ~/bin directory
which will be mailed to admins for review. which will be mailed to admins for review.
users can also manage youre `users_info.json` entrys from the `~/.envs`-file.
.SH USAGE .SH USAGE
.TP .TP
.B envs list .B envs list
@ -25,9 +28,25 @@ Submit a script from your ~/bin directory
.TP .TP
.B envs about [scriptname] .B envs about [scriptname]
Get the submitter's description for a script. Get the submitter's description for a script.
.B envs show
show your config file
.TP
.B envs edit
edit your config file
.TP
.B envs get <entry>
show a entry from your config
.TP
.B envs set <entry> <'value'>
set a entry to your config
.TP
.B envs unset <entry>
unset a entry from your config
.TP
.SH DEPENDENCIES .SH DEPENDENCIES
None. None.
.SH BUGS .SH BUGS
None known. Please submit to https://git.envs.net/envs/envs_launcher/issues None known. Please submit to https://git.envs.net/envs/envs_launcher/issues
.SH AUTHOR .SH AUTHOR
Ben Harris <creme (at) envs (dot) net> Ben Harris <ben (at) tilde (dot) team>
Sven Kinne <creme (at) envs (dot) net>