Torrific W3M

Enables clear-net browsing over the Tor network via W3M web browser

---

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

• 🧰 Usage

• 🗒 Notes

• 📈 Contributing

  • 🔱 Forking
  • 💱 Sponsor

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

This repository makes use of Git Submodules to track dependencies, to avoid incomplete downloads clone with the --recurse-submodules option...

git clone --recurse-submodules git@github.com:paranoid-linux/torrific-w3m.git

To update tracked Git Submodules issue the following commands...

git pull

git submodule update --init --merge --recursive

To force upgrade of Git Submodules...

git submodule update --init --merge --recursive --remote

Note, forcing and update of Git Submodule tracked dependencies may cause instabilities and/or merge conflicts; if however everything operates as expected after an update please consider submitting a Pull Request.

---

Quick Start

Make a directory for Git projects and change current working directory...

mkdir -p ~/git/hub/paranoid-linux

cd ~/git/hub/paranoid-linux

Clone this repository and Submodule dependencies...

git clone --recurse-submodules git@github.com:paranoid-linux/torrific-w3m.git

Change current working directory and run update-configs.sh script...

cd ~/git/hub/paranoid-linux/torrific-w3m

sudo ./update-configs.sh

Run linked-install.sh script...

./linked-install.sh

---

Usage

After installation use the torrific-w3m command to launch terminal based web browser...

torrific-w3m --help

Example of emidiatly opening URL...

torrific-w3m 'https://check.torproject.org/'

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

---

Contributing

Options for contributing to torrific-w3m and paranoid-linux

---

Forking

Start making a [Fork][tick_tracker__fork_it] of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is git@github.com:<NAME>/<REPO>.git...

cd ~/git/hub/paranoid-linux/torrific-w3m

git remote add fork git@github.com:<NAME>/torrific-w3m.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/paranoid-linux/torrific-w3m


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

With you may sponsor paranoid-linux on a repeating basis.

Regardless of if you're able to financially support projects such as torrific-w3m that paranoid-linux maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• GitHub -- github-utilities/make-readme

• CloudFlare -- Introducing DNS Resolver for Tor

• Qubes OS -- Reducing the fingerprint of text-based web browser W3M

• Qubes OS -- Onion -- Reducing the fingerprint of text-based web browser W3M

• How to Geed -- How to browse from the Linux terminal with W3M

---

License

Enables clear-net browsing over the Tor network via W3M web browser
Copyright (C) 2020 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.