summary refs log tree commit diff
path: root/bin/README
blob: 21bdf89fa2f5209038b97b9efea9ca663dbc73cf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

Tools primarily targetting Darwin and FreeBSD. Some don't build on Linux
and some only build on Linux. All code licensed AGPLv3. See LICENSE.

                                  bri

Backlight brightness control for Linux through /sys/class/backlight.

    bri 255
    bri ---
    bri ++

                               dtch/atch

Session detach and attach. Simple implementation of part of screen(1) by
lending out the master end of a PTY over a UNIX domain socket. Detach
with ^Q.

    dtch a nvim & disown
    atch a

                                 fbatt

Battery charge indicator panel for the Linux framebuffer through
/sys/class/power_supply.

                                fbclock

Clock panel for the Linux framebuffer. Renders PSF2 bitmap fonts.

                                  gfxx

Graphics data explorer. Build with GFX={cocoa,fb,x11}. Dumps PNGs.

    -c {indexed,grayscale,rgb}    set color space
    -p PATH                       load palette
    -e {l,b}                      set byte order
    -E {l,b}                      set bit order
    -b NNNN                       set pad, R, G, B bits
    -n N                          set offset
    -f                            flip
    -m                            mirror
    -w N                          set width
    -z N                          set scale
    -o PREFIX                     set output prefix

    q      quit
    x      dump one frame
    X      dump each frame
    o      print options
    []     switch color spaces
    p      sample palette
    P      dump palette
    {}     switch bits presets
    e      swap byte order
    E      swap bit order
    hl     offset by byte
    jk     offset by pixel
    HL     offset by row
    JK     offset by square
    ,.     adjust width
    <>     half/double width
    f      flip
    m      mirror
    -+     zoom
    0-9    set bits

                                 glitch

PNG glitcher based on pngo.

    -c         write to stdout
    -o PATH    write to file
    -p         broken Paeth predictor
    -f         filter when reconstructing
    -r         reconstruct when filtering
    -d LIST    declare pattern of comma-separated filters
    -a LIST    apply pattern of comma-separated filters

                                  hnel

The tr(1) of PTYs, for remapping keys. Originally for preserving HJKL in
alternate keyboard layouts. Toggle remapping with ^S.

    hnel '[]{}' '{}[]' vi

                                  klon

Klondike solitaire for curses. BSD-only for arc4random_uniform.

    q   quit
    u   undo
    ' ' draw
    w   waste
    a-d foundations
    1-7 tableau
    ^M  auto-foundation

                           pbd/pbcopy/pbpaste

TCP server which pipes into macOS pbcopy(1) and from pbpaste(1), and
pbcopy and pbpaste implementations that connect to it. Used to share
the macOS pasteboard over SSH with RemoteForward 7062 127.0.0.1:7062.
This used to make nvim's "+ register work but they seem to have changed
their detection.

    pbd & disown
    ssh tux.local
    pbpaste

                                  pngo

PNG optimizer. Does not support interlaced PNGs.

 - Discards ancillary chunks
 - Discards unnecessary alpha channel
 - Converts unnecessary truecolor to grayscale
 - Indexes color if possible
 - Reduces bit depth if possible
 - Applies a simple filter type heuristic
 - Applies zlib's best compression

    pngo foo.png
    pngo -o bar.png foo.png
    pngo -c foo.png | xx

                                  wake

Broadcasts a wake-on-LAN packet to one of my machines.

                                 watch

Executes a command each time files change. BSD-only for kqueue(2).

    watch watch.c make
    watch wake.c watch.c -- make wake watch

                                   xx

Hexdump tool.

    -a          toggle ASCII
    -c N        set columns
    -g N        set grouping
    -r          reverse hexdump
    -s          toggle offsets
    -z          skip zeros
