Merge pull request 'Improve command substitution' (#7) from rjc/wiki:command_substitution into trunk

Reviewed-on: institute/wiki#7

README.md

@@ -2,23 +2,9 @@
 
 This repository holds the wiki data for tilde.institute
 
-To contribute:
-* Fork the repository
-* Create a branch with an appropriate name:
-  * `git checkout -b mycoolpage`
-* Add your page in the `pages/` directory
-* Submit a PR
-* Once it's merged it will be pulled into the wiki
-
-Don't forget to wrap lines at approximately 75 columns. If
-you need to, use `fmt -w 75`. For example:
-
-```
-$ fmt -w 75 mypage.md | tee mypage.md
-```
-Then afterwards, check the page to fix anything that got
-clobbered.
+Depending on which mirror you find this repo at, either submit a PR or mail
+a patch in to add or edit a page.
 
 ## Software
 
-The wiki engine being used is [TildeWiki](https://github.com/gbmor/tildewiki), developed by ahriman
+This uses [tildewiki](https://github.com/tildeinstitute/tildewiki)

assets/wiki.md

@@ -2,9 +2,13 @@
 
 Welcome to the [tilde.institute](https://tilde.institute) wiki!
 
-If you are new here, you may want to check out the [IRC](/w/irc) page. Or, if you know your way around and want to contribute to the wiki, open a PR! tilde.institute uses [tildegit](https://tildegit.org) for all site-related version control.
+If you are new here, you may want to check out the [IRC](/w/irc) page. Or, if you know your way around and want to contribute to the wiki, mail a patch to `admins@tilde.institute` or open a PR!
 
-Repository: [tildegit.org/institute/wiki](https://tildegit.org/institute/wiki)
+Repositories:
+
+  * [git.tilde.institute/tilde/wiki](https://git.tilde.institute/tilde/wiki)
+  * [tildegit.org/institute/wiki](https://tildegit.org/institute/wiki)
+  * [github.com/tildeinstitute/wiki](https://github.com/tildeinstitute/wiki)
 
 ### Pages
 

pages/bchs.md

@@ -1,10 +1,14 @@
 <!--
-author: ahriman
+author: gbmor
 title: BCHS Guide
 description: Introduction to the BCHS stack for web development
 date: 2019-04-24
 -->
 
+**NOTE**
+
+This needs to be updated - a current example can be found at [https://github.com/kristapsdz/kcgi-framework](https://github.com/kristapsdz/kcgi-framework) and more information on `kcgi` at [https://kristaps.bsd.lv/kcgi/](https://kristaps.bsd.lv/kcgi/)
+
 # BCHS Guide
 
 This will be a quick-and-dirty guide to getting started with the BCHS

pages/dcss.md

@@ -1,6 +1,6 @@
 <!--
 title: Dungeon Crawl Stone Soup
-author: ahriman
+author: gbmor
 description: Connecting to the Tildeverse DCSS instance
 -->
 

pages/finger.md

@@ -1,6 +1,6 @@
 <!--
 title: Finger
-author: ahriman
+author: gbmor
 description: Getting started with fingerd
 -->
 

pages/firefox-address-bar-tips.md

@@ -0,0 +1,45 @@
+<!--
+title: firefox address bar tips
+author: erxeto
+description: Some useful tips for using the firefox address bar more
+efficiently
+-->
+
+# Firefox address bar.
+
+The address bar has become our entry point to the internet these days.
+Firefox in its default configuration does some sort of _smart_ guess on
+what you type there.  If it resembles a [URL](https://en.wikipedia.org/wiki/URL)
+then the browser makes that request.  If not, it sends the string you typed
+to your default search engine.  It also includes some fuzzy search matches
+from your history and all that, which is fine 90% of the time, but
+sometimes you need a bit more control over what results it shows you.
+
+# Changing the address bar behaviour
+
+This is a list of modifiers you can set at the beginning of the search to
+tell firefox what do you want to see on the results, a kind of filtering:
+
+```
+^    to search for matches in your browsing history.
+*    to search for matches in your bookmarks.
++    to search for matches in pages you've tagged.
+%    to search for matches in your currently open tabs.
+#    to search for matches in page titles.
+$    to search for matches in web addresses (URLs).
+?    to search for matches in suggestions.
+```
+
+# Examples
+
+So, if you want to search for the word `headphones` in your bookmarks only,
+you can type on the address bar:
+
+`*headphones`
+
+And, if you want to include only the results of your browsing history it
+would be:
+
+`^headphones`
+
+[back](/)

pages/gcc.md

@@ -0,0 +1,43 @@
+<!--
+title: gcc and GNUstep
+description: Information on using recent gcc versions
+author: gbmor
+-->
+
+# gcc
+
+OpenBSD includes `gcc4` in the base install, which is `gcc-4.2.1`.
+If you prefer to use `gcc-11.2.0`, the names of the binaries differ.
+
+The following are part of `gcc-11.2.0`:
+
+* `/usr/local/bin/egcc`
+* `/usr/local/bin/gcc` (symlink)
+* `/usr/local/bin/eg++`
+* `/usr/local/bin/g++` (symlink)
+* `/usr/local/bin/egdb`
+* `/usr/local/bin/gdb` (symlink)
+* `/usr/local/bin/egfortran`
+* `/usr/local/bin/gfortran` (symlink)
+* `/usr/local/bin/gnat`
+
+The following are part of `gcc-4.2.1`
+
+* `/usr/bin/gcc4`
+* `/usr/bin/g++4`
+* `/usr/bin/gdb`
+
+`GNUstep` is available if you would like to develop using Objective-C. The
+following should be added to `~/.kshrc`:
+
+```
+export GNUSTEP_MAKEFILES=/usr/local/share/GNUstep/Makefiles
+. /usr/local/share/GNUstep/Makefiles/GNUstep.sh
+```
+
+You will also need to call `gmake` rather than `make` when building Objective-C
+code. See [this StackOverflow post](https://stackoverflow.com/questions/14441852/how-to-build-gnustep-programs-on-openbsd)
+for more information.
+
+[back](/)
+

pages/gerbilscheme.md

@@ -0,0 +1,16 @@
+<!--
+title: Gerbil Scheme
+description: Getting your environment set up to use Gerbil Scheme
+author: gbmor
+-->
+
+# Gerbil Scheme Setup
+
+You'll need to set `GERBIL_HOME` and modify your `PATH`.
+```
+export GERBIL_HOME=/usr/local/gerbil
+export PATH=$PATH:$GERBIL_HOME/bin
+```
+Here's the [official introduction](https://cons.io/guide/intro.html) to the Gerbil Scheme dialect.
+
+[back](/)

pages/gpgssh.md

@@ -1,7 +1,7 @@
 <!--
 title: GnuPG for SSH Authentication
 Description: Using gpg-agent as an alternative to ssh-agent
-author: ahriman
+author: gbmor
 -->
 
 # Using GPG for SSH Authentication

pages/irc.md

@@ -1,7 +1,7 @@
 <!--
 title: IRC
 description: Introduction to our IRC network
-author: ahriman
+author: gbmor
 -->
 
 # IRC
@@ -11,9 +11,12 @@ chatting while logged on to tilde.institute, simply use the command
 `chat`! If you prefer to use a different IRC client than the default,
 such as `irssi`, the following server information will apply:
 
-* institute.tilde.chat
-* Port 6697
-* TLS / SSL
+* localhost
+* Port 6667
+* No TLS
+
+If you're using the `catgirl` client, you can just run `catgirl local`.
+This uses the default system config. See `man 1 catgirl` if you want a custom config.
 
 Don't forget to `/join #institute` and `/join #meta`.
 
@@ -24,9 +27,9 @@ Don't forget to `/join #institute` and `/join #meta`.
 
 ## Certificates
 
-If you get an untrusted certificate error, change this line in `$HOME/.weechat/weechat.conf`
+If you get an untrusted certificate error, change the weechat configs:
 ```
-gnutls_ca_file = "/etc/ssl/cert.pem"
+/set weechat.network.gnutls_ca_file "/etc/ssl/cert.pem"
 ```
 
 ## Channels
@@ -44,6 +47,7 @@ activity than others. Here's a few channels that you may be interested in.
 * `#security` - computer, software, and network security discussions
 * `#hamradio` - the channel for hams!
 * `#gopher` - for the gopher protocol
+* `#gemini` - discussion for the Gemini protocol
 
 You can check the currently available channels any time by issuing `/list`
 in your IRC client.
@@ -73,11 +77,16 @@ And if you're using `irssi`
 /connect -tls -tls_verify irc.tilde.chat 6697
 ```
 
-The tildeverse IRC network also runs an instance of `The Lounge`, a
-web-based IRC client that allows you to stay connected even when you're
-away. It's available at:
+Or from `catgirl`:
 
-* [https://web.tilde.chat](https://web.tilde.chat)
+```
+catgirl -h institute.tilde.chat -n <nick>
+```
+
+The tilde.chat IRC network also runs two web clients:
+
+* [gamja](https://tilde.chat/gamja)
+* [kiwi](https://tilde.chat/kiwi)
 
 Join us on the tildeverse IRC network and socialize with other tilde users!
 

pages/jdk.md

@@ -0,0 +1,24 @@
+<!--
+title: jdk 11
+description: Using JDK 11
+author: gbmor
+-->
+
+# jdk 11
+
+To use JDK 11 for development, you will need to make the following additions
+to your `~/.kshrc` file:
+
+```
+export PATH=/usr/local/jdk-11/bin:$PATH
+export JAVA_HOME=/usr/local/jdk-11
+```
+
+Afterwards, you may call `java`, `javac`, etc as expected.
+
+JDK 1.8.0 is also available by replacing `jdk-11` in the above two lines
+with `jdk-1.8.0`
+
+JDK 17 is also available.
+
+[back](/)

pages/nntp.md

@@ -0,0 +1,56 @@
+<!--
+title: NNTP
+description: Newsgroup service information
+author: gbmor
+-->
+
+# NNTP
+
+Our friends over at [tilde.club](https://tilde.club) run an NNTP service that's
+open to the public. There are a few options for browsing from [tilde.institute](https://tilde.institute).
+
+```
+news.tilde.club:119
+```
+
+## lynx
+
+If you just want to take a look, `lynx` can connect to an `NNTP` service:
+
+```
+lynx news://news.tilde.club
+```
+
+## tin
+
+`/etc/nntpserver` has been populated with `news.tilde.club`, so connecting with tin
+only requires this command:
+
+```
+tin -r
+```
+
+`-r` for remote newsgroups. Once connected, hit `S` to subscribe, then `*` to subscribe
+to all newsgroups. To start a new thread, pick a group, then hit `w` for "write" and
+compose your message. To respond to a message in a thread, hit `f` for "follow-up". There
+are a few other options for interaction with a post or thread, such as `r` for a direct
+email reply to the post author.
+
+## alpine
+
+Start `alpine`, then navigate to `Setup`, and finally `Config`. Set the following options:
+
+* NNTP Server: `news.tilde.club`
+* SMTP Server: `localhost:25`
+
+## Other Clients
+
+If you have another preferred client, feel free to ask us to install it. Either mail
+`admins@tilde.institute` or jump into the IRC channel `#institute`.
+
+## See Also
+
+[https://tilde.club/wiki/usenet-news.html](https://tilde.club/wiki/usenet-news.html)
+
+
+[back](/)

pages/pp.md

@@ -1,7 +1,7 @@
 <!--
 title: pp(1)
 description: Introduction to pp(1)
-author: ahriman / gbmor
+author: gbmor
 -->
 
 # pp(1)
@@ -55,6 +55,6 @@ Will output, per the manual page:
 The manpage includes more information on advanced features, such as piping `stdin` and debugging.
 
 ## Notes
-* Full Guide: [adi.tilde.institute/pp](https://adi.tilde.institute/pp)
+* Full Guide: [adi.tilde.institute/](https://adi.tilde.institute/)
 
 [back](/)

pages/remote-mail.md

@@ -0,0 +1,48 @@
+<!--
+title: Remote Mail
+author: Charadon
+description: How to connect to your tilde.institute e-mail address remotely.
+-->
+
+# Remote Mail Guide
+tilde.institute doesn't support POP or IMAP at the moment, so we'll need to use
+a little bit of a roundabout way of connecting to our mail address remotely.
+All you will need for this guide is sshfs, ssh itself, and an e-mail client
+that supports Maildir.
+
+## Known clients that support Maildir
+- Gnome Evolution
+- Neomutt
+- Mutt
+
+## Sending Mail
+
+To send mail, all you need to do is run this command:
+
+```
+ssh -nNTL 25:localhost:25 yourusername@tilde.institute
+```
+
+And then set your SMTP server in your mail client to localhost and use port 25.
+You will now be able to send mail.
+
+## Receiving Mail
+First, you need to mount your remote Maildir folder using sshfs. You can use
+this command to do that:
+
+```
+sshfs -v -o reconnect -o ssh_command="ssh -i ~/.ssh/id_yourkey" yourusername@tilde.institute:/home/yourusername/Maildir ~/Maildir
+```
+
+Then set up your mail client like you would with any other Maildir and point it
+to your mounted Maildir folder.
+
+### Notes
+1. This is not very mobile unfortunately, and as far as i'm aware, there is no
+Maildir supporting e-mail client for phones.
+2. The above commands assume you have a keyring installed to automatically
+unlock your keys OR a passwordless key.
+3. On some file managers such as Thunar, if sshfs can't connect to the remote
+server, it will freeze the file manager if you navigate to the folder it's
+mounted in. (In this case, since we mounted Maildir to ~/, it'll freeze in
+your home folder.)

pages/todo.md

@@ -0,0 +1,66 @@
+<!--
+title: todo, a todo list manager
+description: todo usage guide
+author: ensa
+-->
+
+# todo, a todo list manager
+
+`todo` is a todo list manager.
+
+`todo` manages the todo list stored in the path referred to by `$TODO`, or
+`$HOME/todo` if TODO isn't set.
+
+## basic usage
+
+`todo` without arguments will print the file's
+contents, with line numbers added.
+example output:
+```
+     1  write todo documentation
+     2  water the cat
+     3  do nothing
+```
+
+`todo -a "MSG"`
+will append another line, containing MSG.
+```
+     1  write todo documentation
+     2  water the cat
+     3  do nothing
+     4  MSG
+```
+
+`todo -e` edits the todo file in `$EDITOR`.
+
+`todo -d 2` removes item 2 from the list, and archives it in `${TODO}.complete`
+with a timestamp.
+`todo` output after `todo -d 2`:
+```
+     1  write todo documentation
+     2  do nothing
+     3  MSG
+```
+
+`todo -x` views the list archive.
+example output:
+```
+2020-07-16 13:37:53 - water the cat
+```
+
+## advanced use
+
+the `-n` flag specifies the line number where the line is added, pushing all
+lower lines down by one.
+for example, `todo` after `todo -n 3 -a 'bake pie'` will result in this.
+```
+     1  write todo documentation
+     2  do nothing
+     3  bake pie
+     4  MSG
+```
+
+## source repository
+todo's source can be found [here](https://git.tilde.institute/ensa/todo).
+
+[back](/)

pages/unixtips.md

@@ -11,7 +11,7 @@ them up on this shell. So here are some things I do on my local machine
 that work here:
 
 To get the shell to tell you when you have new mail, after command
-executions, add this to your `.profile` or your `.kshrc` files 
+executions, add this to your `.profile` or your `$ENV` files 
 (or other shell RC file) in your home directory.
 
 ```
@@ -20,10 +20,16 @@ export MAILCHECK=0
 
 And, if you want, you can have a persistent notification when
 you have un-incorporated mail, or more specifically, when your
-`/var/mail/<username>` isn't empty.
+`$MAIL` (`/var/mail/$USER` by default)` isn't empty.
 
 ```
-PS1="\$([-s /var/mail/`whoami` ] && echo '* ')$PS1"
+PS1="$(test -s $MAIL ] && echo '* ')$PS1"
+```
+
+For maildir try this:
+
+```
+PS1="$(test -n "$(ls -A $HOME/Maildir/new)" && echo '* ')$PS1"
 ```
 
 This works in `/bin/ksh`, I can't speak for other shells.

pages/user-repos.md

@@ -0,0 +1,161 @@
+<!--
+title: User git Repositories
+description: Getting set up with git.tilde.institute
+author: gbmor
+-->
+
+# User git Repositories
+
+There's now an instance of [cgit](https://git.zx2c4.com/cgit) available
+for all users to enjoy. Unlike the previous git repo hosting platform
+I used, this does not require an additional signup. It's available
+directly from your home directory. Tagged versions are automatically
+bundled into `.tar.gz` archives and listed on the summary page.
+
+All repos can be viewed at
+[https://git.tilde.institute](https://git.tilde.institute)
+
+**Note:** If a change doesn't appear in cgit immediately, wait a few
+minutes. The cache will time out.
+
+## Creating the directory
+
+New users will not have to do this step. A `~/public_repos` link will
+exist in your home directory. If you were a user before this was set up
+(2020 May 1), you will need to create a symlink in your home directory
+pointing into location in the httpd chroot where cgit will scan for
+your repos.
+
+There should be a directory corresponding to your username at the
+following location:
+
+```
+/var/www/cgit_repos/<USER>
+```
+
+Issue this command to create the symlink:
+
+```
+ln -s /var/www/cgit_repos/$USER ~/public_repos
+```
+
+## Adding a repository
+
+Once `~/public_repos` exists, `cd` into it and create a directory
+for your repo:
+
+```
+mkdir foo.git
+```
+
+Change into *that* directory and initialize a bare repo:
+
+```
+cd foo.git; git init --bare
+```
+
+Now that the bare repo has been created, we'll need to set some configuration
+options. You may use this command from within the directory you just created:
+
+```
+git config --local gitweb.owner "$USER <$USER@tilde.institute>"
+```
+
+Or, you may manually edit the file called `config` and append the following
+section:
+
+```
+[gitweb]
+    owner = user_name <user_name@tilde.institute>
+```
+
+Then, write out the text description of your repo into a file called
+`description`:
+
+```
+echo "My awesome repo!" > description
+```
+
+## Setting up the remote
+
+If pushing from your home computer, add the following remote, replacing
+`<USER>` with your username at tilde.institute, and `<REPO>` with
+the repo directory:
+
+```
+git remote add tilde.institute <USER>@tilde.institute:public_repos/<REPO>
+```
+
+If pushing from your home directory on tilde.institute, use this
+format:
+
+```
+git remote add tilde.institute /home/<USER>/public_repos/<REPO>
+```
+
+Now it's time to push to the repo you set up:
+
+```
+git push -u tilde.institute master
+```
+
+## Checking the repo on [git.tilde.institute](git.tilde.institute)
+
+Your repo should now be available at
+`https://git.tilde.institute/<USER>/<REPO>`, without the `.git`
+extension on the repo's directory.
+
+If something's wrong, double-check everything, and then jump into
+`#institute` on IRC.
+
+## What about pull requests?
+
+These don't exist. I suggest directing people to use [git
+send-email](https://git-send-email.io) for patches.
+
+## Namespacing projects
+
+cgit will use the directory structure to namespace projects, if you
+want to group related repositories.
+
+For example, say you have a project called `widget`, which comprises
+the two repos `libwidget` and `widget-cli`. One way to present
+this here would be to use the following directory structure in
+`~/public_repos`
+
+```
+~/public_repos/widget
+~/public_repos/widget/libwidget.git
+~/public_repos/widget/widget-cli.git
+```
+
+This will then show up in cgit as:
+
+```
+$USER
+  widget/libwidget
+  widget/widget-cli
+```
+
+When setting up the remote in your local copy of the repo, you would
+use this for the `libwidget` example:
+
+```
+git remote add tilde.institute <USER>@tilde.institute:public_repos/widget/libwidget.git
+```
+
+## Misc
+
+You can link to just your own repos via `https://git.tilde.institute/<USER>`
+
+The following files will be parsed into an `about` page for a given
+repo, in order:
+
+* `README`
+* `README.7`
+* `README.1`
+* `README.txt`
+* `README.md`
+
+[back](/)
+