[brand] docs - normalize project name to SearXNG

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

docs/dev/contribution_guide.rst

@@ -12,21 +12,21 @@ How to contribute
 Prime directives: Privacy, Hackability
 ======================================
 
-Searx has two prime directives, **privacy-by-design and hackability** .  The
+SearXNG has two prime directives, **privacy-by-design and hackability** .  The
 hackability comes in three levels:
 
 - support of search engines
 - plugins to alter search behaviour
-- hacking searx itself
+- hacking SearXNG itself
 
-Note the lack of "world domination" among the directives.  Searx has no
+Note the lack of "world domination" among the directives.  SearXNG has no
 intention of wide mass-adoption, rounded corners, etc.  The prime directive
 "privacy" deserves a separate chapter, as it's quite uncommon unfortunately.
 
 Privacy-by-design
 -----------------
 
-Searx was born out of the need for a **privacy-respecting** search tool which
+SearXNG was born out of the need for a **privacy-respecting** search tool which
 can be extended easily to maximize both, its search and its privacy protecting
 capabilities.
 
@@ -46,7 +46,7 @@ Submitting a bugreport to the vendor of the tool that misbehaves might be a good
 feedback to reconsider the disrespect to its customers (e.g. ``GET`` vs ``POST``
 requests in various browsers).
 
-Remember the other prime directive of searx is to be hackable, so if the above
+Remember the other prime directive of SearXNG is to be hackable, so if the above
 privacy concerns do not fancy you, simply fork it.
 
   *Happy hacking.*
@@ -99,7 +99,7 @@ In order to submit a patch, please follow the steps below:
 
 - Create a pull request.
 
-For more help on getting started with searx development, see :ref:`devquickstart`.
+For more help on getting started with SearXNG development, see :ref:`devquickstart`.
 
 
 Translation

docs/dev/engine_overview.rst

@@ -15,11 +15,11 @@ Engine Overview
    :depth: 3
    :backlinks: entry
 
-searx is a metasearch-engine_, so it uses different search engines to provide
+SearXNG is a metasearch-engine_, so it uses different search engines to provide
 better results.
 
 Because there is no general search API which could be used for every search
-engine, an adapter has to be built between searx and the external search
+engine, an adapter has to be built between SearXNG and the external search
 engines.  Adapters are stored under the folder :origin:`searx/engines`.
 
 .. _general engine configuration:
@@ -27,7 +27,7 @@ engines.  Adapters are stored under the folder :origin:`searx/engines`.
 General Engine Configuration
 ============================
 
-It is required to tell searx the type of results the engine provides. The
+It is required to tell SearXNG the type of results the engine provides. The
 arguments can be set in the engine file or in the settings file (normally
 ``settings.yml``). The arguments in the settings file override the ones in the
 engine file.
@@ -88,7 +88,7 @@ Overrides
 A few of the options have default values in the namespace of engine's python
 modul, but are often overwritten by the settings.  If ``None`` is assigned to an
 option in the engine file, it has to be redefined in the settings, otherwise
