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

Review Capitalization #553

Merged
merged 1 commit into from
Jul 24, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ duck --download protocol:/<file> <folder>/
duck --download protocol:/<file> <folder>/<name>
```

#### Glob pattern support for selecting files to transfer
#### Glob Pattern Support for Selecting Files to Transfer

You can transfer multiple files with a single command using a glob pattern for filename inclusion such as
```{code-block}
Expand Down Expand Up @@ -309,14 +309,14 @@ If your shell supports glob expansion you can use a wildcard pattern to select f
duck --upload protocol://<hostname>/directory/ ~/*.jpg
```

### Synchronize folders with `--synchronize`
### Synchronize Folders with `--synchronize`

* Synchronize directory `<name>` with directory `folder` on disk using
```{code-block}
duck --synchronize protocol:/<name>/ folder/
```

#### Custom configuration options for uploads to S3
#### Custom Configuration Options for Uploads to S3

Add default metadata for uploads using the [preferences option to read from the environment](#preferences). The property is documented in [Default metadata](../protocols/s3/index.md#default-metadata).

Expand Down
4 changes: 2 additions & 2 deletions cyberduck/bookmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,15 +209,15 @@ You are asked if you want to import bookmarks from the following list of applica
:width: 600px
```

## Sharing Bookmarks between Different Computers
## Sharing Bookmarks Between Different Computers

You can share bookmarks between different computers and users by uploading the *Bookmarks* and *Profiles* folder to a Cloud Storage of your liking and creating a symbolic link to it.

```{warning}
This only works properly while using the standalone version of Cyberduck or Mountain Duck. The App Store version is unable to list the existing bookmarks from the symbolic link.
```

**Step by step instructions using Dropbox as an example:**</br>
**Step by Step Instructions Using Dropbox as an Example:**</br>
`````{tabs}
````{group-tab} macOS

Expand Down
2 changes: 1 addition & 1 deletion cyberduck/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Enable tabs by default when choosing *File → New Browser (`⌘N`)* by selectin

```

### Spring-loaded Folders
### Spring-Loaded Folders

Spring-loaded folders are a feature that allows you to move a file or even another folder, into a folder deeply nested within several other folders using drag and drop. To enable, choose *Preferences → Browser → Use spring-loaded folders when dragging files* and adjust the delay for the folder to expand when hovering over with the mouse. Note that spring-loaded folders are only supported in the outline view.

Expand Down
2 changes: 1 addition & 1 deletion cyberduck/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Search for and save password for connections.

You might need to adjust the timeout to wait for an answer from the server. The default is set to `30` seconds.

#### Repeat failed networking tasks
#### Repeat Failed Networking Tasks

Failed transfers due to network connection issues such as a low latency can be chosen to be repeated with a configurable number of retries.