d> 2013-05-26readme: use string_list instead of space deliminationsJason A. Donenfeld Now this is possible in cgitrc - readme=:README.md readme=:readme.md readme=:README.mkd readme=:readme.mkd readme=:README.rst readme=:readme.rst readme=:README.html readme=:readme.html readme=:README.htm readme=:readme.htm readme=:README.txt readme=:readme.txt readme=:README readme=:readme readme=:INSTALL.txt readme=:install.txt readme=:INSTALL readme=:install Suggested-by: John Keeping <john@keeping.me.uk> Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25ui-summary: Disallow directory traversalJason A. Donenfeld Using the url= query string, it was possible request arbitrary files from the filesystem if the readme for a given page was set to a filesystem file. The following request would return my /etc/passwd file: http://git.zx2c4.com/?url=/somerepo/about/../../../../etc/passwd http://data.zx2c4.com/cgit-directory-traversal.png This fix uses realpath(3) to canonicalize all paths, and then compares the base components. This fix introduces a subtle timing attack, whereby a client can check whether or not strstr is called using timing measurements in order to determine if a given file exists on the filesystem. This fix also does not account for filesystem race conditions (TOCTOU) in resolving symlinks. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25cgitrc.5: information on directory traversal and multiple readme filesJason A. Donenfeld Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25readme: Accept multiple candidates and test them.Jason A. Donenfeld The readme variable may now contain multiple space deliminated entries, which per usual are either a filepath or a git ref filepath. If multiple are specified, cgit will now select the first one in the list that exists. This is to make it easier to specify multiple default readme types in the main cgitrc file and have them automatically get applied to each repo based on what exists. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25ui-summary: Pass filename to about-filterJason A. Donenfeld This gives the about-filter API the same semantics as source-filter, where the filter receives the filename so it can decide what to do next with it. While we're at it, plug a memory leak. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25ui-summary: Use default branch for readme if : prefixJason A. Donenfeld If the readme value begins with ":", and has no specified branch before it, use the repository's default branch. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25cgit.c: Do not reset HOME after unsetting it.Jason A. Donenfeld The number of odd cases in which git will try to read config is far too great to keep putting a bandaid over each one, so we'll just unset it. If it turns out that scripts really liked to know about $HOME, we can always reset it in the filter forks. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25cgit.c: sync repo config printing with struct cgit_repoJason A. Donenfeld We've now added quite a few config keys for repositories, but we've forgotten to update the printing of it for cache files. Synchronize the two. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-05-25git: update to 1.8.3John Keeping No changes required, just bump the submodule and Makefile versions. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-22cache.c: cache ls_cache output properlyJohn Keeping By using the standard library's printf, cache_ls does not redirect its output to the cache when we change the process' stdout file descriptor to point to the cache file. Fix this by using "htmlf" in the same way that we do for writing HTTP headers. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-22tests: introduce strip_header() helper functionJohn Keeping This means that we can avoid hardcoding the number of headers we expect CGit to generate in test cases and simply remove whatever headers happen to by there when we are checking body content. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-22shared.c: use die_errno() where appropriateJohn Keeping This replaces some code that is re-implementing die_errno by just calling the function. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-22html.c: die when write failsJohn Keeping If we fail to write HTML output once, there's no point carrying on so just write a failure message once and die. By using Git's die_errno function we also let the user know in what way the write failed. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-22ui-log: add <span/> around commit decorationsJohn Keeping This helps projects that have a large number of tags to display them all using custom CSS. The default stylesheet has not been updated since what is useful for projects with a lot of tags is not the same as what is useful for projects with only a small number of decorations per commit. Suggested-by: Konstantin Ryabitsev <mricon@kernel.org> Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-22Makefile: fix parallel "make test"John Keeping When building the "test" target we depend on both cgit and building the Git tools. By doing this with two targets we end up running make in the git/ directory twice, concurrently if using parallel make, which causes us to build more than we need and potentially builds incorrectly if multi-step build-then-move operations overlap. Fix this by instead calling back into the makefile so that we alter the "cgit" target to also build the Git tools. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-18cache.c: fix cache_lsJohn Keeping Commit fb3655d (use struct strbuf instead of static buffers, 2013-04-06) broke the logic in cache.c::cache_ls by failing to set slot->cache_name before calling open_slot. While fixing this, also free the strbufs added by that commit once we're done with them. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-13t0109: "function" is a bash-ismJohn Keeping We try to stick to POSIX shell in the tests but a "function" keyword has found its way into t0109. Remove it. This makes the tests work with dash again. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-05-13New mailing list.Jason A. Donenfeld 2013-04-30ui-snapshot: do not access $HOMEJason A. Donenfeld It's a bit tedious to have to do this here too. If we encounter other issues with $HOME down the line, I'll look into adding some nice utility functions to handle this, or perhaps giving up on the hope that we could keep $HOME defined for scripts. This commit additionally adds a test case, should the issue surface again. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-04-27t0001: validate Git -rcN version numbers correctlyJohn Keeping When creating the GIT-VERSION-FILE that we use to test that the version of Git in git/ is the same as in the CGit Makefile, Git applies the transform "s/-/./g" to the version string. This doesn't affect released versions but does change RC version numbers such as 1.8.3-rc0. While CGit should only refer to a released Git version in general, it is useful to developers who want to test upcoming Git releases if the tests do work with RCs, so change t0001 to apply the same transform to our Makefile version before comparing it to the contents of GIT-VERSION-FILE. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-04-27git: update to 1.8.2.2John Keeping No changes required, just bump the submodule and Makefile version. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-04-17scan-tree: fix regression in section-from-path=-1John Keeping Commit fb3655d (use struct strbuf instead of static buffers - 2013-04-06) introduced a regression in the "section-from-path" handling when the configured value is negative. By changing the "rel" variable so that it includes a trailing slash, counting slashes from the end of the string no longer gives the same answer as it did before. Fix this by ensuring that "rel" does not have a trailing slash. Reported-by: Julius Plenz <plenz@cis.fu-berlin.de> Signed-off-by: John Keeping <john@keeping.me.uk> 2013-04-15t0001: ignore ".dirty" suffix on Git versionJohn Keeping When testing modifications in Git that affect CGit, it is annoying to have t0001 failing simply because the Git version has a ".dirty" suffix when the version of Git there does indeed match that specified in the CGit makefile. Stop this by stripping the ".dirty" suffix from the GIT_VERSION variable. Note that this brings the "Git version" behaviour in line with the "submodule version" case which does not check if the working tree in git/ is modified. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-04-15tests: set TEST_OUTPUT_DIRECTORY to the CGit test directoryJohn Keeping By default, Git's test suite puts the trash directories and test-results directory into its own directory, not that containing the tests being run. This is less convenient for inspecting test failures, so set the output directory to CGit's tests/ directory instead. Note that there is currently a bug in Git whereby it will create the trash directories in our tests/ directory regardless of the value of TEST_OUTPUT_DIRECTORY, and then fail to remove them once the tests are done. This change does currently affect the location of the test-results/ directory though. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-04-15t0109: test more URLsJohn Keeping In order to ensure that we don't access $HOME at some point after initial startup when rendering a specific view, run the strace test on a range of different pages. This ensures that we don't end up reading a configuration later for some specific view. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-04-10cgitrc.5.txt: Specify when scan-path must be defined before.Jason A. Donenfeld Several options must be specified prior to scan-path. This is consistant source of user confusion. Document these facts. Suggested-by: Lukas Fleischer <cgit@cryptocrack.de> Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2013-04-10ui-snapshot.c: Prepend "V" when guessing ref namesLukas Fleischer In cgit_print_snapshot_links() we strip leading "v" and "V", while we currently only prepend a lower case "v" when parsing a snapshot file name. This results in broken snapshot links for tags that start with an upper case "V". Avoid this by prepending a "V" as a fallback. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2013-04-10t0107: Skip ZIP tests if unzip(1) isn't availableLukas Fleischer Note that we cannot use skip_all here since some tests have already been executed when ZIP tests are reached. Use test prerequisites to skip everything using unzip(1) if the binary is not available instead. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2013-04-10tests/: Do not use `sed -i`Lukas Fleischer "-i" isn't part of the POSIX standard and doesn't work on several platforms such as OpenBSD. Use a temporary file instead. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2013-04-10Add branch-sort and repo.branch-sort options.Jason A. Donenfeld When set to "name", branches are sorted by name, which is the current default. When set to "age", branches are sorted by the age of the repository. This feature was requested by Konstantin Ryabitsev for use on kernel.org. Proposed-by: Konstantin Ryabitsev <mricon@kernel.org> 2013-04-10t0109: chain operations with &&John Keeping Without '&&' between operations, we will not detect if strace or cgit exit with an error status, which would cause a false positive test status in this case. Signed-off-by: John Keeping <john@keeping.me.uk> 2013-04-10cgit.c: Do not restore unset environment variablesLukas Fleischer getenv() returns a NULL pointer if the specified variable name cannot be found in the environment. However, some setenv() implementations crash if a NULL pointer is passed as second argument. Only restore variables that are not NULL. See commit d96d2c98ebc4c2d3765f5b35c4142e0e828a421b for a related patch. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2013-04-09t0107: Use `tar -z` for gzip'ed archivesLukas Fleischer