TildeClub
/
launcher
mirror of https://github.com/tildeclub/launcher.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update tilde.1

This commit is contained in:
deepend-tildeclub 2023-08-02 15:01:58 -06:00 committed by GitHub
parent 0e3797fb7b
commit 84d3acf406
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 61 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
tilde.1
View File

@ -1,53 +1,76 @@
.TH tilde 1 "06 September 2019" "v0.0.4" .TH TILDE 1 "August 2023" "Tilde User Scripts" "User Commands"
.SH NAME .SH NAME
tilde \- wrapper for user-submitted scripts and users_info.json entrys tilde \- manage user-submitted scripts and apps
supports user settings, submission and admin approval
.SH SYNOPSIS .SH SYNOPSIS
.B tilde [options] (scriptname)
.P
.SH DESRIPTION
.B tilde .B tilde
is a wrapper around user-submitted scripts. [\fIOPTION\fR] [\fICOMMAND\fR]
any accepted script in /tilde/bin can be run with
the wrapper feature.
users can submit any script in their ~/bin directory .SH DESCRIPTION
which will be mailed to admins for review. The \fBtilde\fR command is a script management tool for managing user-submitted scripts and apps on the system. It allows users to submit their scripts for approval by administrators, who can then approve or revoke them for system-wide usage.
users can also manage your `users_info.json` entries from the `~/.tilde`-file. By default, approved scripts are stored in the directory /tilde/bin, and their descriptions are kept in /tilde/descriptions.
.SH USAGE
.SH OPTIONS
.TP .TP
.B tilde list .B \-h, \-\-help
List all available scripts in /tilde/bin Show usage information and exit.
.TP .TP
.B tilde [scriptname] .B \-v, \-\-version
Run scriptname. Show version information and exit.
.SH COMMANDS
The following commands are supported:
.TP .TP
.B tilde submit .B list
Submit a script from your ~/bin directory Show a list of approved user scripts along with their descriptions.
.TP .TP
.B tilde about [scriptname] .B submit
Get the submitter's description for a script. Start the submission flow for your own script. The script should be placed in the ~/bin directory, be executable, and respond to help or --help.
.TP .TP
.B tilde show .B about \fIscript\fR
show your config file Show the description and details of a specific script.
.TP .TP
.B tilde edit .B approve
edit your config file Enter the approval queue for pending scripts. This command is only accessible to the root user. Administrators can review pending submissions and approve them for system-wide usage.
.TP .TP
.B tilde get <entry> .B revoke \fIscript\fR
show a entry from your config Revoke a previously approved script. This command is only accessible to the root user.
.TP .TP
.B tilde set <entry> <'value'> .B run \fIscript\fR
set a entry to your config Run an approved script by specifying its name. The script must be available in the /tilde/bin directory.
.TP
.B tilde unset <entry> .SH PATH CONFIGURATION
unset a entry from your config To use approved scripts without invoking the \fBtilde\fR command, you can add /tilde/bin to your PATH environment variable. By doing so, the scripts in /tilde/bin will be accessible directly from the command line.
.SH DEPENDENCIES
None. You can add /tilde/bin to your PATH by adding the following line to your shell configuration file (e.g., .bashrc or .zshrc):
.SH BUGS
None known. Please submit to https://github.com/tildeclub/launcher .BP
\fBexport PATH=\$PATH:/tilde/bin\fR
Then, restart your shell or run the following command to apply the changes:
.BP
\fBsource ~/.bashrc\fR (or \fBsource ~/.zshrc\fR for Zsh)
.SH SEE ALSO
The \fBtilde\fR command is part of the tilde-scripts package. More information about the tilde-scripts package can be found on the tilde.team website.
.SH AUTHOR .SH AUTHOR
Ben Harris <ben (at) tilde (dot) team> \fBBen Harris\fR <\fBben@tilde.team\fR>
Sven Kinne <creme (at) envs (dot) net> .SH COPYRIGHT
Copyright (C) 2018 Ben Harris.
.SH LICENSE
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License at <http://www.gnu.org/licenses/> for more details.