Expand Down
4 changes: 2 additions & 2 deletions cyberduck/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ A [hidden configuration option](preferences.md#hidden-configuration-options).

defaults write ch.sudo.cyberduck editor.upload.temporary false

### Exclude files from versioning
### Exclude Files from Versioning

Files can be excluded from versioning by using a [hidden configuration option](preferences.md#hidden-configuration-options).

versioning.include.regex=.*

### Number of saved versions
### Number of Saved Versions

Per default, the number of saved versions is limited to 5. The oldest version will be deleted once a new version is uploaded exceeding the limit.

Expand Down
8 changes: 4 additions & 4 deletions cyberduck/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Cyberduck is free software. Free software is a matter of the users' freedom to r
:width: 600px
```

#### What payment options are available?
#### What Payment Options are Available?

Donations can be made by using PayPal or Credit card. Alternatively, you can purchase Cyberduck via App Store.

Expand Down Expand Up @@ -56,11 +56,11 @@ If these steps are not resolving the trial expired message please follow these a
3. Paste it into the window
4. Run it and wait for completion.

### What are the System requirements for Cyberduck?
### What are the System Requirements for Cyberduck?

The system requirements are listed in the [installation section](installation.md#system-requirements).

#### Can I install older version if necessary?
#### Can I Install Older Version if Necessary?

The recent release can be found on our [website](https://cyberduck.io/download/). In case your operating system requires an older version of Cyberduck you can download installers for previous versions in our [changelog](https://cyberduck.io/changelog/).

Expand Down Expand Up @@ -113,7 +113,7 @@ Preferences are stored in `%AppData%\Cyberduck\cyberduck.user.config`. Please no
````
`````

## Where can I issue Bug Reports and Feature Requests?
## Where can I Issue Bug Reports and Feature Requests?

To get help with bugs, feature requests, or other issues please refer to the [support page](support.md).

Expand Down
2 changes: 1 addition & 1 deletion cyberduck/preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Select the text editor you want to use a as default application to open with if

Select connection profiles to be installed. Either scroll through the list or use the search function to look for a specific profile. The connection profiles will be installed after ticking the corresponding checkboxes. Installed protocols are displayed in the protocol dropdown menu in the bookmark window. To disable the connection profile simply untick the checkbox.

## Protocol specifics
## Protocol Specifics

Manage protocol specific settings.

Expand Down
2 changes: 1 addition & 1 deletion cyberduck/spotlight.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Spotlight (macOS)
====

## Search bookmarks with Spotlight
## Search Bookmarks with Spotlight

Cyberduck includes a custom *Spotlight Importer Plugin* to search the contents of its bookmarks files.

Expand Down
6 changes: 3 additions & 3 deletions cyberduck/transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Some servers may not support resumable transfers and the file will be reloaded i

You can interrupt a transfer using the *Stop* toolbar button.

## Open downloaded files
## Open Downloaded Files

Use the *Open* toolbar button to open a downloaded file or folder.

Expand Down Expand Up @@ -156,11 +156,11 @@ Skip transfer of files that already exist.

## Preferences

### Browser connection for file transfers
### Browser Connection for File Transfers

If your server only allows one single connection to be opened for a given user, you'll have to transfer files using the browser connection. This will cause you to stop browsing files and folders while the transfer is in progress. You can choose to *Use the browser connection* or to a *Open a new connection* for file transfers in the [bookmark](bookmarks.md#edit-bookmark) setting. The default setting is configurable in the *Transfers* tab of [Preferences](preferences.md).

### Download/Upload setting for Existing Files
### Download/Upload Setting for Existing Files

- **Prompt:** Asks what action to take for each transfer.
- **Overwrite:** Overwrite existing files at the destination.
Expand Down
2 changes: 1 addition & 1 deletion mountainduck/connect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ In _Smart Synchronization_ connect mode, files are copied to a local cache for f
| **[Lock Files](../locking.md)** | ✔︎ | ✔ |
| **[Share Files](../share.md)** | ✔ | ✔ |

## Quota support
## Quota Support
Mountain Duck displays the overall quota present on the server as available disk space on the mounted volume.

| Protocol | Support |
Expand Down
2 changes: 1 addition & 1 deletion mountainduck/connect/online.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The file can only be opened when a connection to the server or cloud storage can
The file or folder is only saved in a local [temporary](../issues/index.md#temporary-files) location and not uploaded. This includes files matching a [temporary filename pattern](../issues/index.md#filenames), empty files and new folders.


## Transfer progress
## Transfer Progress

While transferring files and folders, a transfer [progress](../interface.md#copying-files) window shows in _Finder.app_ or _Windows Explorer_. When completed, the file(s) have been uploaded to the server.

Expand Down
9 changes: 4 additions & 5 deletions mountainduck/connect/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@

## Notifications


```{image} ../_images/File_Updated_Notification.png
:alt: File Updated Notification
:width: 500px
Expand Down Expand Up @@ -132,7 +131,7 @@
The cache size can be limited per bookmark within the *Preferences → Sync* tab. Also files not accessed within a chosen period of time can be purged. Refer to [Cache Limitations](../preferences.md#cache-limitations). The cache contains obfuscated file contents on local disk to make files available when offline.


## Transfer progress
## Transfer Progress

While transferring files and folders, a transfer [progress](../interface.md#copying-files) window shows in _Finder.app_ or _Windows Explorer_. When completed, the file(s) are queued for synchronization with the server.

Expand Down Expand Up @@ -167,13 +166,13 @@
When synchronization is paused by selecting _Pause Sync_ in the menu or caused by a connectivity problem, no changes from the server will be detected. Additionally, files marked as [Online Only](#online-only) cannot be opened: The application attempting to open the file will show an error message and a *Access Denied* notification is shown.
```

### Cancel upload in progress
### Cancel Upload in Progress
To abort the upload of a file, follow these steps:
1. Choose *Pause Synchronization* in the Mountain Duck _Synchronization_ menu.
2. Delete the file
3. *Resume Synchronization* in the dropdown menu.

### Cancel download in progress
### Cancel Download in Progress
To abort the download of a file, follow these steps:
1. Choose *Pause Synchronization* in the Mountain Duck _Synchronization_ menu.
2. Select *Delete on local Disk* within the Mountain Duck [context menu](../interface.md#context-menu-in-finder-and-windows-file-explorer).
Expand All @@ -186,19 +185,19 @@
:width: 600px
```

#### ![Delete](../_images/delete.png) Delete

Check warning on line 188 in mountainduck/connect/sync.md

View workflow job for this annotation

GitHub Actions / build

Non-consecutive header level increase; H2 to H4 [myst.header]
A file or folder has been deleted either *by you* or *on the server*

#### ![Create](../_images/plus.png) Create

Check warning on line 191 in mountainduck/connect/sync.md

View workflow job for this annotation

GitHub Actions / build

Non-consecutive header level increase; H2 to H4 [myst.header]
A file or folder was created or updated *on the server*.

#### ![Upload](../_images/transfer_upload.png) Upload

Check warning on line 194 in mountainduck/connect/sync.md

View workflow job for this annotation

GitHub Actions / build

Non-consecutive header level increase; H2 to H4 [myst.header]
A file or folder was added or changed *by you* and uploaded to the server.

#### ![Download](../_images/transfer_download.png) Download

Check warning on line 197 in mountainduck/connect/sync.md

View workflow job for this annotation

GitHub Actions / build

Non-consecutive header level increase; H2 to H4 [myst.header]
A file is downloaded to the local cache to be available for offline use. This state also occurs if a file that is marked as *Keep offline* has updated on the server.

#### ![Error](../_images/alert.png) Error

Check warning on line 200 in mountainduck/connect/sync.md

View workflow job for this annotation

GitHub Actions / build

Non-consecutive header level increase; H2 to H4 [myst.header]
The sync operation failed for the file. A file may show up with an error state indicating an issue while synchronizing. Further details are available through the [sync option menu item](../interface.md#context-menu-in-finder-and-windows-file-explorer).

### Application Display
Expand All @@ -208,7 +207,7 @@

The application that was used for editing the file is displayed within the *Recent Files* area.
```
### Reveal file
### Reveal File
Selecting an item in the *Recent Files* section reveals the file in the _Finder_ (macOS) of _File Explorer_ (Windows).

### Clear Menu
Expand Down
26 changes: 13 additions & 13 deletions mountainduck/installation/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Mountain Duck is licensed on a per-seat basis. Each license is valid for one use

Licenses are registered to the email address in use while purchasing. Buying more than one seat using the same email address, you will receive a single multi-user license file meant to be used for all users.

## Trial licenses
## Trial Licenses

Downloading the [trial version](https://mountainduck.io/) of Mountain Duck, a license popup will open. Select `Request Trial` to download a 14-days trial license.

Expand All @@ -20,38 +20,38 @@ Please reach out to [Mountain Duck support](mailto:[email protected]) for

## FAQ

### How many licenses do I need?
### How Many Licenses do I Need?

Mountain Duck is licensed on a per-seat basis. You have to buy a license for everyone who wants to use the software. One
license can be used on any number of computers as long as it is the same user accessing the software.

### Can I use the same license for the macOS and Windows version?
### Can I use the Same License for the macOS and Windows Version?

Yes, the same registration key file can be used on both platforms.

### Can I use my single-user license at work and at home?
### Can I use my Single-User License at Work and at Home?

Yes, but you cannot share it with your co-workers.

### Can I use my single-user license on multiple machines?
### Can I use my Single-User License on Multiple Machines?

Yes, you may install Mountain Duck on multiple computers as long as it's exclusively used by yourself.

### We are a company with multiple users. Do you offer a site license?
### We are a Company with Multiple Users. Do you Offer a Site License?

You need a multi-user license for the number of employees using Mountain Duck.

### Do you provide discounts for students and educational programs?
### Do you Provide Discounts for Students and Educational Programs?

Yes, we offer a 30% discount for college/university students, staff and faculty at all grade levels. Use your academic email address and drop us a line at [[email protected]](mailto:[email protected]) to get your discount coupon.

Please note that for academic labs with non-personal computers a per device licensing model applies.

### How does the licensing work in a Terminal Services environment?
### How Does the Licensing Work in a Terminal Services Environment?

You need a license for each user who needs access to Mountain Duck through Remote Desktop Protocol (RDP) e.g. on Windows Server 2008 R2.

### How to install the registration key for a multi-user license?
### How to Install the Registration Key for a Multi-User License?

You purchase multiple licenses contained in a single registration key to be installed on multiple computers. Double
click the registration key file to register your license. In case you make use of a software management system on
Expand All @@ -62,7 +62,7 @@ copying alongside the application.
You always receive a single registration key containing all purchased licenses for multi-user deployments.
```

### Is the registration key valid for future version?
### Is the Registration Key Valid for Future Version?

The license is valid for one specific major version. For future major versions, we provide upgrade discounts depending on the date of purchase.

Expand All @@ -72,7 +72,7 @@ To use the version from the Mac App Store after testing the application, you hav

## Known Issues

### No license file received
### No License File Received

You won't receive a license file after purchasing via AppStore because the application is registered to the store account in use while purchasing.

Expand All @@ -81,7 +81,7 @@ Additional reasons for a missing license file can be:
- The license file will be sent to the registered email. Typos can misslead the email.
- Check the spam folder of your email application.

### Not a valid registration key
### Not a Valid Registration Key

Your license file is valid for an older version of Mountain Duck. Please upgrade your license file to use the latest version of the application or revert to an older version.

Expand All @@ -91,6 +91,6 @@ An additional reason might be, that your email application changed the license f
- Forward the mail to a different mail account where you possibly don’t have an issue downloading attachments.
- Change the file extension of the license file back to `.mountainducklicense`.

### Recover license files
### Recover License Files

Registration keys can be [recovered](https://mountainduck.io/help/) using the email address you registered while purchasing.
2 changes: 1 addition & 1 deletion mountainduck/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If Mountain Duck is newly installed on a Windows 11 system, the tray icon must b

`````

### Auto start
### Auto Start

You can choose to automatically open Mountain Duck when logging in. Refer to [Preferences](preferences.md#login-item). Re-opening the application will open previously mounted volumes. If you choose *Enable Login Item* and *Save Workspace* in *Preferences → General* and do not manually eject the volume prior to reboot it will reconnect after login.

Expand Down
2 changes: 1 addition & 1 deletion mountainduck/issues/fastcgi.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Most clients out there, including web browsers, use the former method and thus d

In step 3 [Mountain Duck](https://mountainduck.io/) opens a connection to the remote server, send a `PUT` request with the HTTP header `Transfer-Encoding: chunked` and streams through all subsequent write callbacks. Finally, in step 6, the connection is closed.

### Related bug Reports
### Related Bug Reports

Since the expected length is missing in the header the streaming characteristic of such requests makes them more difficult to be handled in the components being passed. From our research the issue only exists in environments that use Fast CGI to speak to their PHP application. See related bug reports

Expand Down
8 changes: 4 additions & 4 deletions mountainduck/issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ As a workaround uncheck *edit → Preferences... → Security (Enhanced) → Ena

If your server does not accept the creation of `.` temporary files you might need to add the `--inplace` when running `rsync`.

### High CPU usage when working with Sublime Text
### High CPU Usage when Working with Sublime Text

- When working with Sublime Text we recommend turning off indexing by adding the following setting to your user preferences in Sublime Text. <br/>
`"index_files": false`
Expand Down Expand Up @@ -216,13 +216,13 @@ You can find this well documented by Microsoft at [Sync icon overlays are missin
`````{tabs}
````{group-tab} macOS

**Missing status bar icon**<br/>
**Missing Status Bar Icon**<br/>
Using applications customizing the status menus may lead to a missing status icon of Mountain Duck. This has been reported for the following applications:
- _xbar_
- _MenuMeters_
- _IP in menubar_

**Mount is not Visible within the Media Browser (Adobe Premiere)**<br/>
**Mount is not Visible Within the Media Browser (Adobe Premiere)**<br/>
Bookmarks mounted by Mountain Duck aren't visible within the *Media Browser* of Adobe Premiere. The mount location needs to be [changed](../preferences.md#mount-location) (e.g. to the desktop) to make the mount visible.

**Finder.app Does not Show Files Prefixed with `.` on Remote Volumes**<br/>
Expand Down Expand Up @@ -297,7 +297,7 @@ See Windows sessions above. It is not possible to run Mountain Duck as a Service
**Mountain Duck Tooltip Persists on Screen**<br/>
You can close that overlay by holding your mouse cursor for about 3 seconds on the Mountain Duck icon within the Tray area.

**Dot files are not hidden**<br/>
**Dot Files are not Hidden**<br/>
By default, files starting with `.` aren't hidden by Windows Explorer. You can change the default by using a [hidden configuration option](../preferences.md#hidden-configuration-options).

browser.hidden.regex=\\..*
Expand Down
2 changes: 1 addition & 1 deletion mountainduck/preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Volumes are mounted in the *Volumes* folder in the [application support director

**Note:** You **cannot** set it to `/Volumes` on macOS Mojave (10.14 or later) where the directory is not writable. The setting is not available in the version from the Mac App Store. The default is set to `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/Volumes.noindex`.

#### Show volumes on Desktop
#### Show Volumes on Desktop

`````{tabs}
````{group-tab} macOS
Expand Down
2 changes: 1 addition & 1 deletion protocols/dracoon.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Open a [free account](https://www.dracoon.com/en/free) with 10 users including 1
The DRACOON (OAuth) connection profile is bundled by default with Cyberduck.
```

### Authentication with username and password
### Authentication With Username and Password

To authenticate with your username and password, use the _DRACOON (OAuth Password Flow)_ profile. Instead of retrieving an authentication code by logging in using a web browser, the profile uses the OAuth password flow to authenticate. This is most useful when working with [Cyberduck CLI](https://duck.sh/).

Expand Down
4 changes: 2 additions & 2 deletions protocols/dropbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Password protected share links are only available for [paid business plans](http

## Known Limitations

### Comparison with Dropbox desktop app
### Comparison With Dropbox Desktop App

The Dropbox desktop app has the following advantages to improve upload performance not available through the public API.
- Server side caching to skip transferring previously uploaded files ([#247](https://github.com/iterate-ch/docs/issues/247)).
Expand All @@ -85,7 +85,7 @@ Downloads may fail with a `409 Conflict (restricted_content)` error reply for fi
The file cannot be transferred because the content is restricted. For example, sometimes there are legal restrictions due to copyright claims.
```

### Will not save the file or folder because of its name.
### Will not Save the File or Folder Because of its Name.

Uploads may fail with a `409 (disallowed_name)` error reply for files with certain characters in the filename.

Loading
Loading