-searx will not start with that engine (global names with a leading underline can
+SearXNG will not start with that engine (global names with a leading underline can
 be ``None``).
 
 Here is an very simple example of the global names in the namespace of engine's

docs/dev/lxcdev.rst

@@ -52,7 +52,7 @@ software:
 and the script :ref:`lxc.sh`, with we can scale our installation, maintenance or
 even development tasks over a stack of isolated containers / what we call the:
 
-  **SearxNG LXC suite**
+  **SearXNG LXC suite**
 
 .. hint::
 
@@ -211,7 +211,7 @@ To debug services from filtron and morty analogous use:
         $ ./utils/filtron.sh inspect service
         $ ./utils/morty.sh inspect service
 
-Another point we have to notice is that each service (:ref:`searx <searx.sh>`,
+Another point we have to notice is that each service (:ref:`SearXNG <searx.sh>`,
 :ref:`filtron <filtron.sh>` and :ref:`morty <morty.sh>`) runs under dedicated
 system user account with the same name (compare :ref:`create searx user`).  To
 get a shell from theses accounts, simply call one of the scripts:
@@ -266,7 +266,7 @@ suite.  For this, we have to keep an eye on the :ref:`installation basic`:
 - virtualenv in: ``/usr/local/searx/searx-pyenv``
 - SearXNG software in: ``/usr/local/searx/searx-src``
 
-With the use of the :ref:`searx.sh` the searx service was installed as
+With the use of the :ref:`searx.sh` the SearXNG service was installed as
 :ref:`uWSGI application <searx uwsgi>`.  To maintain this service, we can use
 ``systemctl`` (compare :ref:`service architectures on distributions <uwsgi
 configuration>`).
@@ -280,7 +280,7 @@ configuration>`).
         $ sudo -H ./utils/lxc.sh cmd searx-archlinux \
           systemctl stop uwsgi@searx
 
-With the command above, we stopped the searx uWSGI-App in the archlinux
+With the command above, we stopped the SearXNG uWSGI-App in the archlinux
 container.
 
 The uWSGI-App for the archlinux dsitros is configured in
@@ -316,7 +316,7 @@ of the container:
           ln -s /share/searx/ /usr/local/searx/searx-src
 
 Now we can develop as usual in the working tree of our desktop system.  Every
-time the software was changed, you have to restart the searx service (in the
+time the software was changed, you have to restart the SearXNG service (in the
 conatiner):
 
 .. tabs::

docs/dev/makefile.rst

@@ -38,7 +38,7 @@ Python Environment (``make install``)
 
 We do no longer need to build up the virtualenv manually.  Jump into your git
 working tree and release a ``make install`` to get a virtualenv with a
-*developer install* of searx (:origin:`setup.py`). ::
+*developer install* of SearXNG (:origin:`setup.py`). ::
 
    $ cd ~/searx-clone
    $ make install
@@ -193,7 +193,7 @@ commit.
 .. _Pylint: https://www.pylint.org/
 
 Pylint_ is known as one of the best source-code, bug and quality checker for the
-Python programming language.  The pylint profile we use at searx project is
+Python programming language.  The pylint profile used in the SearXNG project is
 found in project's root folder :origin:`.pylintrc`.
 
 .. _make search.checker:

docs/dev/offline_engines.rst

@@ -11,7 +11,7 @@ Offline Engines
    - :ref:`engine command`
    - :origin:`Redis <searx/engines/redis_server.py>`
 
-To extend the functionality of SearxNG, offline engines are going to be
+To extend the functionality of SearXNG, offline engines are going to be
 introduced.  An offline engine is an engine which does not need Internet
 connection to perform a search and does not use HTTP to communicate.
 
@@ -47,14 +47,14 @@ Engine representation in ``/config``
 Extra Dependencies
 ==================
 
-If an offline engine depends on an external tool, SearxNG does not install it by
+If an offline engine depends on an external tool, SearXNG does not install it by
 default.  When an administrator configures such engine and starts the instance,
 the process returns an error with the list of missing dependencies.  Also,
 required dependencies will be added to the comment/description of the engine, so
 admins can install packages in advance.
 
 If there is a need to install additional packages in *Python's Virtual
-Environment* of your SearxNG instance you need to switch into the environment
+Environment* of your SearXNG instance you need to switch into the environment
 (:ref:`searx-src`) first, for this you can use :ref:`searx.sh`::
 
   $ sudo utils/searx.sh shell
@@ -66,7 +66,7 @@ Private engines (Security)
 
 To limit the access to offline engines, if an instance is available publicly,
 administrators can set token(s) for each of the :ref:`private engines`.  If a
-query contains a valid token, then SearxNG performs the requested private
+query contains a valid token, then SearXNG performs the requested private
 search.  If not, requests from an offline engines return errors.
 
 

docs/dev/quickstart.rst

@@ -6,7 +6,7 @@ Development Quickstart
 
 .. _npm: https://www.npmjs.com/
 
-Searx loves developers, just clone and start hacking.  All the rest is done for
+SearXNG loves developers, just clone and start hacking.  All the rest is done for
 you simply by using :ref:`make <makefile>`.
 
 .. code:: sh

docs/dev/reST.rst

@@ -6,10 +6,10 @@ reST primer
 
 .. sidebar:: KISS_ and readability_
 
-   Instead of defining more and more roles, we at searx encourage our
+   Instead of defining more and more roles, we at SearXNG encourage our
    contributors to follow principles like KISS_ and readability_.
 
-We at searx are using reStructuredText (aka reST_) markup for all kind of
+We at SearXNG are using reStructuredText (aka reST_) markup for all kind of
 documentation, with the builders from the Sphinx_ project a HTML output is
 generated and deployed at :docs:`github.io <.>`.  For build prerequisites read
 :ref:`docs build`.
@@ -78,7 +78,7 @@ User's POV: :origin:`docs/user`
 
 Admin's POV: :origin:`docs/admin`
   A typical Admin knows about setting up services on a linux system, but he does
-  not know all the pros and cons of a searx setup.
+  not know all the pros and cons of a SearXNG setup.
 
 Developer's POV: :origin:`docs/dev`
   Depending on the readability_ of code, a typical developer is able to read and
@@ -900,7 +900,7 @@ primer>`.
 
    .. sidebar:: KISS_ and readability_
 
-      Instead of defining more and more roles, we at searx encourage our
+      Instead of defining more and more roles, we at SearXNG encourage our
       contributors to follow principles like KISS_ and readability_.
 
 Generic admonition
@@ -1280,7 +1280,7 @@ Templating
 
 Templating is suitable for documentation which is created generic at the build
 time.  The sphinx-jinja_ extension evaluates jinja_ templates in the :ref:`make
-install` (with searx modules installed).  We use this e.g. to build chapter:
+install` (with SearXNG modules installed).  We use this e.g. to build chapter:
 :ref:`configured engines`.  Below the jinja directive from the
 :origin:`docs/admin/engines.rst` is shown:
 

docs/dev/search_api.rst

@@ -24,7 +24,7 @@ Parameters
 
 ``q`` : required
   The search query.  This string is passed to external search services.  Thus,
-  searx supports syntax of each search service.  For example, ``site:github.com
+  SearXNG supports syntax of each search service.  For example, ``site:github.com
   searx`` is a valid query for Google.  However, if simply the query above is
   passed to any search engine which does not filter its results based on this
   syntax, you might not get the results you wanted.