Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Split command reference #884

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 32 additions & 0 deletions Documentation/CommandReference/BackendCreateadmin.rst
@@ -0,0 +1,32 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-backend-createadmin:

The following reference was automatically generated from code.


===================
backend:createadmin
===================


**Create admin backend user**

Create a new user with administrative access.

Arguments
~~~~~~~~~

`username`
Username of the user
`password`
Password of the user






42 changes: 42 additions & 0 deletions Documentation/CommandReference/BackendLock.rst
@@ -0,0 +1,42 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-backend-lock:

The following reference was automatically generated from code.


============
backend:lock
============


**Lock backend**

Deny backend access for **every** user (including admins).



Options
~~~~~~~

`--redirect-url`
URL to redirect to when the backend is accessed

- Accept value: yes
- Is value required: yes
- Is multiple: no





Related commands
~~~~~~~~~~~~~~~~

`backend:unlock`
Unlock backend


31 changes: 31 additions & 0 deletions Documentation/CommandReference/BackendLockforeditors.rst
@@ -0,0 +1,31 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-backend-lockforeditors:

The following reference was automatically generated from code.


======================
backend:lockforeditors
======================


**Lock backend for editors**

Deny backend access, but only for editors.
Admins will still be able to log in and work with the backend.





Related commands
~~~~~~~~~~~~~~~~

`backend:unlockforeditors`
Unlock backend for editors


30 changes: 30 additions & 0 deletions Documentation/CommandReference/BackendUnlock.rst
@@ -0,0 +1,30 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-backend-unlock:

The following reference was automatically generated from code.


==============
backend:unlock
==============


**Unlock backend**

Allow backend access again (e.g. after having been locked with backend:lock command).





Related commands
~~~~~~~~~~~~~~~~

`backend:lock`
Lock backend


30 changes: 30 additions & 0 deletions Documentation/CommandReference/BackendUnlockforeditors.rst
@@ -0,0 +1,30 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-backend-unlockforeditors:

The following reference was automatically generated from code.


========================
backend:unlockforeditors
========================


**Unlock backend for editors**

Allow backend access for editors again (e.g. after having been locked with backend:lockforeditors command).





Related commands
~~~~~~~~~~~~~~~~

`backend:lockforeditors`
Lock backend for editors


36 changes: 36 additions & 0 deletions Documentation/CommandReference/CacheFlush.rst
@@ -0,0 +1,36 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-cache-flush:

The following reference was automatically generated from code.


===========
cache:flush
===========


**Flush all caches**

Flushes TYPO3 core caches first and after that, flushes caches from extensions.



Options
~~~~~~~

`--files-only`
Only file caches are flushed

- Accept value: no
- Is value required: no
- Is multiple: no
- Default: false





37 changes: 37 additions & 0 deletions Documentation/CommandReference/CacheFlushgroups.rst
@@ -0,0 +1,37 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-cache-flushgroups:

The following reference was automatically generated from code.


=================
cache:flushgroups
=================


**Flush all caches in specified groups**

Flushes all caches in specified groups.
Valid group names are by default:

- lowlevel
- pages
- system

**Example:** `typo3cms cache:flushgroups pages,all`

Arguments
~~~~~~~~~

`groups`
An array of names (specified as comma separated values) of cache groups to flush






44 changes: 44 additions & 0 deletions Documentation/CommandReference/CacheFlushtags.rst
@@ -0,0 +1,44 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-cache-flushtags:

The following reference was automatically generated from code.


===============
cache:flushtags
===============


**Flush cache by tags**

Flushes caches by tags, optionally only caches in specified groups.

**Example:** `typo3cms cache:flushtags news_123 --groups pages,all`

Arguments
~~~~~~~~~

`tags`
Array of tags (specified as comma separated values) to flush.



Options
~~~~~~~

`--groups`
Optional array of groups (specified as comma separated values) for which to flush tags. If no group is specified, caches of all groups are flushed.

- Accept value: yes
- Is value required: yes
- Is multiple: no






24 changes: 24 additions & 0 deletions Documentation/CommandReference/CacheListgroups.rst
@@ -0,0 +1,24 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-cache-listgroups:

The following reference was automatically generated from code.


================
cache:listgroups
================


**List cache groups**

Lists all registered cache groups.






46 changes: 46 additions & 0 deletions Documentation/CommandReference/CleanupUpdatereferenceindex.rst
@@ -0,0 +1,46 @@

.. include:: ../Includes.txt



.. _typo3_console-command-reference-cleanup-updatereferenceindex:

The following reference was automatically generated from code.


============================
cleanup:updatereferenceindex
============================


**Update reference index**

Updates reference index to ensure data integrity

**Example:** `typo3cms cleanup:updatereferenceindex --dry-run --verbose`



Options
~~~~~~~

`--dry-run`
If set, index is only checked without performing any action

- Accept value: no
- Is value required: no
- Is multiple: no
- Default: false

`--show-progress`
Whether or not to output a progress bar

- Accept value: no
- Is value required: no
- Is multiple: no
- Default: false