salt/firestarter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README, help text

Browse Source
This commit is contained in:
Salt 2019-06-21 16:39:11 -05:00
parent b663527988
commit 5322263239
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,7 +2,7 @@
## Overview
**Firestarter** is a desktop environment startup script. Its job is to abstract out the startup and configuration of basic X session components. By default, it will attempt to piece together a fully functional desktop environment based on currently available programs and configuration files found in `~/.config/firestarter`. See [Usage](#usage) for details.
**Firestarter** is a desktop environment startup script. Its job is to abstract out the startup and configuration of basic X session components. By default, it will attempt to piece together a fully functional desktop environment based on currently available programs and configuration files found in `~/.config/firestarter`.
## Installation
@ -15,7 +15,7 @@ On first run and when invoked with `firestarter -g`, Firestarter will generate a
command -v i3
i3
Every odd line is a command that must succeed in order for the following even line to be executed. Once an even command is executed, parsing stops. When Firestarter is invoked with no arguments, every configuration file is parsed this way.
Every odd line is a command that must succeed in order for the following even line to be executed. Once an even command is executed, parsing stops. When Firestarter is invoked with no arguments, every configuration file is parsed this way. All commands are invoked in subshells.
By setting a dummy execution line, one can effectively prevent an entire configuration file from being parsed in certain environments. As an example, the following configuration file will only attempt to start an X infobar in an X environment:
@ -26,7 +26,11 @@ By setting a dummy execution line, one can effectively prevent an entire configu
command -v lemonbar
~/.bin/lemonbar.sh | lemonbar
All STDOUT and STDERR messages from these commands are saved to a logfile in `~/.local/share/firestarter/logs` under the same name as the configuration file.
# Logging
All STDOUT and STDERR messages from these commands are saved to a logfile in `~/.local/share/firestarter/logs` under the same name as the configuration file. By default, these logfiles are rotated every time you log in.
If you set the variable `FS_NOLOG` to a nonempty value, firestarter will not keep logs and will not create a logging directory.
## Usage

4
firestarter
View File

@ -1,6 +1,6 @@
#! /bin/bash
#
# firestarter.bash
# firestarter
# A desktop environment startup script
# Copyright (C) 2019 Vintage Salt <rehashedsalt@cock.li>
#
@ -238,7 +238,7 @@ Usage: $(basename -- "$0") [OPTION...]
Start or generate a desktop environment configuration
-h Show this help text
-g Generate a default configuration
-g Generate a default configuration. This will clobber
-d Perform a dry run. This will print the results of all decisions
without executing them.